wayne roberts / Mbed OS LoRaWAN_singlechannel_endnode

end node on synchronous star LoRa network.

Dependencies:   SX127x sx12xx_hal TSL2561

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.

This project for use with LoRaWAN_singlechannel_gateway project.

Alternately gateway running on raspberry pi can be used as gateway.

LoRaWAN on single radio channel

Network description is at gateway project page. Synchronous star network.

Hardware Support

This project supports SX1276 and SX1272, sx126x kit, sx126x shield, and sx128x 2.4GHz. The ST board B-L072Z-LRWAN1 is also supported (TypeABZ module). When B-L072Z-LRWAN1 target is selected, TARGET_DISCO_L072CZ_LRWAN1 is defined by tools, allowing correct radio driver configuration for this platform. Alternately, any mbed board that can use LoRa radio shield board should work, but NUCLEO boards are tested.

End-node Unique ID

DevEUI is created from CPU serial number. AppEUI and AppKey are declared as software constants.

End-node Configuration

Data rate definition LORAMAC_DEFAULT_DATARATE configured in LoRaMac-definitions.h. See gateway project page for configuration of gateway.
LoRaWAN addressing is configured in Comissioning.h; only OTA mode is functional.
Header file board/lora_config.h, selects application layer options (i.e. sensors) to be compiled in.

Serial Interface

Serial port operates at 115200bps.
Application layer single_us915_main.cpp User button triggers uplink (i.e. blue button on nucleo board), or jumper enables continuously sends repeated uplink packets. The MAC layer holds each uplink request until the allocated timeslot.

commandargumentsdescription
?-print available commands
. (period)-print status (DevEUI, DevAddr, etc)
ullength integerset payload length of test uplink packets

sensor demo

Selected grove sensors may be plugged into SX1272 shield.
To enable, edit lora_config.h to define SENSORS.

Sensor connections on SX1272MB2xAS:

D8 D9: buttonRX TX: (unused)A3 A4: Rotary Angle Sensor
D6 D7: RGB LEDSCL SDA: digital light sensorA1 A2: Rotary Angle Sensor

Digital input pin, state reported via uplink: PC8
Digital output pin, controlled via downlink: PC6
PWM out: PB_10

Jumper enables auto-repeated transmit: PC10 and PC12 on NUCLEO board, located on end of morpho headers nearby JP4.

mac/LoRaMacCrypto.h@0:8f0d0ae0a077, 2017-05-18 (annotated)

Committer:
dudmuck
Date:
Thu May 18 15:11:53 2017 -0700
Revision:
0:8f0d0ae0a077
Child:
34:9c8966cd66a2
initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dudmuck 0:8f0d0ae0a077 1 /*!
dudmuck 0:8f0d0ae0a077 2 * \file LoRaMacCrypto.h
dudmuck 0:8f0d0ae0a077 3 *
dudmuck 0:8f0d0ae0a077 4 * \brief LoRa MAC layer cryptography implementation
dudmuck 0:8f0d0ae0a077 5 *
dudmuck 0:8f0d0ae0a077 6 * \copyright Revised BSD License, see section \ref LICENSE.
dudmuck 0:8f0d0ae0a077 7 *
dudmuck 0:8f0d0ae0a077 8 * \code
dudmuck 0:8f0d0ae0a077 9 * ______ _
dudmuck 0:8f0d0ae0a077 10 * / _____) _ | |
dudmuck 0:8f0d0ae0a077 11 * ( (____ _____ ____ _| |_ _____ ____| |__
dudmuck 0:8f0d0ae0a077 12 * \____ \| ___ | (_ _) ___ |/ ___) _ \
dudmuck 0:8f0d0ae0a077 13 * _____) ) ____| | | || |_| ____( (___| | | |
dudmuck 0:8f0d0ae0a077 14 * (______/|_____)_|_|_| \__)_____)\____)_| |_|
dudmuck 0:8f0d0ae0a077 15 * (C)2013 Semtech
dudmuck 0:8f0d0ae0a077 16 *
dudmuck 0:8f0d0ae0a077 17 * ___ _____ _ ___ _ _____ ___ ___ ___ ___
dudmuck 0:8f0d0ae0a077 18 * / __|_ _/_\ / __| |/ / __/ _ \| _ \/ __| __|
dudmuck 0:8f0d0ae0a077 19 * \__ \ | |/ _ \ (__| ' <| _| (_) | / (__| _|
dudmuck 0:8f0d0ae0a077 20 * |___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
dudmuck 0:8f0d0ae0a077 21 * embedded.connectivity.solutions===============
dudmuck 0:8f0d0ae0a077 22 *
dudmuck 0:8f0d0ae0a077 23 * \endcode
dudmuck 0:8f0d0ae0a077 24 *
dudmuck 0:8f0d0ae0a077 25 * \author Miguel Luis ( Semtech )
dudmuck 0:8f0d0ae0a077 26 *
dudmuck 0:8f0d0ae0a077 27 * \author Gregory Cristian ( Semtech )
dudmuck 0:8f0d0ae0a077 28 *
dudmuck 0:8f0d0ae0a077 29 * \author Daniel Jäckle ( STACKFORCE )
dudmuck 0:8f0d0ae0a077 30 *
dudmuck 0:8f0d0ae0a077 31 * \defgroup LORAMAC_CRYPTO LoRa MAC layer cryptography implementation
dudmuck 0:8f0d0ae0a077 32 * This module covers the implementation of cryptographic functions
dudmuck 0:8f0d0ae0a077 33 * of the LoRaMAC layer.
dudmuck 0:8f0d0ae0a077 34 * \{
dudmuck 0:8f0d0ae0a077 35 */
dudmuck 0:8f0d0ae0a077 36 #ifndef __LORAMAC_CRYPTO_H__
dudmuck 0:8f0d0ae0a077 37 #define __LORAMAC_CRYPTO_H__
dudmuck 0:8f0d0ae0a077 38
dudmuck 0:8f0d0ae0a077 39 /*!
dudmuck 0:8f0d0ae0a077 40 * Computes the LoRaMAC frame MIC field
dudmuck 0:8f0d0ae0a077 41 *
dudmuck 0:8f0d0ae0a077 42 * \param [IN] buffer - Data buffer
dudmuck 0:8f0d0ae0a077 43 * \param [IN] size - Data buffer size
dudmuck 0:8f0d0ae0a077 44 * \param [IN] key - AES key to be used
dudmuck 0:8f0d0ae0a077 45 * \param [IN] address - Frame address
dudmuck 0:8f0d0ae0a077 46 * \param [IN] dir - Frame direction [0: uplink, 1: downlink]
dudmuck 0:8f0d0ae0a077 47 * \param [IN] sequenceCounter - Frame sequence counter
dudmuck 0:8f0d0ae0a077 48 * \param [OUT] mic - Computed MIC field
dudmuck 0:8f0d0ae0a077 49 */
dudmuck 0:8f0d0ae0a077 50 void LoRaMacComputeMic( const uint8_t *buffer, uint16_t size, const uint8_t *key, uint32_t address, uint8_t dir, uint32_t sequenceCounter, uint32_t *mic );
dudmuck 0:8f0d0ae0a077 51
dudmuck 0:8f0d0ae0a077 52 /*!
dudmuck 0:8f0d0ae0a077 53 * Computes the LoRaMAC payload encryption
dudmuck 0:8f0d0ae0a077 54 *
dudmuck 0:8f0d0ae0a077 55 * \param [IN] buffer - Data buffer
dudmuck 0:8f0d0ae0a077 56 * \param [IN] size - Data buffer size
dudmuck 0:8f0d0ae0a077 57 * \param [IN] key - AES key to be used
dudmuck 0:8f0d0ae0a077 58 * \param [IN] address - Frame address
dudmuck 0:8f0d0ae0a077 59 * \param [IN] dir - Frame direction [0: uplink, 1: downlink]
dudmuck 0:8f0d0ae0a077 60 * \param [IN] sequenceCounter - Frame sequence counter
dudmuck 0:8f0d0ae0a077 61 * \param [OUT] encBuffer - Encrypted buffer
dudmuck 0:8f0d0ae0a077 62 */
dudmuck 0:8f0d0ae0a077 63 void LoRaMacPayloadEncrypt( const uint8_t *buffer, uint16_t size, const uint8_t *key, uint32_t address, uint8_t dir, uint32_t sequenceCounter, uint8_t *encBuffer );
dudmuck 0:8f0d0ae0a077 64
dudmuck 0:8f0d0ae0a077 65 /*!
dudmuck 0:8f0d0ae0a077 66 * Computes the LoRaMAC payload decryption
dudmuck 0:8f0d0ae0a077 67 *
dudmuck 0:8f0d0ae0a077 68 * \param [IN] buffer - Data buffer
dudmuck 0:8f0d0ae0a077 69 * \param [IN] size - Data buffer size
dudmuck 0:8f0d0ae0a077 70 * \param [IN] key - AES key to be used
dudmuck 0:8f0d0ae0a077 71 * \param [IN] address - Frame address
dudmuck 0:8f0d0ae0a077 72 * \param [IN] dir - Frame direction [0: uplink, 1: downlink]
dudmuck 0:8f0d0ae0a077 73 * \param [IN] sequenceCounter - Frame sequence counter
dudmuck 0:8f0d0ae0a077 74 * \param [OUT] decBuffer - Decrypted buffer
dudmuck 0:8f0d0ae0a077 75 */
dudmuck 0:8f0d0ae0a077 76 void LoRaMacPayloadDecrypt( const uint8_t *buffer, uint16_t size, const uint8_t *key, uint32_t address, uint8_t dir, uint32_t sequenceCounter, uint8_t *decBuffer );
dudmuck 0:8f0d0ae0a077 77
dudmuck 0:8f0d0ae0a077 78 /*!
dudmuck 0:8f0d0ae0a077 79 * Computes the LoRaMAC Join Request frame MIC field
dudmuck 0:8f0d0ae0a077 80 *
dudmuck 0:8f0d0ae0a077 81 * \param [IN] buffer - Data buffer
dudmuck 0:8f0d0ae0a077 82 * \param [IN] size - Data buffer size
dudmuck 0:8f0d0ae0a077 83 * \param [IN] key - AES key to be used
dudmuck 0:8f0d0ae0a077 84 * \param [OUT] mic - Computed MIC field
dudmuck 0:8f0d0ae0a077 85 */
dudmuck 0:8f0d0ae0a077 86 void LoRaMacJoinComputeMic( const uint8_t *buffer, uint16_t size, const uint8_t *key, uint32_t *mic );
dudmuck 0:8f0d0ae0a077 87
dudmuck 0:8f0d0ae0a077 88 /*!
dudmuck 0:8f0d0ae0a077 89 * Computes the LoRaMAC join frame decryption
dudmuck 0:8f0d0ae0a077 90 *
dudmuck 0:8f0d0ae0a077 91 * \param [IN] buffer - Data buffer
dudmuck 0:8f0d0ae0a077 92 * \param [IN] size - Data buffer size
dudmuck 0:8f0d0ae0a077 93 * \param [IN] key - AES key to be used
dudmuck 0:8f0d0ae0a077 94 * \param [OUT] decBuffer - Decrypted buffer
dudmuck 0:8f0d0ae0a077 95 */
dudmuck 0:8f0d0ae0a077 96 void LoRaMacJoinDecrypt( const uint8_t *buffer, uint16_t size, const uint8_t *key, uint8_t *decBuffer );
dudmuck 0:8f0d0ae0a077 97
dudmuck 0:8f0d0ae0a077 98 /*!
dudmuck 0:8f0d0ae0a077 99 * Computes the LoRaMAC join frame decryption
dudmuck 0:8f0d0ae0a077 100 *
dudmuck 0:8f0d0ae0a077 101 * \param [IN] key - AES key to be used
dudmuck 0:8f0d0ae0a077 102 * \param [IN] appNonce - Application nonce
dudmuck 0:8f0d0ae0a077 103 * \param [IN] devNonce - Device nonce
dudmuck 0:8f0d0ae0a077 104 * \param [OUT] nwkSKey - Network session key
dudmuck 0:8f0d0ae0a077 105 * \param [OUT] appSKey - Application session key
dudmuck 0:8f0d0ae0a077 106 */
dudmuck 0:8f0d0ae0a077 107 void LoRaMacJoinComputeSKeys( const uint8_t *key, const uint8_t *appNonce, uint16_t devNonce, uint8_t *nwkSKey, uint8_t *appSKey );
dudmuck 0:8f0d0ae0a077 108
dudmuck 0:8f0d0ae0a077 109 /*! \} defgroup LORAMAC */
dudmuck 0:8f0d0ae0a077 110
dudmuck 0:8f0d0ae0a077 111 #endif // __LORAMAC_CRYPTO_H__