Skip to content

Latest commit

 

History

History
41 lines (37 loc) · 5.18 KB

DeviceConfig.md

File metadata and controls

41 lines (37 loc) · 5.18 KB

DeviceConfig

Properties

Name Type Description Notes
current_fw str Current Firmware version [optional]
ota_fw str Pending Firmware version. If non null, the unit will be told to upgrade to this version when it next transmits in sleep mode. [optional]
interval float The wake mode interval in seconds. The unit will connect to the server this often when awake.
sleep_interval float Sleep mode interval in seconds. The unit will try to connect this often to the server when asleep
check_in_interval float DEPRECATED A failsafe to ensure the unit connects to the server at least this often. [optional]
packing float The number of GPS points to send with each transmission. A packing setting of 3 with an 'interval' of 60s will result in points recorded approximately every 20s, but they will only be sent together. This increases the time you have to wait for locations to come through to the server but improves battery life
movement_sensitivity float Deprecated. See debounce. [optional]
debounce float Movement sensitivity on a scale of 1 to 10, with 1 being the most sensitive. It is correlated to the number of consecutive milliseconds the acceleration needs to exceed the movementSensitivity threshold [optional]
movement_sensitivity2 float A secondary debounce value. Typically this value is lower or equal to debounce, representing increased sensitivity to movement once the device is already moving. [optional]
behavior float Char Bitfield with various flags. Advanced use only. DisableBluetooth:32 Encrypt:128
mode_control float Char Bitfield with various flags. Advanced use only. StartStopOnly:1 LockAwakeOnAlert:2
mode_control2 float Char Bitfield with various flags. Advanced use only. FW >= 69. SendStopImmediately:1 StopTimeoutIsInMinutes:2
gps_timeout float How long to let the GPS searches for a lock in seconds before giving up. Max 255s. [optional]
transmit_timeout float When the unit first wakes up from sleep, how long to wait before trying to transmit in multiples of 30 seconds. 0 = instant, 1 = 30s, 2 = 60s... Useful to avoid detection or draining battery inside shielded buildings. [optional]
gps_stabilize float How long to let the GPS stabilise in seconds once a lock is achieved before sending the position. Higher values may increase accuracy. [optional]
gps_check_interval float If a safe-zone is used, how often to check the wifi & gps to see if its still inside it (only applies when motion is detected) [optional]
stop_timeout float The total amount of time in seconds the unit has to be stationary for before deeming the journey over and switching to sleep mode [optional]
tolerance_percentage float Power budget in mAh per location update. Default 10, do not set lower than 5. [optional]
reasons_to_wake list[object] [optional]
modified datetime Set to any non null date to indicate the configuration should be pushed to the device when it next connects [optional]
force_fw bool Internal use. Used with otaFW. Set to true to force the unit to upgrade on next connection (rather than waiting for a sleep connection [optional] [default to False]
received_at datetime Indicates the last time the settings were sent to the device [optional]
reset float Non NULL values cause unit to restart on next connection 0 = Normal reboot 1 = Clear settings cache and restart 2 = Clear cache and bluetooth connection data, then restart [optional]
flash_try_count float Internal use. Set to 0 when changing otaFW [optional]
home_wifi_network str WiFi network name to use as a Safe-zone. When this network is visible, stay asleep [optional]
home_wifi_password str WiFi network paswword. If set enables transmission over WiFi. [optional]
wake_action str Internal Use Only. What to do when the unit wakes up (ie is moved and not in a safe-zone). Options are 'available' (lost and found), and 'normal' (tracking) [default to 'normal']
on_demand_time float Deprecated
alert_action str What to do when the button is pressed or the unit is dropped. Options are 'available' (stay registered on the mobile network), 'nothing' (one transmission) and 'lockOn' (keep transmitting at 'interval' until instructed otherwise [default to 'nothing']
id float [optional]
device_id float [optional]
safe_zone_id float [optional]

[Back to Model list] [Back to API list] [Back to README]