Cellular feature

event message olympe.messages.cellular.apn_information(modem_id=None, mode=None, url=None, username=None, password=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.apn_information

Apn information

Parameters:

• modem_id (u8) – Id of the modem.

• mode (u8) – 0 for auto mode, 1 for manually set apn

• url (string) – Access Point Name URL.

• username (string) – Access Point Name username.

• password (string) – Access Point Name password.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection or on changes by set_apn().

event message olympe.messages.cellular.capabilities(modem_id=None, supported_capabilities=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.capabilities

Capabilities

Parameters:

• modem_id (u8) – id of the modem. Modem id is unique and persistent: the same modem model on a same drone model always has the same id. Main/Built-in modem has id zero.

• supported_capabilities (BitfieldOf(olympe.enums.cellular.supported_capabilities, u16)) – Supported capabilities.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection only.

event message olympe.messages.cellular.mode(modem_id=None, mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.mode

Mode of cellular feature

Parameters:

• modem_id (u8) – Id of the modem.

• mode (olympe.enums.cellular.mode) – Mode of cellular feature.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection or on changes by set_mode().

event message olympe.messages.cellular.modem_information(modem_id=None, status=None, imei=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.modem_information

Modem information

Parameters:

• modem_id (u8) – Id of the modem.

• status (olympe.enums.cellular.modem_status) – Modem status.

• imei (string) – International mobile equipment identity.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection or on changes.

event message olympe.messages.cellular.network_information(modem_id=None, status=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.network_information

Network status

Parameters:

• modem_id (u8) – Id of the modem.

• status (olympe.enums.cellular.network_status) – Network status.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection or on changes.

event message olympe.messages.cellular.network_mode(modem_id=None, network_mode=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.network_mode

Mobile technology

Parameters:

• modem_id (u8) – Id of the modem.

• network_mode (olympe.enums.cellular.network_mode) – Allowed access technology.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection or on changes after set_network_mode().

event message olympe.messages.cellular.pincode_request(modem_id=None, invalid_pincode=None, pin_remaining_tries=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.pincode_request

PIN code request

Parameters:

• modem_id (u8) – Id of the modem.

• invalid_pincode (u8) – 0 if no PIN code has been provided yet, 1 if an invalid PIN code has been rejected by the SIM.

• pin_remaining_tries (u8) – Remaining PIN code tries.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered After SIM has been detected; if no valid PIN code has been provided for that SIM.

event message olympe.messages.cellular.registration_information(modem_id=None, status=None, operator=None, technology=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.registration_information

Registration information

Parameters:

• modem_id (u8) – Id of the modem.

• status (olympe.enums.cellular.registration_status) – Registration status.

• operator (string) – Operator name.

• technology (olympe.enums.cellular.technology) – Access technology.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection or when network information changed on drone.

command message olympe.messages.cellular.reset_config(_timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

cellular.reset_config

Resets configuration and reboots the product if it is not flying.

Parameters:

• _timeout (int) – command message timeout (defaults to 10)

• _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Result: All settings are reset to their default values and the product will reboot if the command can be executed, otherwise the event reset_config_failed() is sent.

event message olympe.messages.cellular.reset_config_failed(_policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.reset_config_failed

Reset configuration failed

Parameters:

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered After a reset_config command if the operation has failed.

event message olympe.messages.cellular.roaming_allowed(modem_id=None, roaming_allowed=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.roaming_allowed

Roaming allowed

Parameters:

• modem_id (u8) – Id of the modem.

• roaming_allowed (u8) – 1 if roaming is allowed, 0 if disallowed.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection or on changes after set_roaming_allowed().

command message olympe.messages.cellular.set_apn(modem_id, mode, url, username, password, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

cellular.set_apn

Set APN configuration.

Parameters:

• modem_id (u8) – Id of the modem.

• mode (u8) – 0 for auto mode, 1 to set apn manually

• url (string) – APN URL.

• username (string) – APN username.

• password (string) – APN password.

• _timeout (int) – command message timeout (defaults to 10)

• _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Result: APN settings are set, and event apn_information() is sent accordingly.

Expectations: apn_information(mode=self.mode, url=self.url, username=self.username, password=self.password, _policy='wait')

command message olympe.messages.cellular.set_mode(modem_id, mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

cellular.set_mode

Set mode of cellular feature.

Parameters:

• modem_id (u8) – Id of the modem.

• mode (olympe.enums.cellular.mode) – Requested cellular mode.

• _timeout (int) – command message timeout (defaults to 10)

• _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Result: Requested cellular mode is set and mode() event is triggered with the new mode.

Expectations: mode(mode=self.mode, _policy='wait')

command message olympe.messages.cellular.set_network_mode(modem_id, network_mode, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

cellular.set_network_mode

Force a specific mobile technology.

Parameters:

• modem_id (u8) – Id of the modem.

• network_mode (olympe.enums.cellular.network_mode) – Access technology.

• _timeout (int) – command message timeout (defaults to 10)

• _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Result: Modem will only register on network with selected technology and won’t change automatically

Expectations: network_mode(network_mode=self.network_mode, _policy='wait')

command message olympe.messages.cellular.set_pin_code(modem_id, pin, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

cellular.set_pin_code

Set SIM card PIN code.

Parameters:

• modem_id (u8) – Id of the modem.

• pin (string) – SIM card PIN code.

• _timeout (int) – command message timeout (defaults to 10)

• _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Result: Unlock of the SIM card with the PIN code is tried, and event sim_information() is sent accordingly, or pincode_request() event if pin code is wrong.

Expectations: sim_information(status='ready', _policy='wait')

command message olympe.messages.cellular.set_roaming_allowed(modem_id, allowed, _timeout=10, _no_expect=False, _float_tol=(1e-07, 1e-09))

cellular.set_roaming_allowed

Allow or disallow roaming.

Parameters:

• modem_id (u8) – Id of the modem.

• allowed (u8) – 1 to allow roaming, 0 to disallow roaming.

• _timeout (int) – command message timeout (defaults to 10)

• _no_expect (bool) – if True for,do not expect the usual command expectation (defaults to False)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Result: Roaming setting is set, and event roaming_allowed() is sent accordingly.

Expectations: roaming_allowed(roaming_allowed=self.allowed, _policy='wait')

event message olympe.messages.cellular.sim_information(modem_id=None, status=None, iccid=None, imsi=None, _policy='check_wait', _float_tol=(1e-07, 1e-09))

cellular.sim_information

SIM card information

Parameters:

• modem_id (u8) – Id of the modem.

• status (olympe.enums.cellular.sim_status) – SIM card status.

• iccid (string) – SIM card serial number.

• imsi (string) – International Mobile Subscriber Identity.

• _policy (olympe.arsdkng.expectations.ExpectPolicy) – specify how to check the expectation. Possible values are ‘check’, ‘wait’ and ‘check_wait’ (defaults to ‘check_wait’)

• _float_tol (tuple) – 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

Supported by:

ANAFI Ai:

with an up to date firmware

Triggered At connection; on changes after set_pin_code() and by the drone.

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

Cellular mode.

disabled:

Cellular feature is disabled, Airplane mode. (0)

nodata:

Cellular feature is enabled, data are disabled. (1)

data:

Cellular feature is enabled, data are enabled. (2)

enum olympe.enums.cellular.modem_status

Modem status.

off:

Modem is off. (0)

offline:

Modem is offline. (1)

online:

Modem is online. (2)

error:

Modem initialization error. (3)

flashing:

Flashing of the modem is ongoing. (4)

enum olympe.enums.cellular.network_mode

Configured access technology.

auto:

Mode auto (0)

3g:

3G. (1)

4g:

4G. (2)

5g:

5G. (3)

enum olympe.enums.cellular.network_status

Network status.

deactivated:

Network is deactivated. (0)

activated:

Network is activated. (1)

denied:

Network activation was denied. (2)

error:

Internal error. (3)

enum olympe.enums.cellular.registration_status

Registration status.

not_registered:

Not registered. (0)

searching:

Searching. (1)

registered_home:

Registered with home operator. (2)

registered_roaming:

Registered with roaming operator. (3)

denied:

Registration denied. (4)

enum olympe.enums.cellular.sim_status

SIM card status.

unknown:

SIM card status is unknown. (0)

absent:

No SIM card is available. (1)

initializing:

SIM card is initializing. (2)

locked:

SIM card is locked and requires a PIN code to unlock. (3)

ready:

SIM card is ready. (4)

enum olympe.enums.cellular.supported_capabilities

Supported capabilities.

4g:

Supports 4G. (0)

enum olympe.enums.cellular.technology

Access technology.

gsm:

Global System for Mobile Communications. (0)

gprs:

General Packet Radio Service. (1)

edge:

Enhanced Data Rates for GSM Evolution. (2)

3g:

3G. (3)

hsdpa:

High Speed Downlink Packet Access. (4)

hsupa:

High Speed Uplink Packet Access. (5)

hspa:

High Speed Packet Access. (6)

4g:

4G. (7)

4g_plus:

4G+ Band aggregation. (8)

5g:

5G. (9)