|
Myriota HyperPulse™ Library 1.0
|
This document describes the AT commands supported by Myriota HyperPulse™ library. It provides a summary of the supported commands, their usage, expected responses, and examples. This interface is intended for use with Myriota HyperPulse™ library.
All AT commands follow this format:
<Command>: Command body including parameters<CR>: Carriage return (\r)Responses typically end with OK or ERROR.
This set command requests the Myriota HyperPulse™ library software version.
Response Format
Example Response
This command sets the operating mode of the Myriota HyperPulse™ library.
Get Command
Query the current mode,
0 : disabled1 : enabledSet Command
<mode>0 : disabled1 : enabledExpected Response:
On success:
This command sends a user specified uplink message. If the UE is detached or a satellite link is not available, the message is queued up until the UE is ready to send it.
Set Command
<length>: Length of payload in Bytes<data>: Payload in HEX string formatExpected Response:
On success:
Get Command
This command checks the status of the uplink message queue, returning the number of user messages waiting to be sent.
<pending_count>: The number of user messages currently in the uplink queue.Expected Response:
If there are 3 messages waiting in the queue:
This set command enables/disables unsolicited notifications for received downlink messages.
Set Command
<enable> 1: Enable URC notification , 0: Diasble URC notificationExample URC Notification Enable
Example URC Notification
This command requests a list of all Myriota AT commands supported by the Myriota HyperPulse™ library.
Set Command
Expected Response:
This command requests a new location fix or sets a location for the device. When requesting a fix, the location will be returned as a URC notification. Setting a location allows the device to optimise power consumption by assuming the device will not move, minimising internal location checks.
Set Command
<latitude> : In 0.1 micro-degrees.<longitude> : In 0.1 micro-degrees.<elevation> : In milli-meters.Expected Response:
Get Command
<method> :0 : Use GNSS (currently the only supported location method).<accuracy> :0 : LOW - Approximate fix only, used to save power at the expense of accuracy1 : BALANCED - Optimise both power and accuracy constraints.2 : HIGH - High accuracy prioritising accuracy over any power constraints.<max_age_s> : Maximum age in seconds for the last update of specified method and accuracy to be considered valid.<timeout_s> : Fix timeout in seconds.Expected Notification Format
<accuracy> : Same as Get command, with additional state of timeout:0 : LOW - Approximate fix only, used to save power at the expense of accuracy.1 : BALANCED - Optimise both power and accuracy constraints.2 : HIGH - High accuracy prioritising accuracy over any power constraints.-1 : TIMEOUT - Fix has timed out. see <timeout_s> for when a fix retry will be attempted.<latitude> : In 0.1 micro-degrees.<longitude> : In 0.1 micro-degrees.<elevation> : In milli-meters.<timestamp_s> : UTC timestamp in seconds of when the fix was obtained.<next_fix_s> : If timeout occurs, specifies time until next retry.Example URC Notification
Notification containing valid location:
Notification containing location fix that has timed-out and the next retry will be in 120s:
Get Command
This command requests the current system time as UTC epoch in milliseconds.
Expected Response :
<current_time_ms> : Current UTC time in ms.Example Response
Set Command
This command subscribes to URC notifications whenever the system updates the time.
<enable_updates> :1 : Subscribe to MTIME URC notifications0 : Disable MTIME URC notificationsExpected URC notification:
<current_time_ms> : Current UTC time in ms.Example URC notification: