User Tools

Site Tools


wiki:local_ftp

This is an old revision of the document!


Local FTP

Introduction

An sFTP server is installed on the gateway. It can be used to:

  • Configure the station.
  • Configure the end-devices fleet.
  • Receive frames from end-devices.
  • Transmit frames to end-devices.
  • Debug / troubleshoot the station.

Its configuration is available in the Local FTP tab under the Services menu.

In this page, “XXXXXX” are the 6 digits at the end of hostname/board id (upper case).

FTP Connection

  1. Enable local FTP in the Local FTP tab under the Services menu.
  2. On your computer, launch a ftp client such as FileZilla or WinSCP to connect to the server.
  3. Use the address of home web interface: http://klk-wifc-XXXXXX/.
  4. Use port 2222.
  5. The login and password are the same than those of the web interface (default: spn / spnpwd).

FTP filesystem structure

The FTP filesystem structure is the following:

Send and receive data

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 on the FTP server.
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.

TX data

Send TX data process needs to be triggered by the user. The process is triggered by putting 2 files in the tx_data folder on the FTP server:

  1. A CSV file named XXXXXX_tx_data.csv. The file contents the datas to be transmit. The CSV file format is the same than those used by web interface. Put this file first on the server.
  2. An empty file add_tx_data.

It will create a file tx_data/XXXXXX_add_tx_data_processed once the request is taken into account.
The request only works if file tx_data/XXXXXX_add_tx_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 on the FTP server.
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 on the FTP server:

  1. A CSV file named XXXXXX_data.json. The file contents the gateway configuration. More information on the file format is available here. Put this file first on the server.
  2. 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. Put this file first on the server.

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 on the FTP server.
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 on the FTP server:

  1. A CSV file named XXXXXX_fleet.csv. The file contents the fleet description. More information on the file format is available here. Put this file first on the server.
  2. 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 FTP 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 on the FTP server:

  1. keros_X.X.X-spn_klk-wifc.ipk file available in the resources page. Put this file first on the server.
  2. 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 on the FTP server.
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

You will need an access to web interface to enable the FTP server and put your license file.

Reboot

The process is triggered by putting an empty file reboot in the update folder on the FTP server.
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 on the FTP server.
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.

wiki/local_ftp.1512119913.txt.gz · Last modified: 2020/02/21 11:53 (external edit)