Simple Hardware knowledge base
  • Welcome
  • Simple HW
  • CHAT
  • HOW TO PURCHASE THE DEVICES
    • Whom do we sell to
    • Pricing
    • Ordering and payment
    • Delivery
    • Shipping
    • Batteries shipping
      • Lithium transportation
    • Guarantee
    • Tracking
    • Packaging
    • Accessories
    • Documentation
    • Qualified and premium partners
    • Customization
      • Custom branding
      • Custom hardware and software
      • Custom device settings from the factory
    • Customer Portal
  • PROVISIONING AND DEVICE SETUP
    • Prerequisites
    • Step-by-step provisioning
    • Physical Installation
    • Reconfiguration of the devices
    • Troubleshooting
      • Troubleshooting process
      • Steps to troubleshoot:
    • Quality control
  • PRE-SALES SUPPORT
    • Radio zones and power
    • Whitepapers
      • Tapes whitepaper
      • Machine Monitoring Whitepaper
      • Location tracking whitepaper
      • Shock/Drop Detection Whitepaper
      • Reed Switch Whitepaper
      • Temperature (cold chain) monitoring whitepaper
    • Impact and Fall Protection Rating Test
    • Webinars
    • Blog posts
    • Datasheets and certifications
  • LPWAN
    • SIGFOX
      • Introduction to Sigfox
      • Connect to Sigfox
      • Sigfox coverage
      • How to Access Data From Your Devices
      • Monarch - Multizone Devices
      • Sigfox Support
      • Devices Ideal for Sigfox Atlas Tracking
      • Geolocation precision and possibilities
    • LoRAWAN
  • SENSORS
    • Button
      • Button in API 6
    • Accelerometer
    • Magnetometer
    • Reed switch
    • WiFi module
    • Gas
    • Dry switch
    • Leak
    • Light
    • Dry Switches
    • Temperature & Humidity sensors
    • Temperature Reaction Time
    • Devices for Temperature and Humidity Monitoring
  • NEXT/API 7 GENERATION
    • Introduction
  • SIMPLE/API 6 GENERATION
    • API 6
      • Before integrating API 6 devices
      • Overview For Beginners
      • Overview for Experts
      • Device states
      • WiFi User Modes
    • User Modes
      • Mode-Independent Information And Events
        • Heartbeats
          • Heartbeat 1 and Heartbeat 2
          • Heartbeat 3
        • Appended payload
        • Alerts
        • Sensor-triggered mode-independent events
        • Analog monitoring independent events
        • Other mode-independent events
      • Standard User Modes
      • Wifi User Modes
        • Press me WiFi
        • Guard me WiFi
        • Track me WiFi
        • Trace me WiFi
        • Don’t drop me WiFi
        • Reed switch on/off WiFi
        • Light on/off WiFi
        • Temperature threshold alert WiFi
        • Temperature change alert WiFi
      • Wifi Atlas User Modes
      • Wifi SuperLocal User Modes
        • Press me WiFi SuperLocal
        • Guard me WiFi SuperLocal
        • Track me WiFi SuperLocal
        • Trace me WiFi SuperLocal
        • Don’t drop me WiFi SuperLocal
        • Reed switch on/off WiFi SuperLocal
        • Light on/off WiFi SuperLocal
        • Temperature threshold alert WiFi SuperLocal
        • Temperature change alert WiFi SuperLocal
    • Uplink
    • Downlink Information
    • Encoding
      • 8 binary flags (byte bits)
      • SimpleTime
      • SimpleTemp
        • Here are all the SimpleTemp true temperature values
        • Here are all the SimpleTemp temperature hysteresis values
      • Accelerometer Data
      • Magnetometer data
    • API 6 Reset Triggers and Configuration Loss
    • API 6 Table
    • Factory Mode
    • Device Overview
      • Device Documentation
        • SimplePack
          • Legacy
            • SimplePack 2.0 Introduction
            • SimplePack 2.0 Accelerometer Lockout (Continuous Triggering Error)
            • SimplePack 2.0 User Modes (API 5)
            • SimplePack API 2, 4, 5 and 6 comparison
        • SimpleLeak
        • SimpleIndustry And SimpleMeter
          • SimpleIndustry
          • SimpleMeter
          • Battery Replacement
            • Battery Replacement in SimpleIndustry and SimpleMeter Devices
          • SimpleIndustry CO2 or SimpleIndustry CH4 Sensors
        • CheckFox
          • Starting with the CheckFox and the CheckFox Dashboard
          • All You Need to Know About the SIM Card in Your CheckFox and GSM connectivity
          • CheckFox Device User Guide
          • Sigfox Coverage Measurement Methodology With the CheckFox
          • CheckFox Troubleshooting Guide
          • Advanced
            • Technology Used to Run the CheckFox Dashboard
            • CheckFox Dashboard Data Export
            • CheckFox Log Data Interpretation
            • CheckFox Uplink Payload Description
      • Basic operations
        • SimplePack and SimplePack Plus: Basic operations
        • SimpleLeak: Basic operations
        • SimpleMeter/SimpleIndustry: Basic operations
        • What should you see on the Sigfox Backend
    • Working With Devices
      • Device Registration
      • Device Certificates
      • Device Downlink
      • Correct Device Placement
      • Radio Zone Switch
      • Battery longevity and levels
      • Magnet Range for SimplePack 4.0 Plus Motion & Door Sensor and others
        • Magnet: 30×10×1 (magnetic force: 1.1 kg)
        • Magnet: 40×13×1 (magnetic force: 1.5 kg)
        • Magnet: 20×10×2 (magnetic force: 2 kg)
        • Magnet: 30×10×2 (magnetic force: 2.6 kg)
        • Magnet: 30×15×2 (magnetic force: 3.3 kg)
        • Magnet: 40×20×10 (magnetic force: 20 kg)
    • IO Frog
      • First Message
      • Tracing
      • WiFi Tracing
      • Door Monitoring
      • Luggage Monitoring
      • Office Chair Monitoring
      • Leak Detection
      • Temperature Monitoring
      • Public Channel Setup
      • Manhole Cover Monitoring
  • TECHNICAL SUPPORT
    • Contact Support
    • RMA Process
      • Create RMA Number
    • Sigfox Backend Access
    • IO Frog Access
    • Consulting Services and Senior Project Management
Powered by GitBook
On this page
  • Recommended API credentials
  • How the data is collected (and where)
  • 1. Sigfox UPLINK callback
  • 2. HW log from device
  • 3. Sigfox SERVICE_DATA ADVANCED callback
  • 4. After GEOLOC callback or around 1 minute after UPLINK callback
  • 5. Reverse geo-coding
  • 6. Batch measurement processing
  • 7. Last fix task
  • Sigfox API used
  • 1. /api/coverages/global/predictions
  • 2. /api/devices/XXXXXX/messages?oob=true
  • 3. /api/devices/XXXXX
  • Sigfox callbacks
  • 1. UPLINK callback
  • 2. GEOLOC callback
  • HW log upload

Was this helpful?

  1. SIMPLE/API 6 GENERATION
  2. Device Overview
  3. Device Documentation
  4. CheckFox
  5. Advanced

Technology Used to Run the CheckFox Dashboard

KEY NAME
KEY DESCRIPTION
LICENSE

Apache

Webserver

Apache License

Nginx

Webserver - reverse-proxy to handle static files

BSD

PHP 7.x

Server-side scripting language

BSD

MySQL

Database server

GPL

React JS

Frontend JavaScript framework developed by Facebok

MIT License

MUI CSS

Material design UI framework

MIT License

Open Street Maps

OSM map tiles and geo-location APIs are used

ODbL + CC-BY-SA

Recommended API credentials

  • CUSTOMER [R] to see messages

  • OPT_INTEGRATOR to see IDs of base stations and repetitions

  • COVERAGE TOOL to see and use the global coverage API

  • OPT_STATION_LOCATION to see locations of BTSs and distances (Sigfox Operators only)

How the data is collected (and where)

1. Sigfox UPLINK callback

"device":"{device}",
"time":"{time}",
"data":"{data}",
"seqNumber":"{seqNumber}"

2. HW log from device

Some additional data we need to get from the device cannot be acquired from Sigfox or transmitted in the message payload. In the CheckFox HW log, you can find date, time and location from the GPS including orientation and speed, accelerometer data (min and max values) so we can determine device orientation and movement during measurement, internal temperature, GSM signal strength and battery level.

3. Sigfox SERVICE_DATA ADVANCED callback

"device":"{device}",
"time":"{time}",
"data":"{data}",
"seqNumber":"{seqNumber}",
"lqi":"{lqi}",
"fixedLat":"{fixedLat}",
"fixedLng":"{fixedLng}",
"operatorName":"{operatorName}",
"countryCode":"{countryCode}",
"deviceTypeId":"{deviceTypeId}",
"computedLocation":{computedLocation}
"duplicates":{duplicates}

4. After GEOLOC callback or around 1 minute after UPLINK callback

Dashboard will make API request to /api/devices/XXXXXX/messages?oob=true to fetch informations about all base stations from last measurement (dashboard will match the correct message by seqNumber, date and device id). At the same time, /api/coverages/global/predictions API is called to fetch coverage prediction for the real GPS location of device (if already available, or background task will wait few minutes and tries later).

5. Reverse geo-coding

Once all the callbacks and HW log upload are completed, background task will try to translate GPS location to street address using Open Street Map APIs (or cache if we already know the address for that GPS location).

6. Batch measurement processing

Another background task i.e. executed to double check that batch measurements are grouped properly and recount some statistics from received data. Also total number of messages in batch is checked and recounted if needed.

7. Last fix task

Another safeguard background task is here to double check that all data were delivered. If GEOLOC callback was missed, API calls are executed. If UPLINK and GEOLOC callbacks were missed, measurement with “no sigfox coverage” is created from HW log received from device.

Sigfox API used

1. /api/coverages/global/predictions

Used to get coverage prediction for location of measurement. Dashboard will compare this prediction to real measurement.

Used params:

- lat
- lon

Expected response:

- locationCovered
- margins

2. /api/devices/XXXXXX/messages?oob=true

Used to fetch message and details about all base stations that received the message.

Used params:

- device ID (in URL)
- oob (set to true)

Expected response:

- seqNumber (to match right message)
- rinfos (to fetch all the base stations infos)
- linkQuality

3. /api/devices/XXXXX

Used once a week to update registered device info (PAC, sigfox name, etc…)

Used params:

- device ID (in URL)

Expected response:

- pac
- name
- averageSnr
- averageRssi
- computedLocation
- Last (last message date and time)

Sigfox callbacks

1. UPLINK callback

This callback is used to get first message from measurement.

2. GEOLOC callback

This callback is used to get GEOLOC information from Sigfox. Also, this callback will execute background task that will fetch data from Sigfox API (/api/devices/XXXXXX/messages?oob=true) to get all the base stations data and coverage predictions (/api/coverages/global/predictions). Few seconds later, another task that will make reverse geo-coding of the GPS location.

HW log upload

After the measurement (or manually later when there is no GSM), CheckFox device will connect to the dashboard API via GSM and send a HW log with additional data.

PreviousAdvancedNextCheckFox Dashboard Data Export

Last updated 3 years ago

Was this helpful?