Synchronous wireless star LoRa network, central device.

Dependencies:   SX127x sx12xx_hal

radio chip selection

Radio chip driver is not included, allowing choice of radio device.
If you're using SX1272 or SX1276, then import sx127x driver into your program.
if you're using SX1261 or SX1262, then import sx126x driver into your program.
if you're using SX1280, then import sx1280 driver into your program.
If you're using NAmote72 or Murata discovery, then you must import only sx127x driver.


Alternate to this project gateway running on raspberry pi can be used as gateway.

LoRaWAN on single radio channel

Synchronous Star Network

This project acts as central node for LoRaWAN-like network operating on single radio channel. Intended for use where network infrastructure would never exist due to cost and/or complexity of standard network. This project uses the class-B method of beacon generation to synchronize the end nodes with the gateway. OTA mode must be used. End-node will be allocated an uplink time slot upon joining. End node may transmit uplink at this assigned timeslot, if it desires to do so. This time slot is always referenced to the beacon sent by gateway.

LoRaWAN server is not necessary. All network control is implemented by this project. User can observe network activity on the mbed serial port. Downlinks can be scheduled using command on serial port.

This implementation must not be used on radio channels requiring duty-cycle transmit limiting.

alterations from LoRaWAN specification

This mode of operation uses a single datarate on single radio channel. ADR is not implemented, because datarate cannot be changed. OTA mode must be used. When join-accept is sent by gateway, it will have appended (instead of CFlist) the beacon timing answer to inform of when next beacon occurs, and two timing values: the time slot allocated to this end-node and the periodicity of the network. Periodicity means how often the end-node may again transmit. /media/uploads/dudmuck/class-b-single.png Beacon is sent for purpose of providing timing reference to end-nodes. The beacon payload may contain a broadcast command to end nodes. Time value is not sent in beacon payload. The time at which beacon is sent provides timing reference: every 128 seconds as standard.

Rx2 receive window is not implemented. Only Rx1 is used because a single radio channel is used. Rx1 delay is reduced to 100 milliseconds. Original LoRaWAN has 1000 millisecond Rx1 delay to accommodate internet latency.

LoRaWAN standard class-B beacon requires GPS timing reference. This implementation does not use GPS, instead a hardware timer peripheral generates interrupts to send beacons. Absolute accuracy is not required, only relative crystal drift between gateway and end-nodes is considered.

Timing values are always specified as 30ms per step as in LoRaWAN standard. Each beacon period has 4096 30ms steps per beacon period.

join OTA procedure

The join procedure has changed the join-accept delay to 100 milliseconds (standard is 5 seconds). This allows end-node to hunt for gateway on several channels during joining. When gateway starts, it will scan available channels for the optimal choice based on ambient noise on the channels. End node will retry join request until it finds the gateway. Gateway might change channel during operation if it deems current channel too busy.

configuration of network

End nodes must be provisioned by editing file Comissioning.h. The array motes lists every end node permitted on network. It contains appEui, devEUI and appKey just as specified in standard LoRaWAN. All provisioning is hard-coded; changing provisioning requires reprogramming gateway. When changing number of motes, N_MOTES definition must be changed in lorawan.h.

lorawan.h

#define N_MOTES     8
extern ota_mote_t motes[N_MOTES];   /* from Comissioning.h */

configuring number of end-nodes vs transmit rate

Trade-off can be selected between number of end-nodes on network vs. how often each end-node can transmit.
In this example, where DR_13 is SF7 at 500KHz:

lorawan.cpp

    #elif (LORAMAC_DEFAULT_DATARATE == DR_13)
        #define TX_SLOT_STEPPING        8  //approx 0.25 seconds
        #define PERIODICITY_SLOTS       (TX_SLOT_STEPPING * 6)
    #endif

Here, each end-node is given time of 240ms = 8 * 30ms; accommodating maximum payload length for both uplink and downlink.
6 in this code is the maximum count of end nodes using this gateway. Each end-node can transmit every 1.44 seconds, in this example.
If you wanted to change 6 to 20 end-nodes, each would be able to use network every 4.8 seconds.
Another example: If you wanted to use DR_12 = SF8, you would have approx 2.5 to 3dB more gain compared to SF7, but each end-node must be given double time, resulting in 20 nodes able to use network every 9.6 seconds at DR_12.

network capacity limitation

The number of end-nodes which can be supported is determined by number of SLOT_STEPPING's which can occur during BEACON_PERIOD. Beacon guard is implemented same as standard LoRaWAN, which is 3 seconds prior to beacon start and 2.12 seconds after beacon start, which gives 122.88 seconds for network traffic for each beacon period.

gateway configuration

spreading factor is declared at #define LORAMAC_DEFAULT_DATARATE in lorawan.h, valid rates are DR_8 to DR_13 (sf12 to sf7). In the end-node, the same definition must be configured in LoRaMac-definitions.h. This network operates at this constant datarate for all packets.
Band plan can be selected by defining USE_BAND_* in lorawan.h. 434MHz can be used on SX1276 shield. TypeABZ module and sx1272 only support 800/900MHz channels band.

end-node provisioning

Security permits only matching DevEUI / AppEui to join the network, due to unique AES root key for each end device; in this case the DevEUI must be programmed in advance into gateway. However, if the same AES root key could be used for each end device , then any number of end devices could be added at a later time, without checking DevEUI on the gateway when an end device joins the network. On the gateway, the end device join acceptance is performed in file lorawan.cpp LoRaWan::parse_receive() where MType == MTYPE_JOIN_REQ. A memcmp() is performed on both DevEUI and AppEUI.

If you wish to allow any DevEUI to join, define ANY_DEVEUI at top of lorawan.cpp . In this configuration, all end devices must use same AppEUI and AES key. N_MOTES must be defined to the maximum number of end devices expected. Test end device by commenting BoardGetUniqueId() in end node, and replace DevEui[] with 8 arbitrary bytes to verify gateway permits any DevEUI to join.

RAM usage

For gateway CPU, recommend to consider larger RAM size depending on number of end devices required. ota_motes_t has size of 123 bytes. Each end device has one of these, however if less RAM usage is required for more end-devices, the MAC command queue size may be reduced.

hardware support

The radio driver supports both SX1272 and SX1276, sx126x kit, sx126x radio-only shield, and sx128x 2.4GHz.. The selection of radio chip type is made by your choice of importing radio driver library.



Beacon generation requires low power ticker to be clocked from crystal, not internal RC oscillator.

Gateway Serial Interface

Gateway serial port operates at 115200bps.

commandargumentdescription
list-list joined end nodes
?-list available commands
dl<mote-hex-dev-addr> <hex-payload>send downlink, sent after uplink received
gpo<mote-hex-dev-addr> <0 or 1>set output PC6 pin level on end device
b32bit hex valueset beacon payload to be sent at next beacon
. (period)-print current status
opdBmconfigure TX power of gateway
sbcountskip sending beacons, for testing end node
fhex devAddrprinter filtering, show only single end node
hm-print filtering, hide MAC layer printing
hp-print filtering, hide APP layer printing
sa-print filtering, show all, undo hm and hp

Any received uplink will be printed with DevAddr and decrypted payload.

Committer:
Wayne Roberts
Date:
Tue Jul 14 11:08:24 2020 -0700
Revision:
23:801d4bd6dccc
Parent:
21:1ac5ffad2726
update to mbed-6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dudmuck 0:2ff18de8d48b 1
dudmuck 12:9a8c13c4298b 2 /* provisioned motes: define N_MOTES in lorawan.h */
dudmuck 0:2ff18de8d48b 3 ota_mote_t motes[N_MOTES] = {
dudmuck 12:9a8c13c4298b 4 /*
dudmuck 12:9a8c13c4298b 5 {
dudmuck 12:9a8c13c4298b 6 { DevEUI },
dudmuck 12:9a8c13c4298b 7 { AppEUI },
dudmuck 12:9a8c13c4298b 8 { AesKey },
dudmuck 12:9a8c13c4298b 9 }
dudmuck 12:9a8c13c4298b 10 */
dudmuck 0:2ff18de8d48b 11 {
Wayne Roberts 23:801d4bd6dccc 12 { 0x31, 0x34, 0x30, 0x36, 0x5e, 0x33, 0x71, 0x0c },
dudmuck 0:2ff18de8d48b 13 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
dudmuck 0:2ff18de8d48b 14 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
dudmuck 0:2ff18de8d48b 15 },
dudmuck 0:2ff18de8d48b 16 {
Wayne Roberts 21:1ac5ffad2726 17 { 0x39, 0x30, 0x30, 0x30, 0x7b, 0x36, 0x7d, 0x18 },
dudmuck 12:9a8c13c4298b 18 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
dudmuck 12:9a8c13c4298b 19 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
dudmuck 12:9a8c13c4298b 20 },
dudmuck 12:9a8c13c4298b 21 {
dudmuck 12:9a8c13c4298b 22 { 0x31, 0x34, 0x30, 0x36, 0x50, 0x33, 0x77, 0x0d },
dudmuck 0:2ff18de8d48b 23 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
dudmuck 0:2ff18de8d48b 24 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
dudmuck 0:2ff18de8d48b 25 },
dudmuck 0:2ff18de8d48b 26 {
Wayne Roberts 21:1ac5ffad2726 27 { 0x0d, 0x50, 0x34, 0x54, 0x94, 0x31, 0x5c, 0x20 },
Wayne Roberts 21:1ac5ffad2726 28 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
Wayne Roberts 21:1ac5ffad2726 29 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
Wayne Roberts 21:1ac5ffad2726 30 },
Wayne Roberts 21:1ac5ffad2726 31 {
dudmuck 12:9a8c13c4298b 32 { 0x31, 0x34, 0x30, 0x36, 0x4f, 0x33, 0x80, 0x13 },
dudmuck 12:9a8c13c4298b 33 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
dudmuck 12:9a8c13c4298b 34 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
dudmuck 12:9a8c13c4298b 35 },
dudmuck 12:9a8c13c4298b 36 {
Wayne Roberts 21:1ac5ffad2726 37 { 0x0d, 0x50, 0x34, 0x54, 0x76, 0x31, 0x6b, 0x20 },
dudmuck 0:2ff18de8d48b 38 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
dudmuck 0:2ff18de8d48b 39 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
dudmuck 0:2ff18de8d48b 40 },
dudmuck 0:2ff18de8d48b 41 {
Wayne Roberts 21:1ac5ffad2726 42 { 0x09, 0x50, 0x33, 0x42, 0x81, 0x35, 0x5d, 0x20 }, // .
dudmuck 1:107435401168 43 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
dudmuck 1:107435401168 44 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
dudmuck 12:9a8c13c4298b 45 },
dudmuck 12:9a8c13c4298b 46 {
Wayne Roberts 21:1ac5ffad2726 47 { 0x33, 0x39, 0x34, 0x37, 0x58, 0x35, 0x85, 0x15 }, // .
dudmuck 12:9a8c13c4298b 48 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 },
dudmuck 12:9a8c13c4298b 49 { 0x3e, 0xfc, 0xf2, 0x81, 0x44, 0x0d, 0x8a, 0x8c, 0x3f, 0xd4, 0x88, 0x24, 0xab, 0xd3, 0x22, 0x52 },
dudmuck 0:2ff18de8d48b 50 }
dudmuck 0:2ff18de8d48b 51 };
dudmuck 0:2ff18de8d48b 52
dudmuck 0:2ff18de8d48b 53