User Tools
wiki:sms_service
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
wiki:sms_service [2020/03/16 14:16] ghi removed |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== SMS interface ====== | ||
| - | |||
| - | ===== Introduction ===== | ||
| - | |||
| - | An SMS interface is available on SPN gateways. It can be used to: | ||
| - | |||
| - | * Configure the gateway. | ||
| - | * Configure the end-devices fleet. | ||
| - | * Configure the gateways fleet. | ||
| - | * Add license. | ||
| - | * Debug / troubleshoot the gateway. | ||
| - | |||
| - | ===== SMS Command - Syntax ===== | ||
| - | |||
| - | The command syntax is also described in the web interface under the //Help// section in the //SMS utils// tab from the //interface// menu. | ||
| - | |||
| - | ==== SMS request ==== | ||
| - | <code>[spn:spnpwd] [cmdid1] flow/command</code> | ||
| - | ''spn'': SPN user, always spn.\\ | ||
| - | ''spnpwd'': SPN password.\\ | ||
| - | ''cmdid1'': command identifier used for response. Must be alphanumeric characters in lower case, 6 digits.\\ | ||
| - | ''flow'': group of command (end_device, gateway, rx_data, tx_data, configuration, update or status).\\ | ||
| - | ''command'': command to run, depending on flow.\\ | ||
| - | |||
| - | ==== SMS answer ==== | ||
| - | |||
| - | ==== Correct request: ==== | ||
| - | |||
| - | <code>[cmdid1:ok] answer</code> | ||
| - | ''cmdid1'': command identifier passed in request.\\ | ||
| - | ''answer'': the answer of the request, format depends on the request. | ||
| - | |||
| - | ==== Incorrect request: ==== | ||
| - | |||
| - | <code>[cmdid1:error] error message</code> | ||
| - | ''cmdid1'': command identifier passed in request.\\ | ||
| - | ''error message'': error message indicating what goes wrong. | ||
| - | |||
| - | ===== SMS features ===== | ||
| - | |||
| - | Before starting to work with the SMS manager, make sure to: | ||
| - | * For iFemtocell: plug an USB GSM dongle. | ||
| - | * Retrieve the SIM phone number used by the USB GSM Dongle. | ||
| - | |||
| - | ==== End-device fleet flow ==== | ||
| - | === Add ABP end-device: === | ||
| - | |||
| - | <code>[spn:spnpwd] [endadd] end_device/add_end_device end_device_csv</code> | ||
| - | ''end_device_csv'': syntax can be retrieved by downloading the template from the web interface.\\ | ||
| - | __Example:__ | ||
| - | |||
| - | <code>[spn:spnpwd] [endadd] end_device/add_end_device ABP,C,,,,11223344,11112222333344445555666677778888,11112222333344445555666677778888,255,869525000,0</code> | ||
| - | |||
| - | === Add OTAA end-device: === | ||
| - | |||
| - | <code>[spn:spnpwd] [endadd] end_device/add_end_device end_device_csv</code> | ||
| - | ''end_device_csv'': syntax can be retrieved by downloading the template from the web interface.\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [endadd] end_device/add_end_device OTAA,C,1122334455667788,1122334455667788,11112222333344445555666677778888,,,,255,869525000,0</code> | ||
| - | |||
| - | === Delete ABP end-device: === | ||
| - | |||
| - | <code>[spn:spnpwd] [enddel] end_device/delete_end_device dev_addr</code> | ||
| - | ''dev_addr'': ABP device address (8 hexadecimal digits in upper case).\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [enddel] end_device/delete_end_device 11223344</code> | ||
| - | |||
| - | === Delete OTAA end-device: === | ||
| - | |||
| - | <code>[spn:spnpwd] [enddel] end_device/delete_end_device dev_eui</code> | ||
| - | ''dev_eui'': OTAA device EUI (16 hexadecimal digits in upper case).\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [enddel] end_device/delete_end_device 1122334455667788</code> | ||
| - | |||
| - | === Delete end-device fleet: === | ||
| - | |||
| - | <code>[spn:spnpwd] [enddef] end_device/delete_fleet</code> | ||
| - | |||
| - | === Gateway fleet flow === | ||
| - | === Add gateway: === | ||
| - | |||
| - | <code>[spn:spnpwd] [gatadd] gateway/add_gateway gateway_csv</code> | ||
| - | ''gateway_csv'': syntax can be retrieved by downloading the template from the web interface.\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [gatadd] gateway/add_gateway 7276FF0039020003</code> | ||
| - | === Delete gateway: === | ||
| - | |||
| - | <code>[spn:spnpwd] [gatdel] gateway/delete_gateway gateway_id</code> | ||
| - | ''gateway_id'': gateway identifier (16 hexadecimal digits in upper case).\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [gatdel] gateway/delete_gateway 7276FF0039020003</code> | ||
| - | === Delete gateway fleet: === | ||
| - | |||
| - | <code>[spn:spnpwd] [gatdef] gateway/delete_fleet</code> | ||
| - | |||
| - | ==== Rx data flow ==== | ||
| - | === Get Rx data from ABP end-device: === | ||
| - | |||
| - | <code>[spn:spnpwd] [rxdget] rx_data/get_rx_data dev_addr</code> | ||
| - | ''dev_addr'': ABP device address (8 hexadecimal digits in upper case).\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [rxdget] rx_data/get_rx_data 11223344</code> | ||
| - | SMS answer contains Rx data in CSV, syntax can be retrieved by downloading the template from the web interface.\\ | ||
| - | |||
| - | === Get Rx data from OTAA end-device: === | ||
| - | |||
| - | <code>[spn:spnpwd] [rxdget] rx_data/get_rx_data dev_eui</code> | ||
| - | ''dev_eui'': OTAA device EUI (16 hexadecimal digits in upper case).\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [rxdget] rx_data/get_rx_data 1122334455667788</code> | ||
| - | SMS answer contains Rx data in CSV, syntax can be retrieved by downloading the template from the web interface.\\ | ||
| - | |||
| - | ==== Tx data flow ==== | ||
| - | === Add Tx data to ABP or OTAA end-device: === | ||
| - | |||
| - | <code>[spn:spnpwd] [txdadd] tx_data/add_tx_data tx_data_csv</code> | ||
| - | ''tx_data_csv'': syntax is described through DOWNLOAD button.\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [txdadd] tx_data/add_tx_data 11223344,2,true,5,MDAyN2JkMDlkMGZlOWMzYTAwMDAwMDAwMDAwMGZmZmY=</code> | ||
| - | |||
| - | ==== Configuration flow ==== | ||
| - | Whole configuration is described can be retrieved by downloading the template from the web interface. | ||
| - | |||
| - | Sample of configuration file: | ||
| - | |||
| - | <code> | ||
| - | { | ||
| - | "body": { | ||
| - | "public": { | ||
| - | "loftp": { | ||
| - | "enable": false | ||
| - | } | ||
| - | } | ||
| - | } | ||
| - | } | ||
| - | </code> | ||
| - | |||
| - | In this sample, parameter path is loftp.enable. | ||
| - | |||
| - | === Get parameter: === | ||
| - | |||
| - | <code>[spn:spnpwd] [conget] configuration/get_value parameter_path</code> | ||
| - | ''parameter_path'': parameter path.\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [conget] configuration/get_value loftp.enable</code> | ||
| - | |||
| - | === Set boolean parameter: === | ||
| - | |||
| - | <code>[spn:spnpwd] [coset1] configuration/set_value boolean_parameter_path value</code> | ||
| - | ''boolean_parameter_path'': boolean parameter path.\\ | ||
| - | ''value'': true of false.\\ | ||
| - | __Example:__\\ | ||
| - | |||
| - | <code>[spn:spnpwd] [coset1] configuration/set_value loftp.enable true</code> | ||
| - | |||
| - | === Set number parameter: === | ||
| - | |||
| - | <code>[spn:spnpwd] [coset1] configuration/set_value number_parameter_path value</code> | ||
| - | ''number_parameter_path'': number parameter path.\\ | ||
| - | ''value'': a number.\\ | ||
| - | __Example:__ | ||
| - | |||
| - | <code>[spn:spnpwd] [coset2] configuration/set_value csvlo.rotation_count 55</code> | ||
| - | |||
| - | === Set string parameter === | ||
| - | |||
| - | <code>[spn:spnpwd] [coset1] configuration/set_value string_parameter_path value</code> | ||
| - | ''string_parameter_path'': string parameter path.\\ | ||
| - | ''value'': a string in double quotes.\\ | ||
| - | |||
| - | __Example:__ | ||
| - | |||
| - | <code>[spn:spnpwd] [coset3] configuration/set_value csvlo.rotation_time "hour"</code> | ||
| - | |||
| - | === Reset configuration: === | ||
| - | |||
| - | <code>[spn:spnpwd] [conres] configuration/reset</code> | ||
| - | |||
| - | ==== Update flow ==== | ||
| - | === Add license: === | ||
| - | |||
| - | <code>[spn:spnpwd] [updadd] update/add_license license_content</code> | ||
| - | ''license_content'': content of license file provided.\\ | ||
| - | __Example:__ | ||
| - | |||
| - | <code>[spn:spnpwd] [updadd] update/add_license -----BEGIN SIGNATURE-----\nsmzmFH2J/tRteB62kkush427wKKE/ahM1ojCZukDlE2lGrR28QxPtKlBhoR9p0nc\nwm8uk1xFBlgj+x/1TmkxaRIkXJkQTqkUbvzsoe4omcPvgfjfTu3FiAiN3NkixCHw\nh6ehOilCNQvCiKTe8kWaO/Bx+jX+Pt4kmdpTMMch02dxisCNobAqPbzRq31ElH81\naa9nUgrcA4iqett5AowAcKfIPHIo6hTHvlGnmOhA7vN7IN9vdgtvTDEFclwxfbmU\nPqmqOVlXHfaaLV/Crn/R7wfkKjOPmEp3vaK0u2GkELzw0sQUzpkEMhJF2sN67ovd\ntDFUCNi54R5ziCmLMvko2A==\n-----END SIGNATURE-----\n-----BEGIN ICENSE-----\n[license]\nhardware_serial_number = 3903001D\nexpiration_date = 1540123200\ngateways_max_number = 10\nend_devices_max_number = 0\n-----END LICENSE-----</code> | ||
| - | |||
| - | === Restore: === | ||
| - | |||
| - | <code>[spn:spnpwd] [updres] update/restore</code> | ||
| - | |||
| - | === Reboot: === | ||
| - | |||
| - | <code>[spn:spnpwd] [updreb] update/reboot</code> | ||
| - | |||
| - | === Halt: === | ||
| - | |||
| - | <code>[spn:spnpwd] [updhal] update/halt</code> | ||
| - | |||
| - | ==== Status flow ==== | ||
| - | === Get status: === | ||
| - | |||
| - | <code>[spn:spnpwd] [staget] status/get_status</code> | ||
| - | SMS answer contains status in CSV, syntax can be retrieved by downloading the template from the web interface. | ||
| - | |||
wiki/sms_service.1584364614.txt.gz · Last modified: 2020/03/16 14:16 by ghi
Page Tools
