Difference between revisions of "SIGFOX"

From HSYCO
Jump to navigation Jump to search
Line 107: Line 107:
 
|R
 
|R
 
|the name of the device type corresponding to devicetypeId (obtainable only with API)
 
|the name of the device type corresponding to devicetypeId (obtainable only with API)
 +
 +
|-
 +
 +
|rowspan="2" |device.<deviceId>.devicetype
 +
|<text>
 +
|R
 +
|the ID of the device type in which deviceId is grouped
 +
 +
|-
 +
 +
|rowspan="2" |device.<deviceId>.name
 +
|<text>
 +
|R
 +
|the name of deviceId (obtainable only with API)
 +
 +
|-
 +
 +
|rowspan="2" |device.<deviceId>.lastseen
 +
|<ts>
 +
|R
 +
|timestamp (in Epoch time) of the last message sent by deviceId
 +
 +
|-
 +
 +
|rowspan="2" |device.<deviceId>.msg
 +
|<text>
 +
|R
 +
|last message sent by deviceId (Hexadecimal format)
 +
 +
|-
 +
 +
|rowspan="2" |device.<deviceId>.token.end
 +
|<ts>
 +
|R
 +
|deviceId token end date (in Epoch time) (obtainable only with API)
 +
 +
|-
 +
 +
|rowspan="2" |device.<deviceId>.lqi
 +
|0
 +
|R
 +
|link quality indicator (computed from the last message received). 0=limit, 1=average, 2=good, 3=excellent, 4=not available
 +
|-
 +
|1
 +
|R
 +
|deviceId token end date (in Epoch time) (obtainable only with API)
 +
  
 
|}
 
|}

Revision as of 09:37, 20 October 2020

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. As reported in the Sigfox Backend each device is grouped into a device type.

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 incoming callback messages from Sigfox Cloud
callbackkey <text> key used in Sigfox URL callbacks to receive incoming callback messages

SIGFOX Utility

Use the SIGFOX Utility to automatically discover new devices or configure existing ones.


Datapoints

ID Value R/W Description
connection online R the driver is ready to accept incoming messages from Sigfox Cloud
offline R initialization of the driver failed or loop cycle failed
devicetype.<devicetypeId>.name <text> R the name of the device type corresponding to devicetypeId (obtainable only with API)
device.<deviceId>.devicetype <text> R the ID of the device type in which deviceId is grouped
device.<deviceId>.name <text> R the name of deviceId (obtainable only with API)
device.<deviceId>.lastseen <ts> R timestamp (in Epoch time) of the last message sent by deviceId
device.<deviceId>.msg <text> R last message sent by deviceId (Hexadecimal format)
device.<deviceId>.token.end <ts> R deviceId token end date (in Epoch time) (obtainable only with API)
device.<deviceId>.lqi 0 R link quality indicator (computed from the last message received). 0=limit, 1=average, 2=good, 3=excellent, 4=not available
1 R deviceId token end date (in Epoch time) (obtainable only with API)


Release Notes

3.8.0

  • initial release