CheckFox and CheckFox Dashboard Prerequisites and Setup

What are the steps I need to take after buying the CheckFox?

IN ORDER FOR THE DEVICE TO WORK YOU SHOULD HAVE 3 THINGS:

 

  1. Working SIM Card
  2. Working Sigfox connectivity
  3. Proper configuration setup in Sigfox backend and CheckFox dashboard

 

Let’s elaborate a bit more on each of the steps.

 

  1. Working SIM Card
    We now ship with a global 10 EUR prepaid SIM card, so you don't need to disassemble the unit in order to get it working. But it must be ACTIVATED. The SIM can be easily recharged online. Please see the guide and more details here.

    If you wish to use your own SIM card please follow these instructions.
    Don't forget to change the APN, that is operator specific.

  2. Working Sigfox connectivity
    We no longer offer Sigfox connectivity as majority of users wanted to use their own.
    If you don't already have your own connectivity, you can get it from your local Sigfox operator or buy it at buy.sigfox.com (please note that buying from buy.sigfox.com is available for some countries only, if you do e.g. international tracking, it's preferable you buy the connectivity from your local SO).

  3. Proper configuration setup in Sigfox backend and CheckFox dashboard
    In order for the device to work correctly please take the following steps. It should take no more than 5 minutes.


CHECKFOX DASHBOARD DEVICE AND USER ENROLMENT

 

  1. Go to https://checkfox.simplehw.eu/
  2. Login with your Google Account into CheckFox Dashboard.
    We collect just email address.
    In the future other authentifications will be possible
  3. Once logged in, enrol your Company by filling in its name
  4. Now you need to login with your Google Account once more
  5. Add your Checkfox Device by Clicking Devices and pressing New
  6. Add additional users by Clicking Users and entering their emails

SIGFOX BACKEND SETUP

 

  1. Go to https://backend.sigfox.com and login with your Sigfox credentials
  2. On Sigfox backend Create Group for CheckFox devices and name it e.g. Checkfox_internal_group
  3. Under this group create API credentials. Name it e.g. checkfox_api.
    Give it rights of:
    1. CUSTOMER [R] in order to see messages DEVICE [R] should be sufficient as well
    2. OPT_INTEGRATOR in order to see IDs of basestations and repetitions
    3. COVERAGE TOOL in order to see and use coverage API
      If you don't have these rights ask you Sigfox operator to give it to you.

    4. If you are Sigfox operator give it OPT_STATION_LOCATION (to see location of BTSs and distances). It must be created directly under the operator group and not in a subgroup.

      See instructions how to create API credential
  4. Write the API Login and API password into CheckFox dashboard
  5. On Sigfox backend under the Group create a device type and name it e.g. CheckFox20_internal
  6. Under the newly created device type register your CheckFox as a new device. Do not forget to register your CheckFox newly created device as prototype. For registering you just need the ID and PAC code that is on the back of your CheckFox.
  7. Under the device type where your CheckFox has been registered provide payload for Downlink testing. Go to Device Type - Information- upper right corner press Edit. Under Downlink data switch to Direct and input 16 zeros (8 Bytes of 0) Press Ok
  8. Under this Device type create custom callbacks
    See instructions how to create callbacks

DATA CALLBACK

 

Type:

DATA : UPLINK

Channel:

URL

Url pattern:

https://checkfox.simplehw.eu/api/scbmeasurement?type=uplink

Use HTTP Method:

POST

Send SNI:

CHECKED (don't forget to check this option)

Headers / Header:

Authorization

Headers / Value:

Unique per company please get it from the Checkfox dashboard

Content type:

application/json

Body:

{

"device":"{device}",

"time":"{time}",

"duplicate":"{duplicate}",

"station":"{station}",

"snr":"{snr}",

"avgSnr":"{avgSnr}",

"rssi":"{rssi}",

"data":"{data}",

"seqNumber":"{seqNumber}",

"lat":"{lat}",

"lng":"{lng}"

}


GEOLOC CALLBACK

 

Type:

SERVICE : GEOLOC

Channel:

URL

Url pattern:

https://checkfox.simplehw.eu/api/scbmeasurement?type=geoloc

Use HTTP Method:

POST

Send SNI:

CHECKED (don't forget to check this option)

Headers / Header:

Authorization

Headers / Value:

Unique per company please get it from the Checkfox dashboard

Content type:

application/json

Body:

{

"device":"{device}",

"time":"{time}",

"duplicate":"{duplicate}",

"snr":"{snr}",

"avgSnr":"{avgSnr}",

"rssi":"{rssi}",

"station":"{station}",

"lat":"{lat}",

"lng":"{lng}",

"radius":"{radius}",

"seqNumber":"{seqNumber}"

}


FIRMWARE UPDATE

Now please update the Firmware.

Go to Main menu-Service menu-Firmware update to update the device to latest firmware. Description of the version of firmware can be found at simplehw.eu/checkfox. The update takes about 3mins. And the size is 64 kByte. Go to Main-Service menu-About to check the firmware version. Battery voltage should be 3.9V or more when updating. If not, firmware rewrite is not allowed due to security reasons. You can connect charger if in doubt.

Please report the FW version in case of any issues.

 

Here you can find documentation for the payload description 

https://docs.google.com/document/d/1Di9--255DAyjrtT5iWkC5m0jVSaoqeP33zIiBNDkBxk/edit?usp=sharing

Log data we are sending through GSM

https://docs.google.com/document/d/1nRJBYH4vlQR3WTq916cQsHYKIvUc2H1bjYi19EwxCv4/edit?usp=sharing

XML dump of all the data from Dashboard

https://docs.google.com/document/d/1ZODa6gS3RXCQMz-jrkuqkPaspv9f-y3HA9MREP6ZWGs/edit?usp=sharing