Difference between revisions of "LoRaWAN"

From HSYCO
Jump to navigation Jump to search
Line 158: Line 158:
 
|R
 
|R
 
|timestamp of the last packet received from device <id>
 
|timestamp of the last packet received from device <id>
 +
 +
|-
 +
 +
|dev.<id>.data
 +
|<bytes>
 +
|R
 +
|Hexadecimal representation of the data transmitted in the last valid packet received from device <id>. E.g.: "010fbb"
 +
 +
|-
 +
 +
|dev.<id>.data.ch<n>
 +
|<val>
 +
|R
 +
|Cayenne channel <n>'s value. Possible values depend on the channel's type, refer to [[#Cayenne LLP format]] for details. Datapoint available only if Cayenne data format is enabled on this device
 +
 +
|-
 +
 +
|style="white-space:nowrap" rowspan="2" |dev.<id>.data.ch<n>.type
 +
|rowspan="2" |<t>
 +
|R
 +
|Cayenne channel <n>'s type. Refer to [[#Cayenne LLP format]] for details. Datapoint available only if Cayenne data format is enabled on this device
 +
|-
 +
|W
 +
|Set Cayenne channel <n>'s type. To be used to write output channels for which no data has been received. Possible values are "1" (digital output) or "3" (analog output). Datapoint available only if Cayenne data format is enabled on this device
  
 
|-
 
|-
Line 178: Line 202:
 
|W
 
|W
 
|set the downlink frame counter for device <id>
 
|set the downlink frame counter for device <id>
 +
 +
|-
 +
 +
|dev.<id>.datr
 +
|SF<sf>BW<bw>
 +
|R
 +
|Data rate of last valid packet received from device <id>. <sf> ranges from 7 to 12 and <bw> is either 125, 250 or 500. E.g.: "SF7BW125"
 +
 +
|-
 +
 +
|dev.<id>.codr
 +
|<cr>
 +
|R
 +
|Coding rate of last valid packet received from device <id>. Possible <cr> values: "4/5", "4/6", "4/7", "4/8"
 +
 +
|-
 +
 +
|dev.<id>.freq
 +
|<fr>
 +
|R
 +
|TX central frequency in MHz (float, Hz precision) of last valid packet received from device <id>
 +
 +
|-
 +
 +
|dev.<id>.lsnr
 +
|<val>
 +
|R
 +
|Lora SNR ratio in dB (float, 0.1 dB precision) of last valid packet received from device <id>
 +
 +
|-
 +
 +
|dev.<id>.rssi
 +
|<val>
 +
|R
 +
|RSSI in dBm (signed integer, 1 dB precision) of last valid packet received from device <id>
 +
 +
|-
 +
 +
|dev.<id>.tmst
 +
|<val>
 +
|R
 +
|gateway internal timestamp of the instant the last valid frame from device <id> was received
 +
 +
|-
 +
 +
|dev.<id>.gw
 +
|<gw_id>
 +
|R
 +
|ID of the gateway from which the latest packet from device <id> was received
  
 
|-
 
|-
Line 211: Line 284:
 
|R
 
|R
 
|the message integrity code (MIC) in the latest uplink frame from device <id> was not valid
 
|the message integrity code (MIC) in the latest uplink frame from device <id> was not valid
 +
 +
|-
 +
 +
|rowspan="3" |dev.<id>.queue
 +
|<nowiki><data></nowiki>
 +
|W
 +
|add a frame with the specified data (hexadecimal representation, e.g. "010fbb") to the downlink queue of device <id>, using the default transmission parameters.
 +
|-
 +
|<JSON>
 +
|W
 +
|add a frame with the specified data and transmission parameters to the downlink queue of device <id>. See [[#Downlink frame JSON format]] for details
 +
|-
 +
|clear
 +
|W
 +
|clear the downlink queue of device <id>
 +
 +
|-
 +
 +
|dev.<id>.queue.ch<n>
 +
|<val>
 +
|W
 +
|add a frame to the downlink queue of device <id> with Cayenne-encoded data for setting channel <n> to <val>. Possible values depend on the channel's type. Make sure the channel's type is set before writing this datapoint. The packet will be sent using the default transmission parameters. Datapoint available only if Cayenne data format is enabled on this device
  
 
|-
 
|-
Line 229: Line 324:
 
|R
 
|R
 
|the gateway responded with the reported error code to the last downlink request for device <id>. Possible values are "TOO_LATE", "TOO_EARLY", "COLLISION_PACKET", "COLLISION_BEACON", "TX_FREQ", "TX_POWER", "GPS_UNLOCKED"
 
|the gateway responded with the reported error code to the last downlink request for device <id>. Possible values are "TOO_LATE", "TOO_EARLY", "COLLISION_PACKET", "COLLISION_BEACON", "TX_FREQ", "TX_POWER", "GPS_UNLOCKED"
 +
 +
|-
 +
 +
|rowspan="2"|dev.<id>.error.data
 +
|0
 +
|R
 +
|data in the last frame received from device <id> was processed correctly. Datapoint available only if Cayenne data format is enabled on this device
 +
|-
 +
|1
 +
|R
 +
|error processing data in the last frame received from device <id>. Datapoint available only if Cayenne data format is enabled on this device
  
 
|}
 
|}

Revision as of 13:25, 26 April 2019

The LoRaWAN I/O Server implements both a LoRaWAN Network and Application servers for the integration of a LoRaWAN network.

HSYCO acts as a server for one or more LoRaWAN gateways configured as standard Semtech packet forwarders. Communication is carried on UDP packets.

The implementation complies with the Semtech's paket forwarder protocol v4.0.1 and supports Class A end devices using unconfirmed data frames and ABP authentication.


HSYCO Configuration

Add a LORAWAN I/O Server in the I/O Servers section of the Settings and set its parameters:

Note that only one instance of the LORAWAN I/O Server is allowed and it consumes one item for each defined gateway from the I/O Servers license total.


High Availability

  • Shutdown when inactive: defaults to true.

Options

ID Default Values Description
localport <port_number> the IP port number used locally by HSYCO to listen for incoming UDP packets sent by the gateways
debug false true print debugging information to the logs
false don't print debugging information to the logs

LoRaWAN Utility

Use the LoRaWAN Utility to automatically discover gateways and devices and setup the communication and functional parameters.

Gateways Configuration

Configure the gateway(s) as standard Semtech packet forwarder(s). Make sure the network configuration allows for the communication with HSYCO and use HSYCO's IP address and the port number specified in the "localport" option for the network server's configuration.

Datapoints

ID Value R/W Description
connection online R ready to receive packets
offline R not ready
gw.<id>.lastseen <ts> R timestamp of the last packet received from gateway <id>
gw.<id>.lastpull <ts> R timestamp of the last "pull data" packet received from gateway <id>
gw.<id>.stat.time <time> R UTC system time reported in the latest status message from gateway <id>
gw.<id>.stat.lati <n> R GPS latitude in degree (float, N is +) reported in the latest status message from gateway <id>
gw.<id>.stat.long <n> R GPS longitude in degree (float, E is +) reported in the latest status message from gateway <id>
gw.<id>.stat.alti <n> R GPS altitude in meter reported in the latest status message from gateway <id>
gw.<id>.stat.rxnb <n> R number of radio packets received reported in the latest status message from gateway <id>
gw.<id>.stat.rxok <n> R number of radio packets received with a valid PHY CRC reported in the latest status message from gateway <id>
gw.<id>.stat.rxfw <n> R number of radio packets forwarded reported in the latest status message from gateway <id>
gw.<id>.stat.ackr <n> R percentage of upstream datagrams that were acknowledged reported in the latest status message from gateway <id>
gw.<id>.stat.dwnb <n> R number of downlink datagrams received reported in the latest status message from gateway <id>
gw.<id>.stat.txnb <n> R number of packets emitted reported in the latest status message from gateway <id>
dev.<id>.lastseen <ts> R timestamp of the last packet received from device <id>
dev.<id>.data <bytes> R Hexadecimal representation of the data transmitted in the last valid packet received from device <id>. E.g.: "010fbb"
dev.<id>.data.ch<n> <val> R Cayenne channel <n>'s value. Possible values depend on the channel's type, refer to #Cayenne LLP format for details. Datapoint available only if Cayenne data format is enabled on this device
dev.<id>.data.ch<n>.type <t> R Cayenne channel <n>'s type. Refer to #Cayenne LLP format for details. Datapoint available only if Cayenne data format is enabled on this device
W Set Cayenne channel <n>'s type. To be used to write output channels for which no data has been received. Possible values are "1" (digital output) or "3" (analog output). Datapoint available only if Cayenne data format is enabled on this device
dev.<id>.fcnt.up <n> R server-side uplink frame counter for device <id>. Used for frames validation. If never set and no frame has ever been received it is set to -1
W set the server-side downlink frame counter for device <id>
dev.<id>.fcnt.down <n> R value of the last frame counter used to send a downlink to device <id>. If never set o no frame has ever been sent it is set to -1
W set the downlink frame counter for device <id>
dev.<id>.datr SF<sf>BW<bw> R Data rate of last valid packet received from device <id>. <sf> ranges from 7 to 12 and <bw> is either 125, 250 or 500. E.g.: "SF7BW125"
dev.<id>.codr <cr> R Coding rate of last valid packet received from device <id>. Possible <cr> values: "4/5", "4/6", "4/7", "4/8"
dev.<id>.freq <fr> R TX central frequency in MHz (float, Hz precision) of last valid packet received from device <id>
dev.<id>.lsnr <val> R Lora SNR ratio in dB (float, 0.1 dB precision) of last valid packet received from device <id>
dev.<id>.rssi <val> R RSSI in dBm (signed integer, 1 dB precision) of last valid packet received from device <id>
dev.<id>.tmst <val> R gateway internal timestamp of the instant the last valid frame from device <id> was received
dev.<id>.gw <gw_id> R ID of the gateway from which the latest packet from device <id> was received
dev.<id>.warning.data 0 R the latest uplink frame from device <id> has been decoded correctly
1 R error decoding the latest uplink frame from device <id>
dev.<id>.warning.fcnt 0 R the frame counter in the latest uplink frame from device <id> was valid
n >= 10 R the frame counter in the latest uplink frame from device <id> was not valid (n = 10: repetition)
dev.<id>.warning.mic 0 R the message integrity code (MIC) in the latest uplink frame from device <id> was valid
1 R the message integrity code (MIC) in the latest uplink frame from device <id> was not valid
dev.<id>.queue <data> W add a frame with the specified data (hexadecimal representation, e.g. "010fbb") to the downlink queue of device <id>, using the default transmission parameters.
<JSON> W add a frame with the specified data and transmission parameters to the downlink queue of device <id>. See #Downlink frame JSON format for details
clear W clear the downlink queue of device <id>
dev.<id>.queue.ch<n> <val> W add a frame to the downlink queue of device <id> with Cayenne-encoded data for setting channel <n> to <val>. Possible values depend on the channel's type. Make sure the channel's type is set before writing this datapoint. The packet will be sent using the default transmission parameters. Datapoint available only if Cayenne data format is enabled on this device
dev.<id>.queue.size <n> R number of downlink frames in the device's queue
dev.<id>.error.tx NONE R last downlink for device <id> was sent correctly to the gateway
<err_code> R the gateway responded with the reported error code to the last downlink request for device <id>. Possible values are "TOO_LATE", "TOO_EARLY", "COLLISION_PACKET", "COLLISION_BEACON", "TX_FREQ", "TX_POWER", "GPS_UNLOCKED"
dev.<id>.error.data 0 R data in the last frame received from device <id> was processed correctly. Datapoint available only if Cayenne data format is enabled on this device
1 R error processing data in the last frame received from device <id>. Datapoint available only if Cayenne data format is enabled on this device

Release Notes

3.7.0

  • initial release


LoRaWAN is a registered trademark of LoRa Alliance.

Semtech is a registered trademark of Semtech Corporation.

Retrieved from "https://wiki.hsyco.com/3.8/index.php?title=LoRaWAN&oldid=7845"