Connecting devices with DevKit connectivity

[EXPERTS ONLY]

You will get 20-days free access to IO Frog platform. After this evaluation period, you can buy a full access based on our price list.

Guideline:

Register devices in IO Frog
Create a new device type under backend.sigfox.com
Setup custom callbacks (see details bellow).
Register devices under backend.sigfox.com

Limitations:

No automatic automatic device registration under backend.sigfox.com
You have to setup callbacks to I/O Frog platform yourself
Checking your connectivity contract conditions is outside our possibilities. We cannot provide consumption reports or backend details.

Self-help guideline:

Check callbacks setups, the URL, content type and body must be exactly same as in guideline.
Check message history in backend.sigfox.com = device is sending messages to Sigfox network as expected.
Check callback status in Messages in backend.sigfox.com. All statuses must be green = all messages from Sigfox network are being sent to IO Frog.
Check downlink mode = callback in device type settings in backend.sigfox.com to ensure that devices can be updated via downlink.

Guidelines

1. The first steps are same as in New device registration, where you fill Identification and Device section and check “I already have Sigfox connectivity and access to backend.sigfox.com” in the Subsciption.

Choose 20-days free access.
After you click Next, registration process in I/O Frog is completed.
You have to create custom callbacks in backend.sigfox.com, so the messages sent by your device will be directed to I/O Frog.

Connection

2. Login to https://backend.sigfox.com/ using your credentials and choose Device Type in main menu:

Setup Callback - Device Type

3. Click on the name of your device type, in case of SimpleHW DevKit, choose Simple-Hardware_DevKit_1.

Setup Callback - Device Type

4. Choose Callbacks in left menu and click New in top-right corner.

Setup Callback

5. Choose option Custom callback

Setup Callback

6. Create callback #1:

Type: DATA, BIDIR. You can define only one active BIDIR callback that is necessary to update devices with downlink messages. Alternatively, you can choose UPLINK data type callback but your device will not be updated via downlink.
Channel: URL
URL pattern: https://www.iofrog.com/api/v1/devices/{device}/callbacks
Use HTTP metod: POST
Content type: application/json
Body:

{
 "timestamp" : {time},
 "type": "data_bidir", 
 "seqNumber" : {seqNumber},
 "ack": {ack}, 
 "messages": [ { "key": "payload", "value": "{data}" } ]
}

Setup Callback - BIDIR

7. After you created DATA_BIDIR callback, it is necessary to activate Downlink by clicking on circle in Downlink column. This is possible only if your device type is set to “Callback” (in device type settings).

Setup Callback - Downlink

8. Create callback #2 in case you want to send Sigfox GEO location to I/O Frog platform – you will be able to add computedLocation only if you have Geo location services on your current Sigfox contract:

Type: SERVICE, DATA ADVANCED
Channel: URL
URL pattern: https://www.iofrog.com/api/v1/devices/{device}/callbacks
Use HTTP metod: POST
Content type: application/json
Body:

{
  "timestamp" : {time},
  "type": "service_data_advanced",
  "seqNumber" : {seqNumber},
  "messages":    
       [
             {
                 "key": "lqi",
               	 "value": "{lqi}"
             },
             {
                 "key": "computedLocation",
                 "value": {computedLocation}
             }            
        ]
}

If you have duplicates enabled on your contract, you can add duplicate key:

{
  "timestamp" : {time},
  "type": "service_data_advanced",
  "seqNumber" : {seqNumber},
  "messages":    
       [
             {
                 "key": "lqi",
               	 "value": "{lqi}"
             },
             {
                 "key": "computedLocation",
                 "value": {computedLocation}
             },
             {
                 "key": "duplicates",
                 "value": {duplicates}
             }            
        ]
}

Setup Callback - GEO

9. Create callback #3 in case you want to send service acknowledge messages to I/O Frog:

type: SERVICE, ACKNOWLEDGE
Channel: URL
URL pattern: https://www.iofrog.com/api/v1/devices/{device}/callbacks
Use HTTP metod: POST
Content type: application/json
Body:

{
   "timestamp" : {time},
   "type": "service_ack",
   "messages": [ { "key": "acknowledgement", "value": "{downlinkAck}" } ]
}

Setup Callback - ACK

Secure callbacks with 3rd party connectivity

Because devices with 3rd party connectivity are already provisioned in Sigfox backend using the original PAC code, there is no possibility to check eligibility of the user to register particular device ID in IO Frog (the original PAC is obsolete and we do not have an access to new PAC code in backend.sigfox.com because of using 3rd party connectivity).

To increase the security, you can optionally add a secretKey attribute to all call-backs. If your callbacks from backend.sigfox.com are secured by such secretKey, you have to enter the same secretKey in IO Frog > Device connectivity > Settings.

WARNING

If the secretKey in IO Frog is missing or different, all callbacks will be rejected!

Example of BIDIR callback using the secretKey:

{
 "timestamp" : {time},
 "type": "data_bidir", 
 "seqNumber" : {seqNumber},
 "ack": {ack}, 
 "secretKey": "tskAwmdnC0RPfQ1NmJNTNXipcZhTYnIK",
 "messages": [ { "key": "payload", "value": "{data}" } ]
}

secretKey