Wanesy™ SPN (End Of Life)

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== USB service for firmware 1.1.1 ======

===== Introduction ===== 
A USB key service is available on the SPN gateway. It can be used to:

      * Configure the gateway.
      * Configure the end-devices fleet.
      * Receive frames from end-devices.
      * Debug / troubleshoot the gateway.

===== Instruction =====

<note important>In this page, “XXXXXX” represent the __6__ digits at the end of hostname/board id (upper case).
</note>

==== Create the USB folder structure ====

In order to activate the USB key features a USB folder structure must be respected. When all the features are available, the structure is: \\
{{ :images:usb_folder_structure.png?150 |}}

==== Add the password file ====

On USB key root directory, create a file “spn/XXXXXX_password” which must contain “spn” user password.
{{ :images:usb_add_password.png?300 |}}

==== 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.

==== Plug the USB key ====

Once the folders, the feature specific files and the password files are created, the USB key can be plugged.
During the execution of the USB key the led behavior of the iFemtoCell is the following:

  - The power LED is lit solid red during USB commands processing.
  - Once all commands are processed, the LED is blinking fast from green to red. The USB key can be removed.
  - Once the USB key is unplugged, the LED is lit solid green.

<note warning>This behavior is not yet correctly implemented on v1.1.1. Once the USB key is unplugged, the red LED is kept switched on.</note>
<note warning>On **iFemtoCell 923**, this behavior is not implemented on SPN v1.x. Once the USB key is plugged, there is no modification of the LED status.</note>

===== USB features =====

==== RX data ====

Retrieve RX data process needs to be triggered by the user. The process is triggered by putting an empty file ''get_rx_data'' in the rx_data folder. \\
It will create a file ''rx_data/XXXXXX_get_rx_data_processed'' once the request is taken into account. \\
The request only works if file ''rx_data/XXXXXX_get_rx_data_processed'' does not exist. \\

==== Configure the gateway ====

Set/Get gateway configuration process needs to be triggered by the user. \\

=== Get configuration ===

The process is triggered by putting an empty file ''get_configuration'' in the configuration folder. \\
It will create a file ''configuration/XXXXXX_get_configuration_processed'' once the request is taken into account. \\
The request only works if file ''configuration/XXXXXX_get_configuration_processed'' does not exist. \\

=== Set configuration ===

The process is triggered by putting 2 files in the configuration folder:
 
  - A CSV file named ''XXXXXX_data.json''. The file contents the gateway configuration. More information on the file format is available [[wiki:data_json|here]].
  - An empty file ''set_configuration''.

It will create a file ''configuration/XXXXXX_set_configuration_processed'' once the request is taken into account. \\
The request only works if file ''configuration/XXXXXX_set_configuration_processed'' does not exist. \\

==== Manage the fleet ====

Manage fleet process need to be triggered by the user. \\

=== Get fleet ===

The process is triggered by putting an empty file ''get_fleet'' in the fleet folder. \\
It will create a file ''fleet/XXXXXX_get_fleet_processed'' once the request is taken into account. \\
The request only works if file ''fleet/XXXXXX_get_fleet_processed'' does not exist. \\

=== Add fleet ===

The process is triggered by putting 2 files in the fleet folder:

  - A CSV file named ''XXXXXX_fleet.csv''. The file contents the fleet description. More information on the file format is available [[wiki:gateway_configuration##import_a_fleet_with_a_csv_file|here]].
  - An empty file ''add_fleet''. 

It will create a file ''fleet/XXXXXX_set_fleet_processed'' once the request is taken into account. \\
The request only works if file ''fleet/XXXXXX_set_fleet_processed'' does not exist. \\

==== Update the gateway ====

Update folder allows users to update the gateway software, restore the software to the default configuration and reboot the gateway.
These processes need to be triggered by the user. \\

=== Update ===

The process is triggered by putting 2 files in the update folder:
  - keros_X.X.X-spn_klk-wifc.ipk file available in the [[wiki:resources|resources]] page.
  - An empty file ''update''.

It will create a file ''update/XXXXXX_update_processed'' once the request is taken into account. \\
The request only works if file ''update/XXXXXX_update_processed'' does not exist. \\
Update will be taken into account after a reboot.

=== Restore ===

The process is triggered by putting an empty file ''restore'' in the update folder. \\
It will create a file ''update/XXXXXX_restore_processed'' once the request is taken into account. \\
The request only works if file ''update/XXXXXX_restore_processed'' does not exist. \\
Restore will be taken into account after a reboot.

<note important>
You will need an access to web interface to put your license file.
</note>

=== Reboot ===

The process is triggered by putting an empty file ''reboot'' in the update folder. \\
It will create a file ''update/XXXXXX_reboot_processed'' once the request is taken into account. \\
The request only works if file ''update/XXXXXX_reboot_processed'' does not exist. \\

==== Logs ==== 

The process is triggered by putting an empty file ''get_log'' in the configuration folder. \\
It will create a file ''log/XXXXXX_get_log_processed'' once the request is taken into account. \\
The request only works if file ''log/XXXXXX_get_log_processed'' does not exist. \\
Wanesy™ SPN (End Of Life)

User Tools

Site Tools

Page Tools
