User Tools
wiki:interfaces:usbut
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
wiki:interfaces:usbut [2022/07/07 12:08] mbi [Create the USB folder structure] |
wiki:interfaces:usbut [2023/01/12 10:17] (current) ehe [Add the files] |
||
|---|---|---|---|
| Line 39: | Line 39: | ||
| ==== Add the files ==== | ==== Add the files ==== | ||
| - | Depending on the feature that will be used, different files must be created/added in the folders. Refer to the USB features section to determine which file should be added in which folder. | + | Depending on the feature that will be used, different files must be created/added in the folders. Refer to the [[https://wikikerlink.fr/wanesy-spn/doku.php?id=wiki:interfaces:usbut#help|USB features section]] to determine which file should be added in which folder. |
| ==== Plug the USB key ==== | ==== Plug the USB key ==== | ||
| Line 56: | Line 56: | ||
| An extract of this help is available below: | An extract of this help is available below: | ||
| - | <hidden> | + | ==== Common parameters ==== |
| - | <markdown> | + | |
| - | # Common parameters | + | |
| This service is used to access flows via a USB key and is always enabled. | This service is used to access flows via a USB key and is always enabled. | ||
| Line 66: | Line 64: | ||
| - *XXXXXXXX:* gateway serial number in upper case. | - *XXXXXXXX:* gateway serial number in upper case. | ||
| - | **LED behaviour**: | + | === LED behaviour === |
| 1. No USB key plugged: red power LED is off. | 1. No USB key plugged: red power LED is off. | ||
| 2. USB key plugged, USB commands are being processed: red power LED is blinking at 10Hz. | 2. USB key plugged, USB commands are being processed: red power LED is blinking at 10Hz. | ||
| Line 72: | Line 70: | ||
| 4. Unplug USB key, red power LED is off. | 4. Unplug USB key, red power LED is off. | ||
| - | # Flow syntax | + | ==== Flow syntax ==== |
| - | ## End-device fleet flow | + | === End-device fleet flow === |
| **/spn/end_device** directory must be created and used for the end-device fleet commands. | **/spn/end_device** directory must be created and used for the end-device fleet commands. | ||
| - | **Add end-device fleet:** | + | == Add end-device fleet == |
| - Create a CSV file **XXXXXXXX_end_device_fleet.csv**. | - Create a CSV file **XXXXXXXX_end_device_fleet.csv**. | ||
| Line 90: | Line 88: | ||
| > **XXXXXXXX_end_device_fleet.csv** will be erased once command processed. | > **XXXXXXXX_end_device_fleet.csv** will be erased once command processed. | ||
| - | **Get end-device fleet:** | + | == Get end-device fleet == |
| - Command triggered with a file **get_fleet**. | - Command triggered with a file **get_fleet**. | ||
| Line 100: | Line 98: | ||
| > Command **get_fleet** is processed if **XXXXXXXX_get_fleet_processed_yy** does not exist and each time the command file is edited. | > Command **get_fleet** is processed if **XXXXXXXX_get_fleet_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Delete end-device fleet:** | + | == Delete end-device fleet == |
| - Command triggered with a file **delete_fleet**. | - Command triggered with a file **delete_fleet**. | ||
| Line 109: | Line 107: | ||
| > Command **delete_fleet** is processed if **XXXXXXXX_delete_fleet_processed_yy** does not exist and each time the command file is edited. | > Command **delete_fleet** is processed if **XXXXXXXX_delete_fleet_processed_yy** does not exist and each time the command file is edited. | ||
| - | ## Gateway fleet flow | + | === Gateway fleet flow === |
| **/spn/gateway** directory must be created and used for the gateway fleet commands. | **/spn/gateway** directory must be created and used for the gateway fleet commands. | ||
| - | **Add gateway fleet:** | + | == Add gateway fleet == |
| - Create a CSV file **XXXXXXXX_gateway_fleet.csv**. | - Create a CSV file **XXXXXXXX_gateway_fleet.csv**. | ||
| Line 124: | Line 122: | ||
| > Command **add_fleet** is processed if **XXXXXXXX_add_fleet_processed_yy** does not exist and each time the command file is edited. | > Command **add_fleet** is processed if **XXXXXXXX_add_fleet_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Get gateway fleet:** | + | == Get gateway fleet == |
| - Command triggered with a file **get_fleet**. | - Command triggered with a file **get_fleet**. | ||
| Line 135: | Line 133: | ||
| > **XXXXXXXX_gateway_fleet.csv** will be erased once command processed. | > **XXXXXXXX_gateway_fleet.csv** will be erased once command processed. | ||
| - | **Delete gateway fleet:** | + | == Delete gateway fleet == |
| - Command triggered with a file **delete_fleet**. | - Command triggered with a file **delete_fleet**. | ||
| Line 144: | Line 142: | ||
| > Command **delete_fleet** is processed if **XXXXXXXX_delete_fleet_processed_yy** does not exist and each time the command file is edited. | > Command **delete_fleet** is processed if **XXXXXXXX_delete_fleet_processed_yy** does not exist and each time the command file is edited. | ||
| - | ## Rx data flow | + | === Rx data flow === |
| **/spn/rx_data** directory must be created and used for the Rx data commands. | **/spn/rx_data** directory must be created and used for the Rx data commands. | ||
| - | **Get Rx data:** | + | == Get Rx data == |
| - Command triggered with a file **get_rx_data**. | - Command triggered with a file **get_rx_data**. | ||
| Line 165: | Line 163: | ||
| > Command **get_rx_data** is processed if **XXXXXXXX_get_rx_data_processed_yy** does not exist and each time the command file is edited. | > Command **get_rx_data** is processed if **XXXXXXXX_get_rx_data_processed_yy** does not exist and each time the command file is edited. | ||
| - | ## Tx data flow | + | === Tx data flow === |
| **/spn/tx_data** directory must be created and used for the Tx data commands. | **/spn/tx_data** directory must be created and used for the Tx data commands. | ||
| - | **Add Tx data:** | + | == Add Tx data == |
| - Create a CSV file **XXXXXXXX_tx_data.csv**. | - Create a CSV file **XXXXXXXX_tx_data.csv**. | ||
| Line 180: | Line 178: | ||
| > Command **add_tx_data** is processed if **XXXXXXXX_add_tx_data_processed_yy** does not exist and each time the command file is edited. | > Command **add_tx_data** is processed if **XXXXXXXX_add_tx_data_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Get Tx data:** | + | == Get Tx data == |
| - Command triggered with a file **get_tx_data**. | - Command triggered with a file **get_tx_data**. | ||
| Line 197: | Line 195: | ||
| > Command **get_tx_data** is processed if **XXXXXXXX_get_tx_data_processed_yy** does not exist and each time the command file is edited. | > Command **get_tx_data** is processed if **XXXXXXXX_get_tx_data_processed_yy** does not exist and each time the command file is edited. | ||
| - | ## Configuration flow | + | === Configuration flow === |
| **/spn/configuration** directory must be created and used for the configuration commands. | **/spn/configuration** directory must be created and used for the configuration commands. | ||
| - | **Set configuration:** | + | == Set configuration == |
| - Create a JSON file **XXXXXXXX_data.json**. | - Create a JSON file **XXXXXXXX_data.json**. | ||
| Line 212: | Line 210: | ||
| > Command **set_configuration** is processed if **XXXXXXXX_set_configuration_processed_yy** does not exist and each time the command file is edited. | > Command **set_configuration** is processed if **XXXXXXXX_set_configuration_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Get configuration:** | + | == Get configuration == |
| - Command triggered with a file **get_configuration**. | - Command triggered with a file **get_configuration**. | ||
| Line 223: | Line 221: | ||
| > **XXXXXXXX_data.json** will be erased once command processed. | > **XXXXXXXX_data.json** will be erased once command processed. | ||
| - | **Reset configuration:** | + | == Reset configuration == |
| - Command triggered with a file **reset_configuration**. | - Command triggered with a file **reset_configuration**. | ||
| Line 232: | Line 230: | ||
| > Command **reset_configuration** is processed if **XXXXXXXX_reset_configuration_processed_yy** does not exist and each time the command file is edited. | > Command **reset_configuration** is processed if **XXXXXXXX_reset_configuration_processed_yy** does not exist and each time the command file is edited. | ||
| - | ## Update flow | + | === Update flow === |
| **/spn/update** directory must be created and used for the update commands. | **/spn/update** directory must be created and used for the update commands. | ||
| - | **Update:** | + | == Update == |
| - Copy an ***.ipk** file. | - Copy an ***.ipk** file. | ||
| Line 246: | Line 244: | ||
| > Command **update** is processed if **XXXXXXXX_update_processed_yy** does not exist and each time the command file is edited. | > Command **update** is processed if **XXXXXXXX_update_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Add license:** | + | == Add license == |
| - Copy a license file **XXXXXXXX_license.txt**. | - Copy a license file **XXXXXXXX_license.txt**. | ||
| Line 256: | Line 254: | ||
| > Command **add_license** is processed if **XXXXXXXX_add_license_processed_yy** does not exist and each time the command file is edited. | > Command **add_license** is processed if **XXXXXXXX_add_license_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Restore:** | + | == Restore == |
| - Command triggered with a file **restore**. | - Command triggered with a file **restore**. | ||
| Line 265: | Line 263: | ||
| > Command **restore** is processed if **XXXXXXXX_restore_processed_yy** does not exist and each time the command file is edited. | > Command **restore** is processed if **XXXXXXXX_restore_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Reboot:** | + | == Reboot == |
| - Command triggered with a file **reboot**. | - Command triggered with a file **reboot**. | ||
| Line 274: | Line 272: | ||
| > Command **reboot** is processed if **XXXXXXXX_reboot_processed_yy** does not exist and each time the command file is edited. | > Command **reboot** is processed if **XXXXXXXX_reboot_processed_yy** does not exist and each time the command file is edited. | ||
| - | **Halt:** | + | == Halt == |
| - Command triggered with a file **halt**. | - Command triggered with a file **halt**. | ||
| Line 283: | Line 281: | ||
| > Command **halt** is processed if **XXXXXXXX_halt_processed_yy** does not exist and each time the command file is edited. | > Command **halt** is processed if **XXXXXXXX_halt_processed_yy** does not exist and each time the command file is edited. | ||
| - | ## Status flow | + | === Status flow === |
| **/spn/status** directory must be created and used for the status commands. | **/spn/status** directory must be created and used for the status commands. | ||
| - | **Get status:** | + | == Get status == |
| - Command triggered with a file **get_status**. | - Command triggered with a file **get_status**. | ||
| Line 305: | Line 303: | ||
| > **XXXXXXXX_status.csv** will be erased once command processed. | > **XXXXXXXX_status.csv** will be erased once command processed. | ||
| - | ## Log flow | + | === Log flow === |
| **/spn/log** directory must be created and used for the log commands. | **/spn/log** directory must be created and used for the log commands. | ||
| - | **Get log:** | + | ==Get log== |
| - Command triggered with a file **get_log**. | - Command triggered with a file **get_log**. | ||
| Line 318: | Line 316: | ||
| > Command **get_log** is processed if **XXXXXXXX_get_log_processed_yy** does not exist and each time the command file is edited. | > Command **get_log** is processed if **XXXXXXXX_get_log_processed_yy** does not exist and each time the command file is edited. | ||
| - | </markdown> | ||
| - | </hidden> | ||
wiki/interfaces/usbut.1657188503.txt.gz · Last modified: 2022/07/07 12:08 by mbi
Page Tools
