SIGFOX

From HSYCO
Revision as of 15:50, 19 October 2020 by Gianluca (talk | contribs) (→‎Options)
Jump to navigation Jump to search

Sigfox is a global network operator founded 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. This driver allows you to communicate with Sigfox Cloud in order to retrieve messages and status updates collected from devices.

HSYCO Configuration

Add the SIGFOX I/O Server in the I/O Servers section of the Settings and set its parameters:

Authentication

  • User: optional API username
  • Password: optional API password

Devices list file

At the first run of SIGFOX driver a file named "sigfox-devices_<I/O_Server_name>.ini" will be created . This file can contain a series of line, each line represents informations of a single device and can have the following format:

<device_id>:name=<device_name>,model=<device_model>
<device_id>:model=<device_model>,name=<device_name>
<device_id>:name=<device_name>
<device_id>:model=<device_model>
<device_id>

E.g.

BE1234:name=homesensor,model=eccoswitch
BE1234:model=eccoswitch,name=homesensor
BE1234:name=homesensor
BE1234:model=eccoswitch
BE1234


Device id must be present in each line while name and model are optional. Device identifiers are considered as case insensitive by the SIGFOX I/O Server, so there can't be two identifiers with the same sequence of characters in upper/lower case, e.g. "BE1234" and "be1234" are considered the same.

Options

ID Default Values Description
startupevents true true generate IO events also during the driver’s start-up phase
false start generating events only after HSYCO is aligned with the current status of the system
acceptunknown false true accept incoming messages from devices whose id isn't specified in Sigfox-devices.ini
false doesn't accept incoming messages from devices whose id isn't specified in Sigfox-devices.ini
callbackport <portNumber> internal port used to receive callback messages from Sigfox Cloud
callbackkey value key used in Sigfox callbacks URL to receive callback messages