RC feature

command message olympe.messages.rc.abort_calibration(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.abort_calibration

Abort current calibration.

Parameters:

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.abort_calibration

event message olympe.messages.rc.calibration_state(calibration_type=None, channel_action=None, required=None, calibrated=None, neutral_calibrated=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.calibration_state

RC Channels calibration state sent by drone.

Parameters:

calibration_typeolympe.enums.rc.calibration_type

Current calibration type set to ‘none’ if no calibration in progress.

channel_actionolympe.enums.rc.channel_action

Current channel action calibration Only used when calibration_type=min_max.

requiredBitfieldOf(olympe.enums.rc.channel_action, u32)

bitfield of required channel actions. Neutral channels calibration is always required.

calibratedBitfieldOf(olympe.enums.rc.channel_action, u32)

bitfield of calibrated channel actions.

neutral_calibratedu8

1 if neutral channels are calibrated, 0 otherwise.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.calibration_state

event message olympe.messages.rc.channel_action_item(action=None, supported_type=None, calibrated_type=None, inverted=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.channel_action_item

Channel action supported by drone.

Parameters:

actionolympe.enums.rc.channel_action

Channel action.

supported_typeBitfieldOf(olympe.enums.rc.channel_type, u32)

Bitfield of supported channel types.

calibrated_typeolympe.enums.rc.channel_type

Calibrated action channel type (none if not calibrated).

invertedu8

1 if inverted, 0 otherwise.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.channel_action_item

event message olympe.messages.rc.channel_value(id=None, action=None, value=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.channel_value

RC Channel value sent by drone

Parameters:

idu8

RC channel id.

actionolympe.enums.rc.channel_action

RC channel action.

valuei16

RC channel value.

list_flagsBitfieldOf(olympe.enums.rc.list_flags, u8)

Item attribute Bitfield. First: indicate it’s the first element of the list. Last: indicate it’s the last element of the list.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.channel_value

event message olympe.messages.rc.channels_monitor_state(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.channels_monitor_state

RC Channel monitor state sent by drone

Parameters:

stateu8

1 if enabled, 0 if disabled

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.channels_monitor_state

command message olympe.messages.rc.enable_receiver(enable, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.enable_receiver

Enable or disable RC receiver. If enable, drone will apply values sent by RC receiver.

Parameters:

enableu8

1 for enable / 0 to disable

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.enable_receiver

command message olympe.messages.rc.invert_channel(action, flag, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.invert_channel

Invert a RC channel values

Parameters:

actionolympe.enums.rc.channel_action

Channel action.

flagu8

1 to invert channel 0 to restore channel.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.invert_channel

command message olympe.messages.rc.monitor_channels(enable, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.monitor_channels

Enable or Disable RC channels monitoring. If enable, drone will send periodically rc channel value events.

Parameters:

enableu8

1 for enable / 0 to disable

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.monitor_channels

event message olympe.messages.rc.receiver_state(state=None, protocol=None, enabled=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.receiver_state

State of drone RC receiver

Parameters:

stateolympe.enums.rc.receiver_state

current state.

protocolstring

Protocol used by RC.

enabledu8

1 if enabled, 0 otherwise. If enabled, drone will apply values sent by RC receiver.

_policyolympe.messaging.arsdk_expectations.ExpectPolicy

specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.receiver_state

command message olympe.messages.rc.reset_calibration(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.reset_calibration

Reset calibration to default values.

Parameters:

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.reset_calibration

command message olympe.messages.rc.start_calibration(calibration_type, channel_action, channel_type, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

rc.start_calibration

Start a calibration.

Parameters:

calibration_typeolympe.enums.rc.calibration_type

Type of calibration.

channel_actionolympe.enums.rc.channel_action

Channel action. only used when calibration_type=min_max.

channel_typeolympe.enums.rc.channel_type

Channel type. only used when calibration_type=min_max.

_timeoutint

command message timeout (defaults to 10)

_no_expectbool

if True, do not expect the usual command expectation (defaults to False)

_float_toltuple

specify the float comparison tolerance, a 2-tuple containing a relative tolerance float value and an absolute tolerate float value (default to (1e-07, 1e-09)). See python 3 stdlib math.isclose documentation for more information

_matching_modeolympe.MatchingMode

specify the expectation matching mode (default to olympe.MatchingMode.pattern)

_int_tolint

specify the int comparison tolerance, an int containing an absolute tolerate int value (default to 0)

Unsupported message

Todo

Remove unsupported message rc.start_calibration

enum olympe.enums.rc.calibration_type

Calibration type.

none:

No calibration. (0)

neutral:

All neutral channels calibration. (1)

min_max:

Min/Max specific channel calibration. (2)

enum olympe.enums.rc.channel_action

Channel action.

invalid:

Invalid/Unused channel. (0)

roll:

Roll axis channel. (1)

pitch:

Pitch axis channel. (2)

yaw:

Yaw axis channel. (3)

gaz:

Gaz / Throttle / Altitude axis channel. (4)

takeoff_land:

Takeoff / Land channel. (5)

emergency:

Emergency channel. (6)

return_home:

Return Home channel. (7)

piloting_mode:

RC Piloting mode. Auto mode: used for doing flightplans and for assisted flying with a non-RC controller. Easy manual mode: used for assisted flying with a RC controller. Manual mode: used for non-assisted flying with a RC controller and for directly controlling the servomotors. (8)

take_control:

RC take control. When take control is activated the RC controller, if available, becomes the main controller. (9)

enum olympe.enums.rc.channel_type

Channel physical type.

invalid:

Invalid channel physical type. (0)

signed_axis:

Signed axis type. (1)

unsigned_axis:

Unsigned axis type. (2)

monostable_button:

Monostable button type. (3)

bistable_button:

Bistable button type. (4)

tristate_button:

Tristate button type. (5)

rotary_button:

Rotary button type. (6)

enum olympe.enums.rc.list_flags

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages

First:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (0)

Last:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (1)

Empty:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (2)

Remove:

Arsdk built-in “list_flags” enum that is used to in “LIST_ITEM” event messages (3)

enum olympe.enums.rc.receiver_state

RC Receiver state.

Enum aliases:

connected:

RC drone receiver connected to a RC. (0)

disconnected:

RC drone receiver not connected to a RC. (1)