Ardrone3.Sound*¶
- command message olympe.messages.ardrone3.Sound.StartAlertSound(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)¶
ardrone3.Sound.StartAlertSound
Start the alert sound. The alert sound can only be started when the drone is not flying.
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_mode
olympe.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 ardrone3.Sound.StartAlertSound
Result: The drone makes a sound and send back
AlertSound()with state playing.Expectations:
AlertSound(state='playing', _policy='wait')
- command message olympe.messages.ardrone3.Sound.StopAlertSound(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09), _int_tol=0)¶
ardrone3.Sound.StopAlertSound
Stop the alert sound.
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_mode
olympe.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 ardrone3.Sound.StopAlertSound
Result: The drone stops its alert sound and send back
AlertSound()with state stopped.Expectations:
AlertSound(state='stopped', _policy='wait')
- event message olympe.messages.ardrone3.SoundState.AlertSound(state=None, _policy='check_wait', _float_tol=(1e-07, 1e-09), _int_tol=0)¶
ardrone3.SoundState.AlertSound
Alert sound state.
Parameters:
state :
olympe.enums.ardrone3.SoundState.AlertSound_State- _policy
olympe.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_mode
olympe.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 ardrone3.SoundState.AlertSound
Triggered: by
StartAlertSound()orStopAlertSound()or when the drone starts or stops to play an alert sound by itself.- _policy
- enum olympe.enums.ardrone3.SoundState.AlertSound_State¶
State of the alert sound
- stopped:
Alert sound is not playing (0)
- playing:
Alert sound is playing (1)