...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
The FTP interface can be used for:
Updating the Software
Updating the configuration *
Support
NOTE: Multiples configuration's updates can be done simultaneously : (Those will be done in this order)
License update
Device update
Output update
| Info |
|---|
If the license's check is KO, the product will not start. |
Setup FTP client
Connect to µWiotys using a FTP client (ex: Filezilla)
Host: $IP_Address_µWiotys (by default:
192.168.1.100)Port: 2222
Protocol: SFTP (SSH File Transfer Protocol)
| Note |
|---|
Warning the response time of µWiotys' FTP can be a little bit long, especially on fixed IP. |
Contact Wi6labs support team for user/password: support@wi6labs.com
End device configuration
LoRaWAN device provisioning on µWiotys can be done by FTP transfer.
First, create the configuration file with proper parameters and format then connect to µWiotys with FTP and copy the configuration file into the proper directory.
Configuration file
File name
The name of the devices configuration file can be: devices_update.json or devices_update_XXXXXXXX.json
where “XXXXXXXX” is the hardware serial number of the board (8 digits, upper case), it can be found on the web interface in the Overview ⇒ Information menu.
One or many devices can be add or deleted with the same update file. You can use µWiotys Online support interface to help create your update file.
Parameters for each device
...
Field
...
Mandatory
...
description
...
Possible value
...
uwiotys.state
...
yes
...
Required action
"add" to configure a new device
"delete" to remove a configured device
if set to "active", nothing will be done
...
"add"/"delete"/"active"
...
uwiotys.reference
...
yes
...
End device manufacturer reference
...
Manufacturer reference : see LoRaWAN Compatible Devices
...
uwiotys.output_protocols.modbus.@modbus
...
yes
...
Modbus slave ID
...
1 to 200
...
spn.activation_type
...
yes
...
End device activation type, only OTAA supported
...
"OTAA"
...
spn.dev_eui
...
yes
...
String of 16 hexadecimal characters
...
"70B3D5E75E008888"
...
spn.app_eui
...
yes
...
String of 16 hexadecimal characters
...
"70B3D5E75F600000"
...
spn.app_key
...
yes
...
String of 32 hexadecimal characters
...
"78FF2CDE6D2C657F09981C3332096DF9"
...
spn.dev_addr
...
no
...
For future use
...
spn.nwks_key
...
no
...
For future use
...
spn.apps_key
...
no
...
For future use
...
spn.end_device_parameters.rx_window
...
yes
...
End device rx windows
...
This parameters cannot be change
...
spn.end_device_parameters.rx_frequency
...
yes
...
End device rx frequency
...
This parameters cannot be change
...
spn.end_device_parameters.rx_datarate
...
yes
...
End device data rate
...
This parameters cannot be change
...
spn.end_device_parameters.class
...
yes
...
End device class
...
A or C
Configuration file will be rejected at first error, missing field or wrong parameters.
File format
The file format should be as follow, several device can be listed in the sensors table.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
| Panel | ||||||||
| ||||||||
Please be patient with those steps, start up the gateway and actions with FTP can take a long time |
| Table of Contents | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
The FTP interface can be used for:
Updating the Software
Updating the configuration *
Support
NOTE: Multiples configuration's updates can be done simultaneously : (Those will be done in this order)
License update
Device update
Output update
| Warning |
|---|
If the license's check is KO, the product will not start. |
Setup FTP client
Connect to µWiotys using a FTP client (ex: Filezilla)
Host: $IP_Address_µWiotys (by default:
192.168.1.100)Port: 2222
Protocol: SFTP (SSH File Transfer Protocol)
| Note |
|---|
Warning the response time of µWiotys' FTP can be a little bit long, especially on fixed IP. Don’t forget to refresh in order to see your current files |
Contact your seller for user/password
End device configuration
LoRaWAN device provisioning on µWiotys can be done by FTP transfer.
First, create the configuration file with proper parameters and format then connect to µWiotys with FTP and copy the configuration file into the proper directory.
Take care of the LoRa Band used in the JSON when you add a sensor on a gateway not European (different from 868MHz)
Configuration file
File name
The name of the devices configuration file can be: devices_update.json or devices_update_XXXXXXXX.json
where “XXXXXXXX” is the hardware serial number of the board (8 digits, upper case), it can be found on the web interface in the Overview ⇒ Information menu.
One or many devices can be add or deleted with the same update file. You can use µWiotys Online support interface to help create your update file.
Parameters for each device
Field | Mandatory | description | Possible value |
|---|---|---|---|
uwiotys.state | yes | Required action | "add"/"delete"/"active" |
uwiotys.reference | yes | End device manufacturer reference | Manufacturer reference : see LoRaWAN Compatible Devices |
uwiotys.output_protocols.modbus.@modbus | yes | Modbus slave ID | 1 to 200 |
spn.activation_type | yes | End device activation type, only OTAA supported | "OTAA" |
spn.dev_eui | yes | String of 16 hexadecimal characters | "70B3D5E75E008888" |
spn.app_eui | yes | String of 16 hexadecimal characters | "70B3D5E75F600000" |
spn.app_key | yes | String of 32 hexadecimal characters | "78FF2CDE6D2C657F09981C3332096DF9" |
spn.dev_addr | no | For future use | |
spn.nwks_key | no | For future use | |
spn.apps_key | no | For future use | |
spn.end_device_parameters.rx_window | yes | End device rx windows | This parameters cannot be change |
spn.end_device_parameters.rx_frequency | yes | End device rx frequency | This parameters cannot be change |
spn.end_device_parameters.rx_datarate | yes | End device data rate | This parameters cannot be change |
spn.end_device_parameters.class | yes | End device class | A or C |
Configuration file will be rejected at first error, missing field or wrong parameters.
File format
The file format should be as follow, several device can be listed in the sensors table.
| Code Block | ||
|---|---|---|
| ||
{ "sensors": [ { "uwiotys": { "state": "add", "reference": "50-70-139", "output_protocols": { "modbus": { "@modbus": 1 } } }, "spn": { "outputactivation_protocolstype": {"OTAA", "dev_eui": "modbus70B3D5E75E008D35":, { "app_eui": "70B3D5E75F600000", "@modbus": 1 "app_key": "725070411F8720932F4A56B6117D0638", } "dev_addr": "", } "nwks_key": "", }, "spnapps_key": {"", "activationend_device_type": "OTAA",parameters": { "devrx_euiwindow": "70B3D5E75E008D35"3, "apprx_euifrequency": "70B3D5E75F600000"869525000, "apprx_keydatarate": "725070411F8720932F4A56B6117D0638"0, "dev_addrclass": "A", } "nwks_key": "", } }, "apps_key": "", { "end_device_parametersuwiotys": { "rx_windowstate": 3"add", "rx_frequencyreference": 869525000, "50-70-053", "rxoutput_datarateprotocols": 0,{ "classmodbus": "A"{ } "@modbus": 2 } }, { } "uwiotys": { } "state": "add", }, "referencespn": "50-70-053",{ "outputactivation_protocolstype": { "OTAA", "modbusdev_eui": { "70B3D5E75E008888", "@modbusapp_eui": 2"70B3D5E75F600000", } "app_key": "78FF2CDE6D2C657F09981C3332096DF9", } "dev_addr": "", }, "spnnwks_key": {"", "activationapps_typekey": "OTAA", "devend_device_euiparameters": "70B3D5E75E008888",{ "apprx_euiwindow": "70B3D5E75F600000"3, "apprx_keyfrequency": "78FF2CDE6D2C657F09981C3332096DF9", 869525000, "devrx_addrdatarate": ""0, "nwks_keyclass": "", A" } } "apps_key": "", } "end_device_parameters": { "rx_window": 3, "rx_frequency": 869525000, "rx_datarate": 0, "class": "A" } } } ] } |
Upload configuration
Upload the configuration file
Copy the devices configuration file into the directory: /uwiotys/update_config/
Create an empty file named "reboot" in directory "/update/". You can reboot with this method or with the reboot web interface button
| Note |
|---|
An electric reboot can corrupt the update process ! |
After few minutes
If the update failed, you will find information into the file: devices_updates_$DATE_ERROR.log
If the update success, the file the devices configuration file is deleted and you will find the file: devices_updates_$DATE_SUCCESS.log
The devices current configuration of µWiotys is available in the directory: /uwiotys/current_config/
...
]
} |
Upload configuration
Upload the configuration file
Copy the devices configuration file into the directory: /uwiotys/update_config/
Create an empty file named "reboot" in directory "/update/". You can reboot with this method or with the reboot web interface button
| Note |
|---|
An electric reboot can corrupt the update process ! |
| Info |
|---|
Few milliseconds after, a "reboot_processed_ok" file will be created. You can log out of your GW and move on to the next step. |
After few minutes
If the update failed, you will find information into the file: devices_updates_$DATE_ERROR.log
If the update success, the the devices configuration file is deleted and you will find the file: devices_updates_$DATE_SUCCESS.log
The devices current configuration of µWiotys is available in the directory: /uwiotys/current_config/
The file format is the same as the devices configuration file, it can be used to remove device for µWiotys config by simply changing "state" from "active" to "remove" for one or several devices and then follow the regular update procedure.
Modify/Delete your fleet
If you want to modify or delete sensors that added on µWiotys, please, follow these steps:
Delete :
With configurator
In the configurator you can select the action to Add/Delete a sensor →
Don’t forget to write all informations that you noticed in the current config of your GW.
When you generated the update file with deleted elements, push and reboot the GW like the process above.
In edit file directly
By retrieve the curent config file in /uwiotys/current_config/
Then Replace the field “state” by delete
Don’t forget to write all informations that you noticed in the current config of your GW.
You have to rename the update file with deleted elements (devices_update.json), push and reboot the GW like the process above.
Modify :
You have to Delete and Add again the update file to Modify a sensor (Modbus slave adress, reference…)
Output configuration
Configuration file
...
Field | Mandatory | description | Possible value |
|---|---|---|---|
http_data_server.active | yes | activation Activation status of the HTTP output, if activated all device data will be sent to HTTP server, if not no messages will be sent. This does impact modbus output | true / false |
http_data_server.url | yes | url Url of the external server, it must be accessible from the network of the GW | valid URL |
http_data_server.headers | yes | header Header information for the server | valid key / value list |
csv.active | yes | activation Activation status of the csv output, if activated all device data be stored in csv files. This does impact modbus output | true / false |
csv.nb_week | yes | Number of week the csv files will be keep. Be careful not to keep the files too long so as not to saturate the storage space | [1:52] |
mqtt.active | yes | activation Activation status of the mqtt output. This does impact modbus output | true / false |
mqtt.host | yes | External Mqtt Broker | valid host |
...
mqtt.topic | no | The topic to subscribe from the MQTT broker. By default the topic is #/DEVEUI | valid topic |
HTTP output support both http HTTP and https HTTPS protocols. Mqtt
MQTT output support both mqtt MQTT and mqtts MQTTS protocols.
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
IN both cases, auto signed certificate are not |
...
supported. |
File format
The file format should be as the following examples:
...
| Code Block | ||
|---|---|---|
| ||
{
"http_data_server": {
"active": false,
"url": "http://MyHTTPServer:8080",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJBTDBERmROLW1DNFpMTFJCVXh4OFdxN1RNZTVmQ3NNSE1FV1FsUklNYmRjIn"
}
},
"csv":{
"active": true,
"nb_week": 15
},
,
"mqtt":{
"active": true,
"host": "mqtt.uWiotys.io",
"port": 8883,
"topic": "MyTopic",
"login": "MyLogin",
"password": "MyPass",
"secure(TLS)": true
}
} |
Upload configuration
The new output configuration of µWiotys should be upload to the directory: /uwiotys/update_config/
...
Upload the configuration file
...
How to know if the product has a license
Logs can be :
"No license found, µWiotys will not start. Please configure a valid license for your µWiotys gateway XXXXXXXX"when NO license is present."The license is VALID. µWiotys will start."when the product Have HAS a license.
How to know the license's type and state
...
| Code Block | ||
|---|---|---|
| ||
License allow user to activate the following output:
Modbus output: true/false
Csv output: true/false
Http output: true/false
Mqtt output: true/false
Bacnet output: true/false |
Software Update
...