# Key Smart Badge tracker commands

There is major difference in the Smart Badge commands from MCU Firmware 2.3 and the ones below. The first step is to find out the MCU Firmware version of the tracker.

# Find the MCU firmware version of the tracker

The button sequence to reset the tracker is quite different between Asset Tracker MCU Firmware 2.3 and the versions below. The first step is to find out the installed MCU firmware version of the tracker from here

# The tracker commands for MCU Firmware 2.3 and above

This table gives you quick access to the tracker commands. For more information on all the commands and LED patterns, see Abeeway Trackers Reference Guide

Important

  • Click: Press the button less than one second.
  • Press: Press the button between lasts 1 and 4 seconds.
  • Long Press: Press the button between lasts 5 and 7 seconds.
  • Double-click: Press the button 2 times (The duration between the clicks is less than 1 second).
  • Triple-click: Press the button 3 times (The duration between the clicks is less than 1 second).
  • Very Long Press or ESC Sequence: Press the button more than 14 seconds. The tracker will play a beep every second during this time.
  • Since MCU Firmware 2.3+, the button sequence is configurable with button_mapping parameter. The examples below are for the button mapping for the default firmware configuration. For more inforation, visit User Interface training (opens new window).
  • Please ensure you refer to the Abeeway Reference Guide that matches your MCU Firmware version. The user interface of Abeeway trackers have different behavior across different MCU Firmware versions.
  • The sequences below are the same for micro tracker and smart badge.
  • Abeeway trackers have three important states:
    1. SHIPPING: This is usually the state when the tracker leaves the warehouse. The tracker is in lower power state waiting to be activated with a button Press (between 1 and 4 seconds). Once, activated, the tracker moves to JOINING state.
    2. JOINING: In this state, the tracker is trying to join the LoRaWAN network, but has not joined yet. Each button press (between 1 and 4 seconds) in this state restarts the join procedure and also activates the Bluetooth of the tracker to allow pairing with the Abeeway tracking app. If the Bluetooth is successfully activated, the tracker will play Bluetooth advertisement melody (opens new window) for about 10 minutes (which is the default configuration). The Micro tracker/Smart Badge will make 15 LoRaWAN join attempts for EU region and 27 attempts for other regions. If the join is not successful after these attempts, tracker will go back to SHIPPING state and needs to be re-activated again with the button Press (between 1 and 4 seconds).
    3. JOINED: In this state, the tracker has successfully joined the LoRaWAN network and is functioning normally.
How to...

Action

Activate the tracker Press the button once (between 1 and 4 seconds). The button must be released to generate the event

The tracker will play Bluetooth advertisement melody to allow pairing with the mobile app and will make Blue/Pink flash to indicate the start of LoRaWAN Join procedure

Note

This sequence is NOT configurable with button_mapping parameter

  • This sequence is only applicable for the following tracker states: (SHIPPING, JOINING)
  • Repeating the sequence again while the tracker is in JOINING state will restart the LoRaWAN join procedure and Bluetooth advertisement
Switch on Press the button once (between 1 and 4 seconds). The button must be released to generate the event

The tracker will play switch ON melody once it starts and will also start Bluetooth advertisement to allow pairing with the Abeeway tracking app

The tracker starts in motion tracking mode in default configuration

Note

This sequence is NOT configurable with button_mapping parameter.

  • This sequence is only applicable for the following tracker states: (JOINED)
Switch off Long Press the button once (between 5 and 7 seconds). The button must be released to generate the event

The tracker will play switch OFF melody before it shuts down.

Note

This sequence is NOT configurable with button_mapping parameter.

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger the sequence.
Check On/Off status Click the button once shortly (less than one second).

-> If the tracker is on, the blue led flashes and the tracker indicates battery level.

Note

When this feature is activated (with button_mapping parameter, the behavior is the following:

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger the sequence.
  • The default configuration of click is mapped to show battery level in default configuration of button_mapping parameter
  • Please refer to Abeeway Trackers Reference Guide (Chapter: User Interfaces) on how to interpret LEDs to indicate battery level
Trigger SOS mode/Stop SOS mode Triple-click the button (Duration between each click should be less than one second).

Note

When this feature is activated (with button_mapping parameter, the behavior is the following:

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger the sequence.
  • The tracker sends positions continuously at a fixed period of 120 seconds (defined by sos_period).
  • The tracker’s red led is blinking slowly.
  • To stop SOS mode, triple-click the button again.
  • Note: The default configuration of the firmware is mapped to SoS with triple-click.
Trigger a position alert Triple-click the button (Duration between each click should be less than one second).

Note

When this feature is activated (with button_mapping parameter, the behavior is the following:

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger the sequence.
  • To trigger one-time position alert, triple-click the button. The position alert cannot be triggered again for 60 seconds.
  • The tracker sends one time position. The tracker will blink with red LED to indicate the position was sent
  • Note: The default configuration of the firmware is NOT mapped to send position alert with ANY button sequence
Remove Bluetooth bond on the tracker Do the following sequence to remove Bluetooth bond on the tracker:
  • Hold the button for more than 14 sec to enter ESC sequence. The tracker will play melody indicating the fact that special sequence can be started.
  • Once inside the special sequence, do the following: 1 click, 3x click or more, 1x press (between 1 - 4 sec)
  • If the sequence is successful, the tracker will play Bluetooth advertisement melody indicating the Bluetooth bond is removed for about 10 minutes (which is the default configuration)

Note

  • This special sequence is not configurable with button_mapping parameter
  • This special sequence is applicable for all the tracker states: (SHIPPING, JOINING, JOINED) irrespective of the tracker being ON or OFF.
  • If the sequence that is entered is not recognizable by the firmware, the firmware will abort special sequence after 15 seconds
  • You must wait at least 20 seconds between two special sequences, else the second special sequence will not be taken into account
Reset the tracker and re-do a join request Apply Re-doing a join request.

# The tracker commands for MCU Firmware 2.2 and below

This table gives you quick access to the tracker commands. For more information on all the commands and LED patterns, see Abeeway Trackers Reference Guide

Important

  • Click: Press the button less than one second.
  • Long Press: Press the button more than five seconds.
  • Double-click: Press the button 2 times (The duration between the clicks is less than 1 second).
  • Triple-click: Press the button 3 times (The duration between the clicks is less than 1 second).
  • Please ensure you refer to the Abeeway Reference Guide that matches your MCU Firmware version. The user interface of Abeeway trackers have different behavior across different MCU Firmware versions.
  • The sequences below are the same for micro tracker and smart badge.
  • Abeeway trackers have three important states:
    1. SHIPPING: This is usually the state when the tracker leaves the warehouse. The tracker is in lower power state waiting to be activated with a Long Press (more than 5 seconds). Once, activated, the tracker moves to JOINING state.
    2. JOINING: In this state, the tracker is trying to join the LoRaWAN network, but has not joined yet. Each long press (more than 5 seconds) in this state restarts the join procedure and also activates the Bluetooth of the tracker to allow pairing with the Abeeway tracking app. If the Bluetooth is successfully activated, the tracker will play Bluetooth advertisement melody (opens new window) for about 10 minutes (which is the default configuration). The Micro tracker/Smart Badge will make 15 LoRaWAN join attempts for EU region and 27 attempts for other regions. If the join is not successful after these attempts, tracker will go back to SHIPPING state and needs to be re-activated again with a long press (more than 5 seconds).
    3. JOINED: In this state, the tracker has successfully joined the LoRaWAN network and is functioning normally.

:::

How to...

Action

Activate the tracker Long Press the button once (more than 5 seconds).

The tracker will make Blue/Pink flash to indicate the start of LoRaWAN Join procedure

Note

  • This sequence is only applicable for the following tracker states: (SHIPPING, JOINING)
  • Repeating the sequence again while the tracker is in JOINING state will restart the LoRaWAN join procedure
Switch on Long Press the button once lengthily (more than five seconds) until you heard a melody.

-> The tracker starts in motion tracking mode in default configuration.

Note

  • This sequence is only applicable for the following tracker states: (JOINED)
Switch off Long Press the button once lengthily (more than five seconds) until you heard a melody.

-> If the tracker is on, it switches off.

Note

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger to sequence.
Check On/Off status Click the button once shortly (less than one second).

-> If the tracker is on, the blue led flashes to indicate battery level.

Note

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger to sequence.
  • Please refer to Abeeway Trackers Reference Guide (Chapter: User Interfaces) on how to interpret LEDs to indicate battery level
Trigger SOS mode Triple-click the button (Duration between the clicks should be less than one second).

Note

When this feature is activated (config_flags must be set to bit 2=1), the behavior is the following:

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger to sequence.
  • The tracker sends positions continuously at a fixed period of 120 seconds.
  • The tracker’s red led is blinking slowly.
  • To stop SOS mode, triple-click the button again.
  • For MCU FW: 2.0 and below, SoS is triggered by double click if config_flags (bit 2=1).
  • For MCU FW: 2.1/2.2, SoS is triggered by triple click if config_flags (bit 2=1).
Trigger a position alert Triple-click the button (Duration between the clicks should be less than one second).

Note

When this feature is activated (config_flags must be set to bit 2=0), the behavior is the following:

  • This sequence is only applicable for the following tracker states: (JOINED). The tracker must be ON to trigger to sequence.
  • To trigger position alert, triple-click the button.
  • The tracker sends one time position. The tracker will blink with RED LED to indicate the position was sent
  • For MCU FW: 2.0 and below, SoS is triggered by double click if config_flags (bit 2=0).
  • For MCU FW: 2.1/2.2, SoS is triggered by triple click if config_flags (bit 2=0).
Reset the tracker and re-do a join request Apply Re-doing a join request.