Difference between revisions of "SIGFOX Utility"

From HSYCO
Jump to navigation Jump to search
Line 1: Line 1:
 
[[Category:Manager]]
 
[[Category:Manager]]
The SIGFOX Utility application provides a graphical interface to configure a [[SIGFOX | SIGFOX I/O Server]].
+
The SIGFOX Utility application provides a graphical interface to configure a [[SIGFOX | SIGFOX I/O Server]]. You can choose your SIGOX I/O Server in execution by selecting it on the top of the page
  
 
In order to automatically add new Sigfox devices to SIGFOX I/O Server enable auto-discovery ("Auto-discovery" checkbox).
 
In order to automatically add new Sigfox devices to SIGFOX I/O Server enable auto-discovery ("Auto-discovery" checkbox).
Line 9: Line 9:
  
  
From the list, click on each device to add, edit and save its configuration.
+
From the list, click on each device to edit and save its configuration.
  
 
[[File:MQTTBROKER_Util_config.png|thumb|400px|Client configuration]]
 
[[File:MQTTBROKER_Util_config.png|thumb|400px|Client configuration]]
Line 15: Line 15:
 
'''Parameters''':
 
'''Parameters''':
  
*'''ID''': the ID to assign to the client. It cannot be empty. The default value corresponds to the IP address of the client
+
*'''ID''': the ID of the device. It cannot be empty
*'''Username''': client's username
+
*'''Name''': device name
*'''Password''': client's password
+
*'''Model''': device model (select among those available)
  
  
 
To manually add a device click on the "+" button at the bottom-left corner of the page.
 
To manually add a device click on the "+" button at the bottom-left corner of the page.
  
To remove a device, click on it from the list, click on "Delete" and confirm. If the auto-discovery is enabled, the device will reappear upon the next received frame from it.
+
To remove a device, click on it from the list, click on "Delete" and confirm. If the auto-discovery is enabled, the device will reappear in the list upon the next message coming from it.
  
 
Disable the auto-discovery when all the required devices have been configured.
 
Disable the auto-discovery when all the required devices have been configured.
Line 28: Line 28:
 
The devices list shows the following fields:
 
The devices list shows the following fields:
 
* '''ID''': ID of the device
 
* '''ID''': ID of the device
* '''Online''': connection status of the client with the MQTT broker
+
* '''Name''': device name
* '''Last seen''': date and time of the last received valid frame
+
* '''Model''': device model
 +
* '''Last seen''': date and time of the last received valid message (including keep-alive)
  
 
== Committing the configuration ==
 
== Committing the configuration ==
When all clients are configured, click on the "Commit" button on the top-right corner of the main page. The configuration will be persisted and the MQTTBroker I/O Server will restart with the new configuration.
+
When all devices are configured, click on the "Commit" button on the top-right corner of the main page. The configuration will be persisted and the SIGFOX I/O Server will restart with the new configuration.

Revision as of 15:50, 20 October 2020

The SIGFOX Utility application provides a graphical interface to configure a SIGFOX I/O Server. You can choose your SIGOX I/O Server in execution by selecting it on the top of the page

In order to automatically add new Sigfox devices to SIGFOX I/O Server enable auto-discovery ("Auto-discovery" checkbox). Sigfox devices will appear in the list:


Clients discovery


From the list, click on each device to edit and save its configuration.

Client configuration

Parameters:

  • ID: the ID of the device. It cannot be empty
  • Name: device name
  • Model: device model (select among those available)


To manually add a device click on the "+" button at the bottom-left corner of the page.

To remove a device, click on it from the list, click on "Delete" and confirm. If the auto-discovery is enabled, the device will reappear in the list upon the next message coming from it.

Disable the auto-discovery when all the required devices have been configured.

The devices list shows the following fields:

  • ID: ID of the device
  • Name: device name
  • Model: device model
  • Last seen: date and time of the last received valid message (including keep-alive)

Committing the configuration

When all devices are configured, click on the "Commit" button on the top-right corner of the main page. The configuration will be persisted and the SIGFOX I/O Server will restart with the new configuration.