An MQTT broker is provided on the device to handle messaging between the network server and applications. This provides an easy interface for an application to subscribe to relevant topics. Applications can be written in any language supported by the image installed on the device, MQTT libraries are available for most languages.<\/p>\n
<\/p>\n
<\/p>\n
<\/p>\n
Events for specific DevEUI values can be subscribed to, useful for filtering. Messages published by the network server use QOS level 1.<\/p>\n
Match all topics: lora\/+\/+<\/p>\n
Fields: lora\/<DEV-EUI>\/<EVENT><\/p>\n
Event Topics<\/strong><\/p>\n <\/p>\n Events for specific Gateway EUI can be subscribed to, useful for filtering.<\/p>\n Fields: lora\/<GW-EUI>\/<DEV-EUI>\/<EVENT><\/p>\n Events:<\/p>\n Events for specific Application EUI and Application Port values can be subscribed to, useful for filtering.<\/p>\n Fields: lora\/<APP-EUI>\/<DEV-EUI>\/<EVENT><\/p>\n Fields: lora\/<APP-EUI>\/<DEV-EUI>\/<APP-PORT>\/up<\/p>\n Events:<\/p>\n Below is an example of a device joining the network successfully. Then sending one uplink packet, receiving a confirmed downlink with MAC command requests and responding in a second uplink with MAC command answers and ACK set.<\/p>\n The “data” field of the message must be base64 encoded. Example returning the configuration settings of the Network Server:<\/p>\n To list all commands<\/strong><\/p>\n MTS Lora Server Command Help<\/p>\n Commands:<\/strong><\/p>\n stats – list current stats<\/p>\n reset – reset stats for network, gateways and end-devices<\/p>\n gateway – gateway commands<\/p>\n list – list connected gateways<\/p>\n format: gateway list [json]<\/p>\n delete – remove a gateway from the list<\/p>\n format: device gateway <GW-EUI><\/p>\n device – end-device commands<\/p>\n add – add a new end-device record<\/p>\n format: device add <DEV-JSON><\/p>\n example: stats – show end-device statistics<\/p>\n update – update end-device configuration or session info<\/p>\n format: device update <DEV-EUI> <FIELD> <VALUE><\/p>\n example: fields: class, nskey, dskey, ulc, dlc<\/p>\n format: device update <DEV-JSON><\/p>\n example: fields: deveui, class, name, serial_number, product_id, hardware_version, firmware_version, lorawan_version<\/p>\n delete – delete an end-device configuration, session and packet records<\/p>\n format: device delete <DEV-EUI><\/p>\n config – show configuration for a specific device<\/p>\n reset – reset end-device session counters<\/p>\n format: device reset <DEV-EUI><\/p>\n list – list end-devices configured in the network server<\/p>\n format: device list [json]<\/p>\n keygen – generate a unique end-device key using zero-touch settings<\/p>\n format: device keygen <DEV-EUI> [APP-EUI]<\/p>\n session – session commands<\/p>\n add – add a session for a device<\/p>\n format: session add <DEV-JSON><\/p>\n example: JSON prettified: fields: deveui, appeui, joineui, dev_addr, net_id, app_senc_key, fnwk_sint_key<\/p>\n delete – remove a device session<\/p>\n format: session delete <DEV-EUI><\/p>\n reset – reset session counters<\/p>\n format: session reset <DEV-EUI><\/p>\n list – show current device sessions<\/p>\n format: session list [json]<\/p>\n packet – packet commands<\/p>\n join – list all validated join packets<\/p>\n format: packet join [json]<\/p>\n up – list all validated uplink packets<\/p>\n format: packet up [json]<\/p>\n down – list all downlink packets<\/p>\n format: packet down [json]<\/p>\n list – list all packets: join, up and down<\/p>\n format: packet list [json]<\/p>\n queue – list downlink queue packets to be sent to end-device<\/p>\n format: packet queue [json]<\/p>\n add – add a packet to the downlink queue<\/p>\n format: packet queue add <PACKET-JSON><\/p>\n fields: deveui, data, ack, ack_retries, rx_wndMQ T T<\/p>\n delete – delete all downlinks for a specific device<\/p>\n format: packet queue delete <DEV-EUI><\/p>\n delete – delete one downlink for a specific device<\/p>\n format: packet queue delete <DEV-EUI> <ID><\/p>\n database – database commands<\/p>\n backup – backup database to flash memory<\/p>\n config – show network server configuration<\/p>\n debug – change debug level<\/p>\n ping – ping the network server command port<\/p>\n help – display this help<\/p>\n quit – command network server process to stop<\/p>\n – add ‘json’ modifier to request output in json<\/p>\n <\/p>\n Semtech Packet Forwarder Protocol<\/a> Packet forwarder message format for packet_recv<\/strong> and up<\/strong> topics Additional info added by network server to up<\/b> packets <\/p>\n","protected":false},"excerpt":{"rendered":" An MQTT broker is provided on the device to handle messaging between the network server and applications. This provides an easy interface for an application to subscribe to relevant topics. Applications can be written in any language supported by the image installed on the device, MQTT libraries are available for most languages. Input Topics […]<\/p>\n","protected":false},"author":1337,"featured_media":0,"parent":11786,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-11983","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/11983","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/1337"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=11983"}],"version-history":[{"count":71,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/11983\/revisions"}],"predecessor-version":[{"id":14739,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/11983\/revisions\/14739"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/11786"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=11983"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n
\n
\n
\n
Fields in up messages<\/h3>\n
\n
\n
Gateway Specific Messages<\/h3>\n
\n
\n
\n
Application Specific Messages<\/h3>\n
\n
\n
\n
Subscribing to MQTT Messages<\/h3>\n
# mosquitto_sub -v -t lora\/+\/+<\/code><\/p>\nlora\/00-80-00-00-00-00-e1-9c\/join_request {\"tmst\":4167060148,\"chan\":7,...,\"nonce\":42137}
\nlora\/00-80-00-00-00-00-e1-9c\/class C
\nlora\/00-80-00-00-00-00-e1-9c\/joined {\"remote_js\":true}
\nlora\/00-80-00-00-00-00-e1-9c\/packet_sent {\"appeui\":\"16-ea-76-...-3d-80\",\"codr\":\"4\/5\",...,\"powe\":11,}
\nlora\/00-80-00-00-00-00-e1-9c\/packet_recv {\"tmst\":4237072364,...\"data\":\"QFWKg1i...emStPVPg=\"}
\nlora\/00-80-00-00-00-00-e1-9c\/up {\"tmst\":4237072364,...\"seqn\":0,\"appeui\":\"16-ea-76-...-3d-80\"}
\nlora\/00-80-00-00-00-00-e1-9c\/packet_sent {\"appeui\":\"16-ea-76...-80\",...,\"tmst\":4238072364,\"twnd\":1}
\nlora\/00-80-00-00-00-00-e1-9c\/mac_sent {\"deveui\":\"00-80-...-ee\",\"opts\":\"0708f87d84...18477\"}
\nlora\/00-80-00-00-00-00-e1-9c\/packet_recv {\"tmst\":4248407972,...,\"data\":\"QFWKg1ikA...dgONV\"}
\nlora\/00-80-00-00-00-00-e1-9c\/packet_ack {\"seqn\":0}
\nlora\/00-80-00-00-00-00-e1-9c\/mac_recv {\"appeui\":\"1\",\"data\":\"03\",\"deveui\":\"2\",\"gweui\":\"3\",\"id\":7}
\nlora\/00-80-00-00-00-00-e1-9c\/mac_recv {\"appeui\":\"1\",\"data\":\"03\",\"deveui\":\"2\",\"gweui\":\"3\",\"id\":7}
\nlora\/00-80-00-00-00-00-e1-9c\/up {\"tmst\":4248407972,...,\"seqn\":1,\"appeui\":\"16-ea-76-...-3d-80\"}
\nlora\/00-80-00-00-00-00-e1-9c\/packet_missed {\"count\":3}
\nlora\/00-80-00-00-00-00-e1-9c\/up {\"tmst\":4543408762,...,\"seqn\":5,\"appeui\":\"16-ea-76-...-3d-80\"}<\/code><\/p>\nPublishing MQTT Messages<\/h3>\n
# mosquitto_pub -t lora\/<DEV-EUI>\/down -m '{<JSON fields>}'<\/code>
\n# mosquitto_pub -t lora\/00-80-00-00-00-00-9d-b2\/down -m '{\"data\":\"dGVzdA==\"}'<\/code><\/p>\n
\nCommands can be issued through UDP on port 6677 or using the lora-query utility<\/p>\nAdditional commands<\/h3>\n
# nc -u localhost 6677<\/b><\/code><\/p>\n
\nconfig
\n{
\n\"__v\" : 3,
\n\"addressRange\" : {
\n\"end\" : \"FF:FF:FF:FE\",
\n\"start\" : \"00:00:00:01\"<\/code><\/p>\n# lora-query -x config<\/b><\/code><\/p>\n
\n{
\n\"__v\" : 3,
\n\"addressRange\" : {
\n\"end\" : \"FF:FF:FF:FE\",
\n\"start\" : \"00:00:00:01\"<\/code><\/p>\n$ lora-query -x help<\/code><\/p>\ndevice add '{\"deveui\":\"00-80-00-00-00-00-e1-9c\",\"class\":\"C\"}'<\/code><\/p>\ndevice update 00-80-00-00-00-00-e1-9c class C<\/code><\/p>\ndevice update '{\"deveui\":\"00-80-00-00-00-00-e1-9c\",\"class\":\"C\"}'<\/code><\/p>\nsession add '{\"deveui\":\"008000000000e19c\",...,\"fnwk_sint_key\":\"531bd..ebe6\"}'<\/code><\/p>\n
\n
\n{
\n\"deveui\":\"00-80-00-00-00-00-e1-9c\",
\n\"dev_addr\":\"00112233\",
\n\"appeui\":\"00-88-88-88-00-00-e1-9c\",
\n\"joineui\":\"00-99-99-99-00-00-e1-9c\",
\n\"net_id\":\"000017\",
\n\"app_senc_key\":\"531bd9c5ec5d8ba5ef3b262cebfb3e66\",
\n\"fnwk_sint_key\":\"531bd9c5ec5d8ba5ef3b262cebfb3e66\"
\n}<\/code><\/p>\nMessage Format<\/h3>\n
\nLoRaWAN 1.1<\/a><\/p>\n
\n
\nName | Type | Function
\n:----:|:------:|--------------------------------------------------------------
\ntime | string | UTC time of pkt RX, us precision, ISO 8601 'compact' format
\ntmst | number | Internal timestamp of \"RX finished\" event (32b unsigned)
\nfreq | number | RX central frequency in MHz (unsigned float, Hz precision)
\nchan | number | Concentrator \"IF\" channel used for RX (unsigned integer)
\nrfch | number | Concentrator \"RF chain\" used for RX (unsigned integer)
\nstat | number | CRC status: 1 = OK, -1 = fail, 0 = no CRC
\nmodu | string | Modulation identifier \"LORA\" or \"FSK\"
\ndatr | string | LoRa datarate identifier (eg. SF12BW500)
\ndatr | number | FSK datarate (unsigned, in bits per second)
\ncodr | string | LoRa ECC coding rate identifier
\nrssi | number | RSSI in dBm (signed integer, 1 dB precision)
\nlsnr | number | Lora SNR ratio in dB (signed float, 0.1 dB precision)
\nsize | number | RF packet payload size in bytes (unsigned integer)
\ndata | string | Base64 encoded RF packet payload, padded
\n<\/code><\/p>\n
\n
\n{ ...
\n\"ack\": true,
\n\"adr\": false,
\n\"data\": \"YWxzZGtqZg==\",
\n\"mhdr\": \"4006000000000100\",
\n\"opts\": \"\",
\n\"port\": 1,
\n\"seqn\": 1,
\n\"size\": 12,
\n\"timestamp\": \"2016-10-10T15:17:21.190132Z\",
\n... }
\n<\/code><\/p>\n\n
\n
\n