User Tools
wiki:local_ftp
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
wiki:local_ftp [2018/05/02 11:24] ghi old revision restored (2017/12/01 11:59) |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== 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. | ||
| - | |||
| - | {{ :images:localftpenable.png?400 |}} | ||
| - | |||
| - | <note important>In this page, “XXXXXX” are the 6 digits at the end of hostname/board id (upper case).</note> | ||
| - | |||
| - | ===== FTP Connection ===== | ||
| - | |||
| - | - Enable local FTP in the //Local FTP// tab under the //Services// menu. | ||
| - | - On your computer, launch a ftp client such as //FileZilla// or //WinSCP// to connect to the server. | ||
| - | - Use the address of home web interface: ''http://klk-wifc-XXXXXX/''. | ||
| - | - Use port **2222**. | ||
| - | - The login and password are the same than those of the web interface (default: ''spn'' / ''spnpwd''). | ||
| - | |||
| - | {{ :images:localftp_fillezilla.png?400 |}} | ||
| - | |||
| - | ===== FTP filesystem structure ===== | ||
| - | |||
| - | The FTP filesystem structure is the following: \\ | ||
| - | {{:images:localftpstructure.png?100|}} | ||
| - | ===== Send and receive data ===== | ||
| - | |||
| - | ==== RX data ==== | ||
| - | {{ :images:get_rx_data.png?150|}} | ||
| - | 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 ==== | ||
| - | {{ :images:add_tx_data.png?150|}} | ||
| - | 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: | ||
| - | |||
| - | - 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 [[wiki:data_transmission#drag_and_drop_a_csv_file|web interface]]. Put this file first on the server. | ||
| - | - 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 ==== | ||
| - | {{ :images:localftp_getconfig.png?150|}} | ||
| - | 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 ==== | ||
| - | {{ :images:localftp_setconfig.png?150|}} | ||
| - | The process is triggered by putting 2 files in the ''configuration'' folder on the FTP server: | ||
| - | |||
| - | - 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]]. Put this file first on the server. | ||
| - | - 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 ==== | ||
| - | {{ :images:localftp_getfleet.png?150|}} | ||
| - | 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 ==== | ||
| - | {{ :images:localftp_addfleet.png?150}} | ||
| - | The process is triggered by putting 2 files in the ''fleet'' folder on the FTP server: | ||
| - | |||
| - | - 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]]. Put this file first on the server. | ||
| - | - 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 ==== | ||
| - | {{ :images:localftpupdate.png?150|}} | ||
| - | The process is triggered by putting 2 files in the ''update'' folder on the FTP server: | ||
| - | - keros_X.X.X-spn_klk-wifc.ipk file available in the [[wiki:resources#spn_firmware_to_install_spn|resources]] page. Put this file first on the server. | ||
| - | - 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 | ||
| - | |||
| - | <note important> | ||
| - | You will need an access to web interface to enable the FTP server and put your license file. | ||
| - | </note> | ||
| - | |||
| - | ==== Reboot ==== | ||
| - | {{ :images:localftpreboot.png?150|}} | ||
| - | 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 ===== | ||
| - | {{ :images:localftp_log.png?150|}} | ||
| - | 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.1525253060.txt.gz · Last modified: 2020/02/21 11:53 (external edit)
Page Tools
