Soracom LTE-M Button
Alert + Heartbeat Mode
The Alert + Heartbeat mode limits the supported click types in order to prioritize sending a message when the built-in button is clicked, disables the ability to accidentally cancel messages to ensure messages are delivered, and also sends an additional message at regular intervals indicating that the button is still able to connect. In addition, the button can be configured to remain connected for a brief period in order to send additional messages without reconnecting to the network.
Configuration
The Alert + Heartbeat mode is available only for buttons with firmware version 3134 or later. Buttons with an earlier firmware version will ignore these settings and continue operating in their current operation mode.
To configure your button for Alert + Heartbeat mode:
-
Follow the Configuration instructions for configuring Soracom LTE-M Button settings.
-
Select the Alert + Heartbeat mode option:
You can configure the following options for Alert mode:
- Uplink frequency - The frequency to send Heartbeat messages.
- Auto sync - For buttons with firmware version 3134 or later, automatically sync once a day.
- External I/O mode - Configure the external I/O accessory port:
- Disabled
- Edge Detection
- Pulse Detection
- Enable debounce - Enables debouncing for Edge Detection and Pulse Detection external I/O modes to reduce false triggers.
After configuring Soracom LTE-M Button settings, follow the instructions to sync your button.
Messages
When the Soracom LTE-M Button operation mode is configured as Alert + Heartbeat, the button will send the following types of messages:
- Alert message, indicating the type of event that triggered the message
- Heartbeat message, reporting the current status of the button
- Status message, reporting the current status and configuration of the button
Behavior
Input | Action | External I/O mode | |||
---|---|---|---|---|---|
Disabled | |||||
Built-in button | Single short click*1 |
|
|||
Double short click | |||||
Single long click | |||||
Extra long click |
|
||||
2-wire accessory | Connected*1 |
|
|
||
Disconnected*1 |
|
|
|||
Internal timer | Uplink frequency*2 |
|
|||
Every 24 hours |
|
*1 - If the Network standby option is enabled, the button will stay connected to the network for the configured number of seconds in order to send additional Alert messages without reconnecting, and will automatically disconnect once all message have been sent.
*2 - The Uplink frequency is specified when configuring the operation mode as Alert + Heartbeat.
LED indicator
While the button is sending an Alert message, Heartbeat message, or Status message, the LED will blink to indicate the progress:
LED blink pattern | Description | Progress |
---|---|---|
☀──☀──☀── (repeating) | Slow green blinking | The button is connecting to a network |
☀☀☀☀ (repeating) | Fast green blinking | The button has connected and is sending the message |
☀──────── | Extra long green blink | The button successfully sent the message |
☀──────── | Extra long red blink | An error occurred |
If the button has trouble sending a message, it will try one more time before giving up. For more information, refer to the Troubleshooting section.
Refer to the LED Reference for descriptions of additional indicators.
Additional messages
If the built-in button is clicked or the external I/O is triggered while the button is sending an Alert message, the button will send another Alert message for each additional click or trigger it detects.