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. 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.
command | argument | description |
---|---|---|
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 |
b | 32bit hex value | set beacon payload to be sent at next beacon |
. (period) | - | print current status |
op | dBm | configure TX power of gateway |
sb | count | skip sending beacons, for testing end node |
f | hex devAddr | printer 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.
History
update to mbed-6
2020-07-14, by Wayne Roberts [Tue, 14 Jul 2020 11:08:24 -0700] rev 23
update to mbed-6
add sx1280, add beacon duration to join accept
2018-12-13, by Wayne Roberts [Thu, 13 Dec 2018 16:53:37 -0800] rev 22
add sx1280, add beacon duration to join accept
update to latest radio HAL
2018-12-07, by Wayne Roberts [Fri, 07 Dec 2018 17:52:16 -0800] rev 21
update to latest radio HAL
add option to allow any DevEUI to join
2017-12-12, by dudmuck [Tue, 12 Dec 2017 21:06:13 +0000] rev 20
add option to allow any DevEUI to join
revised print filter for appliation layer
2017-08-15, by dudmuck [Tue, 15 Aug 2017 10:45:41 -0700] rev 19
revised print filter for appliation layer
had print filtering for mac and application layers
2017-08-14, by dudmuck [Mon, 14 Aug 2017 11:32:56 -0700] rev 18
had print filtering for mac and application layers
print sensor payload with multiple sensor samples
2017-08-11, by dudmuck [Fri, 11 Aug 2017 15:37:39 -0700] rev 17
print sensor payload with multiple sensor samples
add print filter on dev_addr
2017-08-10, by dudmuck [Thu, 10 Aug 2017 17:56:02 -0700] rev 16
add print filter on dev_addr
PaSelect=RFO for 434MHz on shield board
2017-08-10, by dudmuck [Thu, 10 Aug 2017 14:53:12 -0700] rev 15
PaSelect=RFO for 434MHz on shield board
add command to send downlink with power instruction
2017-08-07, by dudmuck [Mon, 07 Aug 2017 12:41:55 -0700] rev 14
add command to send downlink with power instruction