Murano Sigfox Integration
Sigfox is a French global network operator founded in 2009 that builds wireless networks to connect low-power objects such as electricity meters and smartwatches, which need to be continuously on and emitting small amounts of data.
Table of Contents
In order to make Sigfox works on Murano platform, we need to do some integration first. This includes:
Sigfox setup: it will create
devicetypein Sigfox Backend.
groupis normally a company name.
apirefers to api access credentials, it includes a
apiPassword, you can create it in sigfox.
devicetypeis a collection of same type devices, it is denoted by a unique id created by sigfox when we create a devicetype in sigfox.
we need to use those variables in Murano in order to connect sigfox with murano.
Murano setup: we need to fill in the
callback definitionsin murano
Services -> Sigfoxsetting page.
apiPasswordis used for accessing sigfox backend api.
resourcedefines the data received from a Sigfox device for a given
deviceTypeId. The resource
nameindicates the target Murano Device2 resources in which the Sigfox data will be saved. The
typedefines how to decode the data.
See below for more details.
The Sigfox Micro-Service provides:
- A direct interaction with Sigfox API
- Automated callback management
- Murano device auto-provisioning
12bytesto Murano resourcess mapping
- Allow multi-tenant biding to Sigfox backend
- Supported both of uplink and downlink
The Sigfox Iot-Connector template provides:
- Integrates the Sigfox Micro-Service
- Automated bundle & event routing
- Exosense data model (
- Data transformation module
Unless necessary, always use the Sigfox Iot-Connector template.
Before getting start you will need a Sigfox backend Account ready to accept devices connectivity.
1. Create a group in Sigfox backend
2. Create an API access in the group
3. Create a devicetype in the group
4. Check the domain, apiUser and apiPassword
1. Add Sigfox Service & Sigfox-Product template to your Business
On Murano Exchange, search for 'Sigfox' under 'Service' section and click 'ADD SERVICE'. Then find 'Sigfox-Murano-Product' under 'Solution Templates' and click 'CREATE PRODUCT'. If you are not familiar with Murano’s Exchange Element, you can refer to this doc: Adding Exchange Elements.
2. Create Product Solution from Sigfox-Product template
Refer to this detailed page about how to Create an IoT Connector
Note: Remember to choose
Sigfox Connector as the template in IoT Marketplace.
3. Configure Sigfox Service
On the Sigfox Product 'Services' tab configure your Sigfox account information.
Then add a configuration for your Sigfox 'DeviceType' under the Callbacks list.
- Murano configures access to Sigfox per Sigfox 'DeviceType'. 1 Murano IoT-Connector can configure X distinct Sigfox 'DeviceType'.
- Each entry in the Callbacks configuration matches 1 Sigfox 'DeviceType'
- Murano Sigfox integration manages the callbacks automatically (Sigfox API defines various callback sub-types).
- In Sigfox you can only have a single instance of a given callback type per_DeviceType_. Don't configure multiple Murano IoT-Connectors to target the same Sigfox DeviceType.
Have a look to the detailed format for each configuration field on the Micro-service Sigfox reference.
Also to define the payload configs representing the 12 bytes sent by the device, read the Sigfox decoding-Grammar page.
Remove a specific callback by clicking on the "..." icon on the right.
Click "APPLY" button after filling up all the configuration.
4. Check the callback in Sigfox backend
Now, your Sigfox deviceType contains a new callback targeting Murano!
Now, if you activate the device to send uplink data, the device along with sent data should be displayed in Murano User-Interface under the IoT-Connector page.
Devices will get automatically provisioned to Murano when receiving the first uplink message.
Product Resources Setup
Murano product defines the data model available for a given product and usually requires configuration.
Luckily, the Murano-Product-Template automatically configure your product resources from the configured Sigfox resources so no additional set is needed.
However, if you have interest about the resources definitions, please refer to this link to learn more.
ExoSense only) Channel Setup
ExoSense application requires the product defining the available data channels available in a
Again this template automatically builds the schema from the Sigfox configuration and ExoSense applications connected to the product will display the Sigfox data out-of-the-box.
You can still utilize the ExoSense Channel configuration to customize the look and feel for those channels.
Warning: Following are intended for advanced Murano developer.
Sigfox Product Template is Open-Sourced and you can customize its behavior to fit your own needs.
Fork the Sigfox-product branch repo into your own account and modify its Lua logic as required.