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

Was this helpful?

  1. SIMPLE/API 6 GENERATION
  2. API 6

Overview For Beginners

PreviousBefore integrating API 6 devicesNextOverview for Experts

Last updated 2 years ago

Was this helpful?

This is just a very basic overview of what the firmware architecture looks like and what it can or cannot do. If you’d like a more in-depth guide to API 6 or any of its parts, check out .

Data can be sent either from the device to the Sigfox backend or vice versa. Uplink is data sent from the device to the Sigfox backend. Uplink payload is limited to 12 bytes. Downlink is data sent from the backend to the device. Downlink payload is limited to 8 bytes.

User modes

The main feature of API 6 are the multiple different operating modes. Every operating mode is an application that has a predefined set of behaviors that can be adjusted to better fit your use case. Think of a mode as of a completely unique and different device (but of course, some modes share similarities). Each mode uses some of the predefined events - uplink messages (event hex symbol always means the same in every mode). Device behavior is controlled by downlink register values - the first and most important downlink register is the operating mode. Everything else is there just for fine-tuning the behavior of the device.

End users should never change operating modes - only integrators should configure the devices!

Arming and disarming

The devices go through a cycle of different device states. They allow you to arm (activate) the device when you need it to monitor its environment and gather data and disarm (deactivate) them when they are not needed to save the battery. Check out the guide!

Uplink payload parsing

API 6 has a predefined way of reporting data. There are exceptions of course (covered in the expert guide), but generally, the first two bytes of the payload are always the operating mode and an event. There are two ways to parse the remaining ten bytes - if the hex symbol of the event is from 0x00 to 0x7F, the additional data is (various data can be appended regardless of event). Events from 0x80 and up will mostly be sent with MAC addresses or mode-specific data that is unique to the received event.

In order to save space and battery life, some complex data is encoded into one or more bytes - you can find a list of encoding used in the API 6 so you know what’s what.

Downlink register settings

Downlink registers are set up via . The payload has to always include a register pointer and its respective value to change one setting - this means 4 register values can be changed with one downlink. Register pointers are predefined and the first one is the operating mode - in order to change it, the first byte has to be 0x01 and the following one has to be the hex symbol of the mode you’d like to use.

In default settings, downlink is triggered by an extra long press of the button (6+seconds) for both SimplePack versions and by arming (activating) the device for the SimpleLeak.

API 6 Overview For Experts
API 6 Basic Operations With SimpleHw Devices
appended payload
here
downlink