Differences

This shows you the differences between two versions of the page.

--- wiki:interfaces:usbut [2020/03/13 15:38]
ghi created
+++ wiki:interfaces:usbut [2023/01/12 10:17] (current)
ehe [Add the files]
@@ Line 21: / Line 21: @@
 To activate USB key features, a USB folder tree must be used. When all the features are available, the structure is: \\
 {{.:..:images:usbut_tree.png?150|USB tree}}
+__Download USB_Structure.zip:__\\
+{{media:script:USB_Structure.zip}} .
 ==== Add the password file ====
-On USB key root directory, create a file “spn/password/XXXXXXXX_password” which must contain “spn” user password.
+On USB key root directory, create a file “spn/password/XXXXXXXX_password” which must contain “spn” user password. \\
 {{.:..:images:usbut_password.png?400|How to set USB password}}
 ==== 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 wich 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 ====
@@ Line 47: / Line 56: @@
 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.
@@ Line 57: / Line 64: @@
   - *XXXXXXXX:* gateway serial number in upper case.
-**LED behaviour**:
+=== LED behaviour ===
 . No USB key plugged: red power LED is off.
 . USB key plugged, USB commands are being processed: red power LED is blinking at 10Hz.
@@ Line 63: / Line 70: @@
 . 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.
-**Add end-device fleet:**
+== Add end-device fleet ==
 - Create a CSV file **XXXXXXXX_end_device_fleet.csv**.
@@ Line 81: / Line 88: @@
 > **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**.
@@ Line 91: / Line 98: @@
 > 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**.
@@ Line 100: / Line 107: @@
 > 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.
-**Add gateway fleet:**
+== Add gateway fleet ==
 - Create a CSV file **XXXXXXXX_gateway_fleet.csv**.
@@ Line 115: / Line 122: @@
 > 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**.
@@ Line 126: / Line 133: @@
 > **XXXXXXXX_gateway_fleet.csv** will be erased once command processed.
-**Delete gateway fleet:**
+== Delete gateway fleet ==
 - Command triggered with a file **delete_fleet**.
@@ Line 135: / Line 142: @@
 > 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.
-**Get Rx data:**
+== Get Rx data ==
 - Command triggered with a file **get_rx_data**.
@@ Line 156: / 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.
-## Tx data flow
+=== Tx data flow ===
 **/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**.
@@ Line 171: / 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.
-**Get Tx data:**
+== Get Tx data ==
 - Command triggered with a file **get_tx_data**.
@@ Line 188: / 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.
-## Configuration flow
+=== Configuration flow ===
 **/spn/configuration** directory must be created and used for the configuration commands.
-**Set configuration:**
+== Set configuration ==
 - Create a JSON file **XXXXXXXX_data.json**.
@@ Line 203: / Line 210: @@
 > 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**.
@@ Line 214: / Line 221: @@
 > **XXXXXXXX_data.json** will be erased once command processed.
-**Reset configuration:**
+== Reset configuration ==
 - Command triggered with a file **reset_configuration**.
@@ Line 223: / Line 230: @@
 > 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.
-**Update:**
+== Update ==
 - Copy an ***.ipk** file.
@@ Line 237: / Line 244: @@
 > 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**.
@@ Line 247: / Line 254: @@
 > 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**.
@@ Line 256: / Line 263: @@
 > 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**.
@@ Line 265: / Line 272: @@
 > 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**.
@@ Line 274: / Line 281: @@
 > 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.
-**Get status:**
+== Get status ==
 - Command triggered with a file **get_status**.
@@ Line 296: / Line 303: @@
 > **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.
-**Get log:**
+==Get log==
 - Command triggered with a file **get_log**.
@@ Line 309: / Line 316: @@
 > Command **get_log** is processed if **XXXXXXXX_get_log_processed_yy** does not exist and each time the command file is edited.
-</markdown>
-</hidden>

Wanesy™ SPN (End Of Life)

User Tools

Site Tools

Differences

Page Tools