In this article:
Module Startup
A new Myriota Module comes with the bootloader pre-programmed, but will not perform any satellite communications until the user application has been programmed, and power is connected.
The first time the Module is powered up, it begins to wake up in accordance with the onboard network information to listen for new network updates. These wakeups are performed aggressively at startup, as the timeframe between firmware installation and deployment may be significant.
Once the Module has successfully updated from the Network, it will continue to wake up and listen for further updates periodically.
Suspend Mode
During post-production testing or device commissioning, you may wish to power up the Myriota Module for verification or configuration tasks. This will kick off the module startup process.
Upon completion of your tasks, you will likely want the Module to sleep, to prevent satellite communications and minimise energy consumption until the device is deployed in the field.
You can achieve this by switching the module into “suspend mode” using the Suspend Mode
API.
Enable Suspend Mode
To silence the Module, invoke the SuspendModeEnable(true)
API to put the Module in suspend mode.
This will have the following impact:
- The message queue is cleared, and no further messages can be scheduled until the Module exits suspend mode
- No message transmission occurs
- No receive activity occurs
- No GNSS updates
- No system job execution, including the collection of module diagnostics
Your user application can continue to interact with the Module, however messages cannot be scheduled. Ongoing RF test should be stopped before entering suspend mode.
Calling SuspendModeEnable(true)
API has no effect if the system is already in suspend mode.
By default, the Module is in normal mode after reset or power up. The Module will remain in suspend mode on restart if it was in this state prior to the restart.
To get the current state of the suspend mode, use the SuspendModeIsEnabled()
API.
Disable Suspend Mode
To return the Module to normal mode, you can call SuspendModeEnable(false)
API any time.
This will have the following impact:
- Message transmission recommences, and messages can now be scheduled
- Receive activity recommences
- Existing GNSS location is invalidated and a new GNSS fix is reacquired
- System jobs recommence
- Diagnostics are generated to timestamp both the entry and exit of suspend mode
Calling SuspendModeEnable(false)
API has no effect if the system is already in normal mode.