API 6 Basic Operations With SimpleHw Devices

CheckFox documentation is NOT part of this article!

SimplePack and SimplePack Plus

  1. Downlink request is triggered by an extra long press (6+ seconds) of the button. While the button is pressed, the LED diode is lit and then starts blinking after 6 seconds.

  2. When the diode starts blinking, you can let go of the button - downlink request is initiated. The LED will then blink slowly for 40 seconds.

  3. Successful reception is indicated by long blink of the LED, unsuccessful by series of 5 very short blinks.

When changing SimplePack and SimplePack Plus register settings via downlink (including but not limited to switching modes) you need to see this on the Sigfox backend:

  1. Uplink message with the current mode as the first byte and 0x81 as the second byte (Extra long press). Following bytes are FW and HW revisions - see the table for explanation.

  2. You should see ACKED when you click on the downlink arrow - this means that the BTS sent the downlink to the device (which does NOT mean that the device received the downlink!)

  3. You can receive a downlink confirmation uplink message if you want to. The first byte will be the new mode (if you’ve changed modes) and the second byte will be either 0x15 or 0x16 - this depends on whether the downlink is chained or not - one of the messages requests additional downlinks.
    Downlink confirmation can be turned on by bit 3 of register 0x0F. The default value of this register is 0x06, if you want to receive downlink confirmation messages, the value needs to be 0x0E.

Arming the device

  1. Start arming the device by a Short press (<2 seconds). While the button is pressed, the LED diode is lit and the short press is then indicated by a short blink.

  2. After this, departure delay timer starts - default is 15 seconds. Departure delay is indicated by double blinking and its purpose is to give you enough time to place the device where you need it.

  3. When departure delay expires, the device is armed and ready to work as intended. This is indicated by the the LED blinking the letter A in Morse code (short, long).

When arming the SimplePack and SimplePack Plus, you need to see this on the Sigfox backend:

  1. Uplink message with the current mode as the first byte and 0x10 as the second byte (Start of arming).

  2. Uplink message with the current mode as the first byte and 0x11 as the second byte (Armed).

Disarming the device

  1. When the device is active (armed), you can disarm it by long-pressing the button (2-4 seconds). After that, the LED will indicate a long-blink twice followed by two short blinks.

When disarming the SimplePack and SimplePack Plus, you need to see this on the Sigfox backend:

  1. Uplink message with the current mode as the first byte and 0x14 as the second byte (Disarmed).

SimpleMeter/SimpleIndustry

Introduction

While the SimplePacks use the button as a default way to trigger downlink, the SimpleIndustry/SimpleMeter use the magnetic switch instead (but in the same way).

Here's where to place your magnet (to perform "Button presses"):

Before you start working with the device, make sure the settings you want to change are input into the Sigfox backend (or IO Frog/other platform) and saved there = waiting for a downlink request.

  1. Downlink is requested by an "extra long press" (6+ seconds) with the magnet. While the magnet is held near the magnetic switch, the LED diode is lit and then starts blinking after 6 seconds.

  2. When the diode starts blinking, you can remove the magnet - downlink request is initiated. The LED will then blink slowly for 40 seconds.

  3. Successful reception is indicated by long blink of the LED, unsuccessful by series of 5 very short blinks.

Arming

Initiating Arming

  1. Do a "short press" (<2 seconds) to start the arming. While the magnet is near, the LED diode is lit and the "short press" is then indicated by a short blink.

  2. After this, arming process starts - default is 15 seconds. Arming process is indicated by double blinking and its purpose is to give you enough time to place the device where you need it.

  3. After this, the device is armed and ready to work as intended. This is indicated by the the LED blinking the letter A in Morse code (short, long)

Disarming

Initiating Disarming

  • When the device is active (armed), you can disarm it by doing a "long press" (2-4 seconds) with the magnet. After that, the LED will indicate a long-blink twice followed by two short blinks.

SimpleLeak

Please note that the SimpleLeak currently supports only one mode - Leak detector (0x0A). Changing the mode is not recommended as the device will not be able to switch back to Leak detector! Please use the downlink only for the fine-tuning settings of the Leak detector mode.

  1. Place the device onto a plate with some water (at least 2mm) and wait until it beeps twice - this indicates the start of arming (downlink is requested with this message as there’s no control button on the device).

  2. Remove the device from water and wait for the departure delay timer to expire (15 seconds in default).

  3. After departure delay, the SimpleLeak will beep three times. This indicates that the device is armed.

When arming the SimpleLeak, you need to see this on the Sigfox backend:

  1. Uplink message with 0x0A (Leak detector mode) as the first byte and 0x10 (Start of arming) as the second byte. You should also see that the message requested a downlink.

  2. You should see ACKED when you click on the downlink arrow - this means that the BTS sent the downlink to the device (which does NOT mean that the device received the downlink!)

  3. Uplink message with 0x0A (Leak detector mode) as the first byte and 0x11 (Armed) as the second byte.

Disarming the device

  1. Simply flip the device upside down and wait. When it stops beeping, the SimpleLeak is deactivated.

When disarming the SimpleLeak, you need to see this on the Sigfox backend:

  1. Uplink message starting with 0x0A (Leak detector mode) and followed by 0x14 (Disarmed).