User Tools
wiki:data_json
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
wiki:data_json [2020/03/16 14:14] ghi removed |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Data JSON file ====== | ||
| - | ===== Introduction ===== | ||
| - | |||
| - | This file contains the configuration of the gateway (except the fleet configuration).\\ | ||
| - | When this file is uploaded, the station parses it and replaces the configuration of the gateway with the one described in the file. If the syntax or one field of the file is not correct, then the entire file is ignored.\\ | ||
| - | It is not necessary to use every field in the file at once. | ||
| - | |||
| - | The following example shows a fully functioning file that only configures the received data backup parameters. | ||
| - | |||
| - | <code json XXXXXX_data.json> | ||
| - | { | ||
| - | "body": { | ||
| - | "public": { | ||
| - | "csvlo": { | ||
| - | "rotation_time": "hour", | ||
| - | "rotation_count": 50 | ||
| - | } | ||
| - | } | ||
| - | } | ||
| - | } | ||
| - | </code> | ||
| - | |||
| - | The configuration file can be downloaded/uploaded thanks to: | ||
| - | * The web interface. | ||
| - | * The USB service. | ||
| - | * The Local FTP service. | ||
| - | * The HTTP REST API service. | ||
| - | |||
| - | ===== Fields description ===== | ||
| - | |||
| - | ==== ''loftp'': Local FTP configuration ==== | ||
| - | * ''enable'': boolean. Local FTP activation. | ||
| - | |||
| - | ==== ''csvlo'': CSV files management ==== | ||
| - | * ''rotation_time'': string "hour" or "day" or "week" or "month". Rotation time of CSV rx data files. | ||
| - | * ''rotation_count'': integer from 1 to 100. Maximum number of files saved. | ||
| - | |||
| - | ==== ''rhttp'': Remote HTTP configuration ==== | ||
| - | * ''enable'': boolean. Remote HTTP activation. | ||
| - | * ''secure'': boolean. False: http / True: https. | ||
| - | * ''host'': string. Hostname or IP address. | ||
| - | * ''port'': integer. Port used. | ||
| - | * ''path'': string. Path (must start and end with "/"). | ||
| - | |||
| - | ==== ''reftp'': Remote FTP configuration ==== | ||
| - | * ''enable'': boolean. Remote FTP activation. | ||
| - | * ''user'': string. User. | ||
| - | * ''password'': string. Password. | ||
| - | * ''host'': string. Hostname or IP address. | ||
| - | * ''port'': integer. Port used. | ||
| - | * ''path'': string. Path (must start and end with "/"). | ||
| - | |||
| - | ==== ''smsma'': SMS interface configuration ==== | ||
| - | |||
| - | * "enable": boolean. SMS interface activation. | ||
| - | |||
| - | ==== ''region_specific'': Region configuration ==== | ||
| - | * ''region'': integer. | ||
| - | * 0: none | ||
| - | * 1: Europe | ||
| - | * 2: Asia | ||
| - | * 3: Australia | ||
| - | * 4: Korea | ||
| - | * 5: Japan | ||
| - | * 6: America | ||
| - | |||
| - | ==== ''lora_network'' ==== | ||
| - | * ''nwk_id'': integer from 0 to 127. LoRa Network ID. | ||
| - | |||
| - | ==== ''rx_rf'': LoRa RX configuration ==== | ||
| - | |||
| - | The RX frequencies configuration is explained [[wiki:gateway_configuration:#rx_configuration|here]]. | ||
| - | | ||
| - | {{ :wiki:typical_rx_config_v1.0.png?900 |}} | ||
| - | |||
| - | === ''radio_0'' === | ||
| - | * ''enable'': boolean. Radio 0 frontend activation (in blue on the picture). | ||
| - | * ''freq'': integer. Central radio 0 frequency in Hz. | ||
| - | |||
| - | === ''radio_1'' === | ||
| - | * ''enable'': boolean. Radio 1 frontend activation (in blue on the picture). | ||
| - | * ''freq'': integer. Central radio 1 frequency in Hz. | ||
| - | |||
| - | === ''chan_multisf_X'' : Channel 0 to 7 configuration === | ||
| - | * ''enable'': boolean. Multi SF channel X activation (in yellow on the picture). | ||
| - | * ''radio'': integer 0 or 1. Identifier of the radio frontend used. | ||
| - | * ''if'': integer from -400000 to 400000. Relative frequency in Hz. The relative frequency is the difference between the channel central frequency and the radio central frequency. | ||
| - | |||
| - | __Example:__ | ||
| - | |||
| - | <code c> | ||
| - | "radio_0": { | ||
| - | "enable": true, // Radio 0 is enabled | ||
| - | "freq": 868500000 // Radio 0 central frequency is 868500000 | ||
| - | }, | ||
| - | | ||
| - | "chan_multisf_0": { | ||
| - | "enable": true, // Channel 0 is enabled | ||
| - | "radio": 0, // Channel 0 works with radio 0 | ||
| - | "if": -400000 // Channel 0 desired channel frequency is 868100000 | ||
| - | // Channel 0 relative frequency = desired channel frequency - radio 0 central frequency | ||
| - | // Channel 0 relative frequency = 868100000 - 868500000 | ||
| - | // Channel 0 relative frequency = -400000 | ||
| - | }, | ||
| - | </code> | ||
| - | |||
| - | === ''chan_monosf'' === | ||
| - | * ''enable'': boolean. Mono SF channel activation. | ||
| - | * ''radio'': integer 0 or 1. Identifier of the radio frontend used. | ||
| - | * ''if'': integer from -400000 to 400000. Relative frequency in Hz. | ||
| - | * ''bandwidth'': integer 125000, 250000 or 500000. Channel bandwidth. | ||
| - | * ''spread_factor'': integer from 7 to 12. Channel spreading factor. | ||
| - | |||
| - | ==== ''tx_rf'': LoRa TX configuration ==== | ||
| - | * ''antenna_gain'': integer from 0 to 20. Antenna gain (in dBi) | ||
| - | * ''insertion_loss'': integer from 0 to 20. Insertion loss (in dB) | ||
| - | * ''tx_power'': integer. TX power in dBm (board output). | ||
| - | |||
| - | ==== ''packets_forwarding'': Slave mode for multi-gateways configuration ==== | ||
| - | |||
| - | * "enable": boolean. Packets forwarding activation. | ||
| - | * "host": String. IPv4 address, name, or URL. Address of the gateway that will receive the packets. | ||
| - | |||
| - | ==== ''network'': network configuration ==== | ||
| - | |||
| - | === ''lan'' : Ethernet configuration === | ||
| - | * ''type'': string "dhcp", "static" or "off". LAN type. | ||
| - | * ''address'': string. IPv4 address if static selected. | ||
| - | * ''netmask'': string. IPv4 netmask if static selected. | ||
| - | * ''gateway'': string. IPv4 gateway if static selected. | ||
| - | |||
| - | === ''wlan'' : wifi configuration === | ||
| - | * ''network_name'': string. Wi-Fi network name. | ||
| - | * ''passphrase'': string. Wi-Fi passphrase. | ||
| - | * ''type'': string "dhcp", "static" or "off". LAN type. | ||
| - | * ''address'': string. IPv4 address if static selected | ||
| - | * ''netmask'': string. IPv4 netmask if static selected. | ||
| - | * ''gateway'': string. IPv4 gateway if static selected. | ||
| - | |||
| - | === ''gsm'' === | ||
| - | * ''enable'': boolean. GSM activation. | ||
| - | * ''operator'' | ||
| - | * ''mcc'': string. Operator MCC (Mobile Country Code). | ||
| - | * ''mnc'': string. Operator MNC (Mobile Network Code). | ||
| - | * ''pin_code'': string. PIN code. | ||
| - | * ''apn'': string. Operator APN (Access Point Name). | ||
| - | * ''user'': string. User. | ||
| - | * ''password'': string. Password. | ||
| - | |||
| - | === ''openvpn'' === | ||
| - | * ''enable'': boolean. OpenVPN activation. | ||
| - | |||
| - | ==== ''time'' ==== | ||
| - | * ''timezone'': string. Timezone | ||
| - | * ''ntp'': string. | ||
| - | * ''polling'': string. NTP polling period. | ||
| - | * ''address_1'': string. Address 1. | ||
| - | * ''address_2'': string. Address 2. | ||
| - | |||
| - | ==== ''login'' ==== | ||
| - | * ''password'': string. Login password. | ||
| - | |||
| - | ===== Templates ===== | ||
| - | |||
| - | Depending on the version of the firmware, the template to use changes. Templates can be downloaded from the [[wiki:resources#templates|resources]] page. Make sure to use the template that suits your gateway. | ||
wiki/data_json.1584364450.txt.gz · Last modified: 2020/03/16 14:14 by ghi
Page Tools
