🎉 First steps
🎉

First steps

How it works

Please look over the following documentations, it provides an overview of standard features and data-set such as:

Recorded data on the device

Here is the name and description of fields (recorded data) on the device: Fields description

Each field is recorded on the device depending on a recording policy.

Recording policy can be:

Please note that a field isn't necessarily activated or recorded by default, however it can be configured thanks to our device administration platform.

Emission strategy for recorded data

Here are some explanation on the emission policy of the device

Basically, if two consecutive records are identical, the second record is not sent as it is not necessary to send it again since it is already available on the server.

The cache of the back-end server can be used to get the latest value received, as implemented on WebDemo interface (new record appears in bold on the map interface).

Please keep in mind our emission strategy while integrating your back-end.

Device configuration

Device configuration can be adjusted through our Device Administration platform (called Dashboard) to activate/deactivate features, change parameters and access additional data.

Here is the procedure:

Note:

- Device needs to be connected to network to receive the configuration

You can follow the campaign status

Here are some additional information regarding the device administration platform

API are also available for the Dashboard: Online documentation

Using a Wifi and Bluetooth device:

Online documentation for activation

Sensor configuration

Driver identification

Back-end integration

Packet notification to your server

Basically, whenever our platform (called CloudConnect) receives some data from an asset (dongle), it will forward the event to a configured webserver via a POST HTTP request, also known as WebHook. When an event is created on our servers, we'll POST a notification to your URL.

The body of the POST will be a JSON-encoded document.

WebHooks can be triggered by the following events:

  • presence - When an asset connects or disconnects,
  • message - When an asset sends a message on any channel.
  • track - When an asset sends tracking data.

Please focus on the track packet as it contains all interesting data (field) recorded on the device, with timestamp and location.

A track packet contains the data fields recorded by devices. Fields recorded at the same time are aggregated in the same track packet.

To integrate the data:

  • Parse the JSON packet
  • Look for the track events with recorded data
  • Decode your fields from base64 to adequate type (bool, integer, string) based on the Fields description

Here is the documentation regarding the notification (including retry policy, packet aggregation, security, etc): Notification

It includes:

  • Track format
  • JSON schema
  • Payload example
  • Packet aggregation
  • Retry policy
  • Security

Tips:

Keep in mind the device recording policy and emission strategy while integrating your back-end

Example codes

Here are some example code to help your back-end integration:

How to visualize your data

In order to visualize your data, you can use our integration and demonstration tool. Webdemo is a web

interface used to visualize devices data if you don't have your own back-end server yet.

You can visualize this data on a map and export raw data in csv format (using display all data button):

https://webdemo.munic.io/home

Note:

- On the map table, new field record appears in bold

- Using Display all button, you can export raw data in CSV format

Get data on your server

As soon as you are ready to get the data on your own server you need to specify the URL of your server on munic.io. Go to the My Products section then on Get data on my server tab to enter your URL.