User Tools
wiki:remote_http
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
wiki:remote_http [2017/12/01 10:17] ghi created |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Remote HTTP ====== | ||
| - | ===== Introduction ===== | ||
| - | A remote HTTP server is installed on the gateway. It can be used to: | ||
| - | * Receive frames from end-devices in real time (packets are send as soon as they are received). | ||
| - | |||
| - | Its configuration is available in the //Remote HTTP REST// tab under the //Services// menu. | ||
| - | |||
| - | {{ :images:rhttp_config.png?400 |}} | ||
| - | |||
| - | All data transmitted between client and server are encoded in JSON format. | ||
| - | |||
| - | If transmission fails, the unsend frames are stored to be send later on. The 100 most recent frames are saved in RAM, the other ones are discarded. Frames are deleted from the RAM once successfully transmitted. | ||
| - | |||
| - | ===== Remote HTTP connection ===== | ||
| - | Enable the feature and complete the configuration fields. | ||
| - | |||
| - | * ''Host'': Hostname or IP address. | ||
| - | * ''Port'': Port. | ||
| - | * ''Path'': Destination directory. | ||
| - | |||
| - | <note important> | ||
| - | A suffix ''rx_data'' is added to URL. \\ | ||
| - | \\ | ||
| - | Example:\\ | ||
| - | * Host: my.foo.http.url.com. | ||
| - | * Port: 80. | ||
| - | * Path: my_foo_directory. \\ | ||
| - | |||
| - | URL used: http://my.foo.http.url.com:80/my_foo_directory/rx_data | ||
| - | |||
| - | </note> | ||
| - | |||
| - | The examples featured in this guide use the program ncat to simulate an HTTP server. \\ | ||
| - | For testing purposes, you could also use mockable.io. | ||
| - | |||
| - | <note warning> | ||
| - | On version v1.1.1, a reboot is needed to apply the port configuration. | ||
| - | </note> | ||
| - | ===== Receive data ===== | ||
| - | |||
| - | The gateway will send a POST requests when it receives frames from an end-device. The body of this request will contain the data of the received frames as a JSON string. | ||
| - | |||
| - | The HTTP headers indicate: | ||
| - | * The ''Content-Type'' is set to ''application/json'', meaning that the body of the HTTP ''POST'' contains a JSON string. | ||
| - | * The ''Accept'' is also set to ''application/json'', meaning that the server can reply with a JSON string. | ||
| - | |||
| - | The HTTP body contains an ''rx_data'' JSON object. | ||
| - | |||
| - | === RX packets structure === | ||
| - | |||
| - | Here is the structure of an RX packet sent over HTTP: | ||
| - | |||
| - | * ''rx_data_id'': integer. RX data unique identifier. | ||
| - | * ''endpoint_id'': string. The mote EUI or DevAddr depending on the activation procedure. | ||
| - | * ''application_eui'': string. Application EUI. | ||
| - | * ''received_time'': integer. Unix timestamp. | ||
| - | * ''sequence_number'': integer. Sequence number sent by the mote. | ||
| - | * ''port'': integer. LoRaWAN port to be used. | ||
| - | * ''radio_id'': integer. Radio identifier (range [0;1]). | ||
| - | * ''channel'': integer. Channel identifier (range [0;9]). | ||
| - | * ''rssi_dbm'': integer. RSSI in dBm. | ||
| - | * ''snr_db'': float. LoRa SNR ratio in dB. | ||
| - | * ''frequency_hz'': integer. TX central frequency in Hz. | ||
| - | * ''modulation_type'': string. Modulation type, either ''LoRa'' or ''FSK''. | ||
| - | * ''data_rate'': string. Data rate. \\ -> if the modulation is ''LoRa'', ''datr'' is ''SFxBWy'' where ''x'' represents the spreading. factor (range 7-12 inclusive), and ''y'' is the bandwidth in kHz \\ -> if the modulation is ''FSK'', ''datr'' is the FSK bit rate in bps. | ||
| - | * ''coding_rate'': string. ECC coding rate. Example: ''4/5''. | ||
| - | * ''adr'': boolean. Adaptative Data rate enable. | ||
| - | * ''payload'': string. Base64-encoded payload data. | ||
| - | |||
| - | === Example === | ||
| - | |||
| - | Here is an example of one RX packet sent by the SPN gateway.''ncat'', ''awk'' and ''jq'' are used to illustrate this example: | ||
| - | |||
| - | <code> | ||
| - | ncat -lp 12345 | awk '/^\r$/ { body=NR } body && NR > body { print $0 }' | jq -r . | ||
| - | </code> | ||
| - | |||
| - | * Launches ''ncat'' to listen on the TCP port 12345. | ||
| - | * The ''awk'' script discards the HTTP headers and prints the HTTP body. | ||
| - | * ''jq'' will prettyprint the JSON string on the console. | ||
| - | |||
| - | Output: | ||
| - | |||
| - | <code> | ||
| - | $ ncat -lp 8000 | awk '/^\r$/ { body=NR } body && NR > body { print $0 }' | jq -r . | ||
| - | { | ||
| - | "rx_data": { | ||
| - | "rxdata_id": 77, | ||
| - | "endpoint_id": "0018B20000000BAA", | ||
| - | "application_eui": "0018B20041524632", | ||
| - | "received_time": 1510669226, | ||
| - | "sequence_number": 1, | ||
| - | "port": 1, | ||
| - | "radio_id": 0, | ||
| - | "channel": 1, | ||
| - | "rssi_dbm": -45, | ||
| - | "snr_db": 9.2, | ||
| - | "frequency_hz": 868300000, | ||
| - | "modulation_type": "LORA", | ||
| - | "data_rate": "SF12BW125", | ||
| - | "coding_rate": "4/5", | ||
| - | "adr": 1, | ||
| - | "payload": "nhxICQcQABNRUSYAAA53" | ||
| - | } | ||
| - | } | ||
| - | </code> | ||
| - | |||
| - | |||
| - | <note important>**The payload in the RX json object is in base 64** | ||
| - | |||
| - | Example payload (base64): | ||
| - | |||
| - | <code>nhxICQcQABNRUSYAAA53</code> | ||
| - | |||
| - | Decoded data (hex string): | ||
| - | |||
| - | <code>9E1C48090710001351512600000E77</code> | ||
| - | </note> | ||
wiki/remote_http.1512119859.txt.gz · Last modified: 2020/02/21 11:53 (external edit)
Page Tools
