Mapper Mini feature

event message olympe.messages.mapper_mini.axis_mapping_item(uid=None, modes=None, action=None, axis=None, buttons=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

mapper_mini.axis_mapping_item

The resulting map describes all active axis mappings of the product. A mapping can affect one or mode modes, but each action can only be mapped once per mode.

Parameters:

uidu16

Unique ID of the mapping.

modesBitfieldOf(olympe.enums.mapper_mini.mode, u8)

The modes on which the mapping is set

action : olympe.enums.mapper_mini.axis_action

axisi8

The axis number on which the action is mapped.

buttonsu32

Buttons combination mapped to the action (bitfield).

list_flags : BitfieldOf(olympe.enums.mapper_mini.list_flags, u8)

_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 mapper_mini.axis_mapping_item

Triggered: by a map_button_action() or a map_axis_action() command

event message olympe.messages.mapper_mini.button_mapping_item(uid=None, modes=None, action=None, buttons=None, list_flags=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)

mapper_mini.button_mapping_item

The resulting map describes all active button mappings of the product. A mapping can affect one or mode modes, but each action can only be mapped once per mode.

Parameters:

uidu16

Unique ID of the mapping.

modesBitfieldOf(olympe.enums.mapper_mini.mode, u8)

The modes on which the mapping is set

action : olympe.enums.mapper_mini.button_action

buttonsu32

Buttons combination mapped to the action (bitfield).

list_flags : BitfieldOf(olympe.enums.mapper_mini.list_flags, u8)

_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 mapper_mini.button_mapping_item

Triggered: by a map_button_action() or a map_axis_action() command

command message olympe.messages.mapper_mini.map_axis_action(modes, action, axis, buttons, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mapper_mini.map_axis_action

An action can only be mapped to one axis/button set. Each action can be mapped to different axes/buttons for different modes.

Parameters:

modesBitfieldOf(olympe.enums.mapper_mini.mode, u8)

The modes on which the mapping will be set

action : olympe.enums.mapper_mini.axis_action

axisi8

The axis number on which the action will be mapped. Set a negative value to unmap the action.

buttonsu32

Buttons combination mapped to the action (bitfield). Can be zero if no buttons are required.

_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 mapper_mini.map_axis_action

Result: The drone will send button_mapping_item() and axis_mapping_item() according to the request.

command message olympe.messages.mapper_mini.map_button_action(modes, action, buttons, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)

mapper_mini.map_button_action

An action can only be mapped to one button set. Each action can be mapped to different buttons for different modes.

Parameters:

modesBitfieldOf(olympe.enums.mapper_mini.mode, u8)

The modes on which the mapping will be set

action : olympe.enums.mapper_mini.button_action

buttonsu32

Buttons combination mapped to the action (bitfield). Set 0 (no button) to unmap an action

_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 mapper_mini.map_button_action

Result: The drone will send button_mapping_item() and axis_mapping_item() according to the request.

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

mapper_mini.reset_mapping

Resets the mappings for the given mode(s) to their default value.

Parameters:

modesBitfieldOf(olympe.enums.mapper_mini.mode, u8)

The mode(s) to reset.

_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 mapper_mini.reset_mapping

Result: The drone will send button_mapping_item() and axis_mapping_item() according to the request.

enum olympe.enums.mapper_mini.axis_action

The action (mapped on an axis)

roll:

roll (0)

pitch:

pitch (1)

yaw:

yaw (2)

gaz:

gaz (3)

enum olympe.enums.mapper_mini.button_action

The action (mapped on a button)

takeoff_land:

Take off or land (0)

take_picture:

Take a picture (1)

flip_left:

Flip left (2)

flip_right:

Flip right (3)

flip_front:

Flip front (4)

flip_back:

Flip back (5)

emergency:

Emergency motors shutdown (6)

accessory_gun:

Launch USB accessory gun action (shoot) (7)

thrown_takeoff:

Thrown take off (8)

cw_90_swipe:

90 deg clockwise swipe (9)

ccw_90_swipe:

90 deg counter clockwise swipe (10)

cw_180_swipe:

180 deg clockwise swipe (11)

ccw_180_swipe:

180 deg counter clockwise swipe (12)

gear_up:

increase gear (13)

gear_down:

decrease gear (14)

plane_mode_half_barel_roll_right:

in plane mode make a 180 deg anticlockwise swipe on roll axis (15)

plane_mode_half_barel_roll_left:

in plane mode make a 180 deg clockwise swipe on roll axis (16)

plane_mode_backswap:

in plane mode make a 180 deg clockwise swipe on pitch axis (17)

plane_mode_looping:

vertical circular loop in plane mode (18)

plane_mode_toggle:

switch between plane mode and quad mode (19)

accessory_claw:

Launch USB accessory claw action (open/close) (20)

light_continuous:

switch continuous light (ON/OFF) (21)

light_blink:

switch blink light (ON/OFF) (22)

light_sinus:

switch sinus light (ON/OFF) (23)

light_toggle:

toggle between light animations (OFF-continuous-blink-sinus-OFF) (24)

piloting_mode_toggle:

toggle between easy and preferred piloting mode (25)

video_record_toggle:

start or stop video (26)

enum olympe.enums.mapper_mini.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.mapper_mini.mode

The piloting mode of the product

quad:

Quadricopter mode (0)

plane:

Plane mode (1)