Overview


What is Sigfox?

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.

What is Sigfox Service?

Sigfox Service is a service on Murano that supports the integration between Murano and Sigfox.

What Sigfox Service does

How Sigfox Service works

How Sigfox works


Sigfox Preparation

Before getting start you will need a Sigfox backend Account ready to accept devices connectivity.

Setup a group, api and devicetype in Sigfox Backend

Create a group in Sigfox backend

Create a group in Sigfox backend

Create an API access in the group

Create an API access in the group

Create a devicetype in the group

Create a devicetype in the group

Create a devicetype in the group 2

Create a devicetype in the group 2

Check the domain, apiUser and apiPassword

Check the domain, apiUser and apiPassword


Murano Setup

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

Create Sigfox Product

3. Configure Sigfox Service

On the Sigfox Product 'Services' tab configure your Sigfox account information. Configure Sigfox Credential Then configure a Callback as follows. Configure Sigfox Callback Configure Sigfox Payload

Detailed format for each configuration fields:

Name Type Description Example
domain String Sigfox backend domain. backend-demo.sigfox.com
apiUser String Sigfox username for basic authentication. $(apiuser)
apiPassword String Sigfox password for basic authentication. $(apiPassword)
callback[].deviceTypeId String Sigfox device type id. $(deviceTypeId)
callback[].payloadConfig[].resource String Murano product resource path. To specify a nested resource, use the 'dot notation' followed by the field name. data_in.temperature
callback[].payloadConfig[].definition String The resource field definition as defined by Sigfox decoding payload syntax: "$(byte_index):$(type_def)". Message type decoding grammar 1:uint:8

Remove a specific callback by clicking on the "..." icon on the right.

Remove Sigfox Callback

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!

Check the callback

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.

ExoSense Channel Setup

ExoSense application requires the product do defines the available data channels available in a config_io resource. Again this template automatically build the schema from 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.


Customization

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.

To use your template refer to the Authoring-elements-guide and the Solution-Template-Example.