Bleeding edge development version of the mDot library for mbed 5. This version of the library is not guaranteed to be stable or well tested and should not be used in production or deployment scenarios.

Dependents:   mDot-IKS01A1 mDot-IKS01A1 mDot-Examples mDot-IKS01A1-Explora ... more

Fork of libmDot-dev-mbed2-deprecated by MultiTech

The Dot library provides a LoRaWan certified stack for LoRa communication using MultiTech mDot and xDot devices. The stack is compatible with mbed 5.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. Channel plans are included with the 3.x.x Dot Library releases. The following code snippet demonstrates how to create a channel plan and inject it into the stack.

#include "mDot.h"
#include "channel_plans.h"

int main() {
    ChannelPlan* plan = new lora::ChannelPlan_US915();
    assert(plan);
    mDot* dot = mDot::getInstance(plan);
    assert(dot);

    // ...
}

Dot devices must not be deployed with software using a different channel plan than the Dot's default plan! This functionality is for development and testing only!

Multicast Sessions

Multicast sessions and packet rx events in library. When in Class C mode Multicast downlinks can be received. Recieved packets should be filtered on address, counter value will be maintained in the session or can be set explicitly depending on Application support to share Multicast Address, Keys and Counters.

mDot.h

        /**
         * Add a multicast session address and keys
         * Downlink counter is set to 0
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* dsk);
 
        /**
         * Set a multicast session counter
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);

mDotEvent.h

The address field was added to PacketRx event.

        virtual void PacketRx(uint8_t port, uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot, uint8_t retries, uint32_t address);

The name of the repository can be used to determine which device the stack was compiled for and if it's a development or production-ready build:

A changelog for the Dot library can be found here.

The Dot library version and the version of mbed-os it was compiled against can both be found in the commit message for that revision of the Dot library. Building your application with the same version of mbed-os as what was used to build the Dot library is highly recommended!

The Dot-Examples repository demonstrates how to use the Dot library in a custom application.

The mDot and xDot platform pages have lots of platform specific information and document potential issues, gotchas, etc, and provide instructions for getting started with development. Please take a look at the platform page before starting development as they should answer many questions you will have.

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Fri Oct 26 16:14:07 2018 -0500
Revision:
183:f205b2eea7c2
Parent:
182:b642f4d0c95b
mdot-library revision 3.1.0-49-g926b83a and mbed-os revision mbed-os-5.9.6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 16:b630e18103e5 1 /** __ ___ ____ _ ______ __ ____ __ ____
Mike Fiore 16:b630e18103e5 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
Mike Fiore 16:b630e18103e5 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
Mike Fiore 16:b630e18103e5 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
Mike Fiore 16:b630e18103e5 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
Mike Fiore 16:b630e18103e5 6 *
Mike Fiore 16:b630e18103e5 7 *
Mike Fiore 16:b630e18103e5 8 * @author Jason Reiss
Mike Fiore 16:b630e18103e5 9 * @date 10-31-2015
Mike Fiore 16:b630e18103e5 10 * @brief lora namespace defines global settings, structures and enums for the lora library
Mike Fiore 16:b630e18103e5 11 *
Mike Fiore 16:b630e18103e5 12 * @details
Mike Fiore 16:b630e18103e5 13 *
Mike Fiore 16:b630e18103e5 14 *
Mike Fiore 16:b630e18103e5 15 *
Mike Fiore 16:b630e18103e5 16 */
Mike Fiore 16:b630e18103e5 17
Mike Fiore 16:b630e18103e5 18 #ifndef __LORA_H__
Mike Fiore 16:b630e18103e5 19 #define __LORA_H__
Mike Fiore 16:b630e18103e5 20
Mike Fiore 16:b630e18103e5 21 #include "mbed.h"
Mike Fiore 16:b630e18103e5 22 #include <assert.h>
Mike Fiore 16:b630e18103e5 23 #include "MTSLog.h"
Mike Fiore 16:b630e18103e5 24 //#include <cstring>
Mike Fiore 16:b630e18103e5 25 #include <inttypes.h>
Mike Fiore 16:b630e18103e5 26
Mike Fiore 16:b630e18103e5 27 namespace lora {
Mike Fiore 16:b630e18103e5 28
Mike Fiore 16:b630e18103e5 29 /**
Mike Fiore 16:b630e18103e5 30 * Frequency bandwidth of a Datarate, higher bandwidth gives higher datarate
Mike Fiore 16:b630e18103e5 31 */
Mike Fiore 16:b630e18103e5 32 enum Bandwidth {
Mike Fiore 16:b630e18103e5 33 BW_125,
Mike Fiore 16:b630e18103e5 34 BW_250,
Mike Fiore 16:b630e18103e5 35 BW_500,
Mike Fiore 16:b630e18103e5 36 BW_FSK = 50
Mike Fiore 16:b630e18103e5 37 };
Mike Fiore 16:b630e18103e5 38
Mike Fiore 16:b630e18103e5 39 /**
Mike Fiore 16:b630e18103e5 40 * Spreading factor of a Datarate, lower spreading factor gives higher datarate
Mike Fiore 16:b630e18103e5 41 */
Mike Fiore 16:b630e18103e5 42 enum SpreadingFactors {
Mike Fiore 16:b630e18103e5 43 SF_6 = 6,
Mike Fiore 16:b630e18103e5 44 SF_7,
Mike Fiore 16:b630e18103e5 45 SF_8,
Mike Fiore 16:b630e18103e5 46 SF_9,
Mike Fiore 16:b630e18103e5 47 SF_10,
Mike Fiore 16:b630e18103e5 48 SF_11,
Mike Fiore 16:b630e18103e5 49 SF_12,
Mike Fiore 16:b630e18103e5 50 SF_FSK,
Mike Fiore 16:b630e18103e5 51 SF_INVALID
Mike Fiore 16:b630e18103e5 52 };
Mike Fiore 16:b630e18103e5 53
Mike Fiore 16:b630e18103e5 54 /**
Mike Fiore 16:b630e18103e5 55 * Datarates for use with ChannelPlan
Mike Fiore 16:b630e18103e5 56 */
Mike Fiore 16:b630e18103e5 57 enum Datarates {
Mike Fiore 16:b630e18103e5 58 DR_0 = 0,
Mike Fiore 16:b630e18103e5 59 DR_1,
Mike Fiore 16:b630e18103e5 60 DR_2,
Mike Fiore 16:b630e18103e5 61 DR_3,
Mike Fiore 16:b630e18103e5 62 DR_4,
Mike Fiore 16:b630e18103e5 63 DR_5,
Mike Fiore 16:b630e18103e5 64 DR_6,
Mike Fiore 16:b630e18103e5 65 DR_7,
Mike Fiore 16:b630e18103e5 66 DR_8,
Mike Fiore 16:b630e18103e5 67 DR_9,
Mike Fiore 16:b630e18103e5 68 DR_10,
Mike Fiore 16:b630e18103e5 69 DR_11,
Mike Fiore 16:b630e18103e5 70 DR_12,
Mike Fiore 16:b630e18103e5 71 DR_13,
Mike Fiore 16:b630e18103e5 72 DR_14,
Mike Fiore 16:b630e18103e5 73 DR_15
Mike Fiore 16:b630e18103e5 74 };
Mike Fiore 16:b630e18103e5 75
Mike Fiore 16:b630e18103e5 76 const uint8_t MIN_DATARATE = (uint8_t) DR_0; //!< Minimum datarate
Mike Fiore 16:b630e18103e5 77
Mike Fiore 16:b630e18103e5 78
Mike Fiore 16:b630e18103e5 79 const uint8_t MAX_PHY_PACKET_SIZE = 255; //!< Maximum size for a packet
Mike Fiore 16:b630e18103e5 80 const uint8_t MAX_APPS = 8; //!< Maximum number of apps sessions to save
Mike Fiore 16:b630e18103e5 81 const uint8_t MAX_MULTICAST_SESSIONS = 8; //!< Maximum number of multicast sessions to save
Mike Fiore 16:b630e18103e5 82 const uint8_t EUI_SIZE = 8; //!< Number of bytes in an EUI
Mike Fiore 16:b630e18103e5 83 const uint8_t KEY_SIZE = 16; //!< Number of bytes in an AES key
Mike Fiore 16:b630e18103e5 84
Mike Fiore 16:b630e18103e5 85 const uint8_t DEFAULT_NUM_CHANNELS = 16; //!< Default number of channels in a plan
Mike Fiore 16:b630e18103e5 86 const uint8_t DEFAULT_RX1_DR_OFFSET = 0; //!< Default datarate offset for first rx window
Mike Fiore 16:b630e18103e5 87 const uint8_t DEFAULT_RX2_DATARATE = 0; //!< Default datarate for second rx window
Mike Fiore 16:b630e18103e5 88 const uint8_t DEFAULT_TX_POWER = 14; //!< Default transmit power
Mike Fiore 16:b630e18103e5 89 const uint8_t DEFAULT_CODE_RATE = 1; //!< Default coding rate 1:4/5, 2:4/6, 3:4/7, 4:4/8
Mike Fiore 16:b630e18103e5 90 const uint8_t DEFAULT_PREAMBLE_LEN = 8; //!< Default preamble length
Mike Fiore 16:b630e18103e5 91
Mike Fiore 16:b630e18103e5 92 const int32_t MAX_FCNT_GAP = 16384; //!< Maximum allowed gap in sequence numbers before roll-over
Mike Fiore 16:b630e18103e5 93
Mike Fiore 16:b630e18103e5 94 const uint16_t PRIVATE_JOIN_DELAY = 1000; //!< Default join delay used for private network
Mike Fiore 16:b630e18103e5 95 const uint16_t PUBLIC_JOIN_DELAY = 5000; //!< Default join delay used for public network
Mike Fiore 16:b630e18103e5 96 const uint16_t DEFAULT_JOIN_DELAY = PRIVATE_JOIN_DELAY; //!< Default join delay1
Mike Fiore 16:b630e18103e5 97 const uint16_t DEFAULT_RX_DELAY = 1000; //!< Default delay for first receive window
Mike Fiore 16:b630e18103e5 98 const uint16_t DEFAULT_RX_TIMEOUT = 3000; //!< Default timeout for receive windows
Mike Fiore 16:b630e18103e5 99
Mike Fiore 16:b630e18103e5 100 const uint8_t HI_DR_SYMBOL_TIMEOUT = 12; //!< Symbol timeout for receive at datarate with SF < 11
Mike Fiore 16:b630e18103e5 101 const uint8_t LO_DR_SYMBOL_TIMEOUT = 8; //!< Symbol timeout for receive at datarate with SF > 10
Mike Fiore 16:b630e18103e5 102
Mike Fiore 16:b630e18103e5 103 const uint16_t RX2_DELAY_OFFSET = 1000; //!< Delay between first and second window
Mike Fiore 16:b630e18103e5 104 const uint16_t RXC_OFFSET = 50; //!< Time between end of RXC after TX and RX1
Mike Fiore 16:b630e18103e5 105
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 106 const uint16_t BEACON_PREAMBLE_LENGTH = 10U; //!< Beacon preamble length
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 107 const uint16_t DEFAULT_BEACON_PERIOD = 128U; //!< Default period of the beacon (in seconds)
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 108 const uint16_t PING_SLOT_LENGTH = 30U; //!< Duration of each class B ping slot (in milliseconds)
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 109 const uint16_t BEACON_RESERVED_TIME = 2120U; //!< Time reserved for beacon broadcast (in milliseconds)
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 110 const uint16_t BEACON_GUARD_TIME = 3000U; //!< Guard time before beacon transmission where no ping slots can be scheduled (in milliseconds)
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 111 const uint32_t MAX_BEACONLESS_OP_TIME = 7200U; //!< Maximum time to operate in class B since last beacon received (in seconds)
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 112 const uint16_t MAX_CLASS_B_WINDOW_GROWTH = 3U; //!< Maximum window growth factor for beacons and ping slots in beacon-less operation
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 113 const uint16_t DEFAULT_PING_NB = 1U; //!< Default number of ping slots per beacon interval
Mike Fiore 16:b630e18103e5 114
Mike Fiore 16:b630e18103e5 115 const int16_t DEFAULT_FREE_CHAN_RSSI_THRESHOLD = -90; //!< Threshold for channel activity detection (CAD) dBm
Mike Fiore 16:b630e18103e5 116
Mike Fiore 16:b630e18103e5 117 const uint8_t CHAN_MASK_SIZE = 16; //!< Number of bits in a channel mask
Mike Fiore 16:b630e18103e5 118 const uint8_t COMMANDS_BUFFER_SIZE = 15; //!< Size of Mac Command buffer
Mike Fiore 16:b630e18103e5 119
Mike Fiore 16:b630e18103e5 120 const uint8_t PKT_HEADER = 0; //!< Index to packet mHdr field
Mike Fiore 16:b630e18103e5 121 const uint8_t PKT_ADDRESS = 1; //!< Index to first byte of packet address field
Mike Fiore 16:b630e18103e5 122 const uint8_t PKT_FRAME_CONTROL = PKT_ADDRESS + 4; //!< Index to packet fCtrl field @see UplinkControl
Mike Fiore 16:b630e18103e5 123 const uint8_t PKT_FRAME_COUNTER = PKT_FRAME_CONTROL + 1; //!< Index to packet frame counter field
Mike Fiore 16:b630e18103e5 124 const uint8_t PKT_OPTIONS_START = PKT_FRAME_COUNTER + 2; //!< Index to start of optional mac commands
Mike Fiore 16:b630e18103e5 125
Mike Fiore 16:b630e18103e5 126 const uint8_t PKT_JOIN_APP_NONCE = 1; //!< Index to application nonce in Join Accept message
Mike Fiore 16:b630e18103e5 127 const uint8_t PKT_JOIN_NETWORK_ID = 4; //!< Index to network id in Join Accept message
Mike Fiore 16:b630e18103e5 128 const uint8_t PKT_JOIN_NETWORK_ADDRESS = 7; //!< Index to network address in Join Accept message
Mike Fiore 16:b630e18103e5 129 const uint8_t PKT_JOIN_DL_SETTINGS = 11; //!< Index to downlink settings in Join Accept message
Mike Fiore 16:b630e18103e5 130 const uint8_t PKT_JOIN_RX_DELAY = 12; //!< Index to rx delay in Join Accept message
Mike Fiore 16:b630e18103e5 131
Jenkins@KEILDM1.dc.multitech.prv 182:b642f4d0c95b 132 const uint8_t DEFAULT_ADR_ACK_LIMIT = 64; //!< Number of packets without ADR ACK Request
Jenkins@KEILDM1.dc.multitech.prv 182:b642f4d0c95b 133 const uint8_t DEFAULT_ADR_ACK_DELAY = 32; //!< Number of packets to expect ADR ACK Response within
Mike Fiore 16:b630e18103e5 134
Mike Fiore 16:b630e18103e5 135 const uint16_t ACK_TIMEOUT = 2000; //!< Base millisecond timeout to resend after missed ACK
Mike Fiore 16:b630e18103e5 136 const uint16_t ACK_TIMEOUT_RND = 1000; //!< Random millisecond adjustment to resend after missed ACK
Mike Fiore 16:b630e18103e5 137
Mike Fiore 16:b630e18103e5 138 const uint8_t FRAME_OVERHEAD = 13; //!< Bytes of network info overhead in a frame
Mike Fiore 16:b630e18103e5 139
Jenkins@KEILDM1.dc.multitech.prv 138:10ab1fc347b3 140 const uint16_t MAX_OFF_AIR_WAIT = 5000U; //!< Max time in ms to block for a duty cycle restriction to expire before erroring out
Mike Fiore 16:b630e18103e5 141 /**
Mike Fiore 16:b630e18103e5 142 * Settings for type of network
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 143 *
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 144 * PRIVATE_MTS - Sync Word 0x12, US/AU Downlink frequencies per Frequency Sub Band
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 145 * PUBLIC_LORAWAN - Sync Word 0x34
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 146 * PRIVATE_LORAWAN - Sync Word 0x12
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 147 * PEER_TO_PEER - Sync Word 0x56 used for Dot to Dot communication
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 148 *
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 149 * Join Delay window settings are independent of Network Type setting
Mike Fiore 16:b630e18103e5 150 */
Mike Fiore 16:b630e18103e5 151 enum NetworkType {
Jenkins@KEILDM1.dc.multitech.prv 134:e5ad4bd55ce5 152 PRIVATE_MTS = 0,
Jenkins@KEILDM1.dc.multitech.prv 134:e5ad4bd55ce5 153 PUBLIC_LORAWAN = 1,
Jenkins@KEILDM1.dc.multitech.prv 134:e5ad4bd55ce5 154 PRIVATE_LORAWAN = 2,
Mike Fiore 16:b630e18103e5 155 PEER_TO_PEER = 4
Mike Fiore 16:b630e18103e5 156 };
Mike Fiore 16:b630e18103e5 157
Mike Fiore 16:b630e18103e5 158 /**
Mike Fiore 16:b630e18103e5 159 * Enum for on/off settings
Mike Fiore 16:b630e18103e5 160 */
Mike Fiore 16:b630e18103e5 161 enum Enabled {
Mike Fiore 16:b630e18103e5 162 OFF = 0,
Mike Fiore 16:b630e18103e5 163 ON = 1
Mike Fiore 16:b630e18103e5 164 };
Mike Fiore 16:b630e18103e5 165
Mike Fiore 16:b630e18103e5 166 /**
Mike Fiore 16:b630e18103e5 167 * Return status of mac functions
Mike Fiore 16:b630e18103e5 168 */
Mike Fiore 16:b630e18103e5 169 enum MacStatus {
Mike Fiore 16:b630e18103e5 170 LORA_OK = 0,
Mike Fiore 16:b630e18103e5 171 LORA_ERROR = 1,
Mike Fiore 16:b630e18103e5 172 LORA_JOIN_ERROR = 2,
Mike Fiore 16:b630e18103e5 173 LORA_SEND_ERROR = 3,
Mike Fiore 16:b630e18103e5 174 LORA_MIC_ERROR = 4,
Mike Fiore 16:b630e18103e5 175 LORA_ADDRESS_ERROR = 5,
Mike Fiore 16:b630e18103e5 176 LORA_NO_CHANS_ENABLED = 6,
Mike Fiore 16:b630e18103e5 177 LORA_COMMAND_BUFFER_FULL = 7,
Mike Fiore 16:b630e18103e5 178 LORA_UNKNOWN_MAC_COMMAND = 8,
Mike Fiore 16:b630e18103e5 179 LORA_ADR_OFF = 9,
Mike Fiore 16:b630e18103e5 180 LORA_BUSY = 10,
Mike Fiore 16:b630e18103e5 181 LORA_LINK_BUSY = 11,
Mike Fiore 16:b630e18103e5 182 LORA_RADIO_BUSY = 12,
Mike Fiore 16:b630e18103e5 183 LORA_BUFFER_FULL = 13,
Mike Fiore 16:b630e18103e5 184 LORA_JOIN_BACKOFF = 14,
Mike Fiore 16:b630e18103e5 185 LORA_NO_FREE_CHAN = 15,
Mike Fiore 16:b630e18103e5 186 LORA_AGGREGATED_DUTY_CYCLE = 16,
Jenkins@KEILDM1.dc.multitech.prv 26:17479e0039f6 187 LORA_MAC_COMMAND_ERROR = 17,
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 188 LORA_MAX_PAYLOAD_EXCEEDED = 18,
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 189 LORA_LBT_CHANNEL_BUSY = 19
Mike Fiore 16:b630e18103e5 190 };
Mike Fiore 16:b630e18103e5 191
Mike Fiore 16:b630e18103e5 192 /**
Mike Fiore 16:b630e18103e5 193 * State for Link
Mike Fiore 16:b630e18103e5 194 */
Mike Fiore 16:b630e18103e5 195 enum LinkState {
Mike Fiore 16:b630e18103e5 196 LINK_IDLE = 0, //!< Link ready to send or receive
Mike Fiore 16:b630e18103e5 197 LINK_TX, //!< Link is busy sending
Mike Fiore 16:b630e18103e5 198 LINK_ACK_TX, //!< Link is busy resending after missed ACK
Mike Fiore 16:b630e18103e5 199 LINK_REP_TX, //!< Link is busy repeating
Mike Fiore 16:b630e18103e5 200 LINK_RX, //!< Link has receive window open
Mike Fiore 16:b630e18103e5 201 LINK_RX1, //!< Link has first received window open
Mike Fiore 16:b630e18103e5 202 LINK_RX2, //!< Link has second received window open
Mike Fiore 16:b630e18103e5 203 LINK_RXC, //!< Link has class C received window open
Mike Fiore 16:b630e18103e5 204 LINK_P2P, //!< Link is busy sending
Mike Fiore 16:b630e18103e5 205 };
Mike Fiore 16:b630e18103e5 206
Mike Fiore 16:b630e18103e5 207 /**
Mike Fiore 16:b630e18103e5 208 * State for MAC
Mike Fiore 16:b630e18103e5 209 */
Mike Fiore 16:b630e18103e5 210 enum MacState {
Mike Fiore 16:b630e18103e5 211 MAC_IDLE,
Mike Fiore 16:b630e18103e5 212 MAC_RX1,
Mike Fiore 16:b630e18103e5 213 MAC_RX2,
Mike Fiore 16:b630e18103e5 214 MAC_RXC,
jreiss 17:306ffaa5d79b 215 MAC_TX,
jreiss 17:306ffaa5d79b 216 MAC_JOIN
Mike Fiore 16:b630e18103e5 217 };
Mike Fiore 16:b630e18103e5 218
Mike Fiore 16:b630e18103e5 219 /**
Mike Fiore 16:b630e18103e5 220 * Operation class for device
Mike Fiore 16:b630e18103e5 221 */
Mike Fiore 16:b630e18103e5 222 enum MoteClass {
Mike Fiore 16:b630e18103e5 223 CLASS_A = 0x00, //!< Device can only receive in windows opened after a transmit
Mike Fiore 16:b630e18103e5 224 CLASS_B = 0x01, //!< Device can receive in windows sychronized with gateway beacon
Mike Fiore 16:b630e18103e5 225 CLASS_C = 0x02 //!< Device can receive any time when not transmitting
Mike Fiore 16:b630e18103e5 226 };
Mike Fiore 16:b630e18103e5 227
Mike Fiore 16:b630e18103e5 228 /**
Mike Fiore 16:b630e18103e5 229 * Direction of a packet
Mike Fiore 16:b630e18103e5 230 */
Mike Fiore 16:b630e18103e5 231 enum Direction {
Mike Fiore 16:b630e18103e5 232 DIR_UP = 0, //!< Packet is sent from mote to gateway
Mike Fiore 16:b630e18103e5 233 DIR_DOWN = 1, //!< Packet was received from gateway
Mike Fiore 16:b630e18103e5 234 DIR_PEER = 2 //!< Packet was received from peer
Mike Fiore 16:b630e18103e5 235 };
Mike Fiore 16:b630e18103e5 236
Mike Fiore 16:b630e18103e5 237
Mike Fiore 16:b630e18103e5 238 /**
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 239 * Receive window used by Link
Mike Fiore 16:b630e18103e5 240 */
Mike Fiore 16:b630e18103e5 241 enum ReceiveWindows {
Mike Fiore 16:b630e18103e5 242 RX_1 = 1, //!< First receive window
Mike Fiore 16:b630e18103e5 243 RX_2, //!< Second receive window
Mike Fiore 16:b630e18103e5 244 RX_BEACON, //!< Beacon receive window
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 245 RX_SLOT, //!< Ping slot receive window
Jenkins@KEILDM1.dc.multitech.prv 146:eb7bca47f6d8 246 RXC, //!< Class C continuous window
Mike Fiore 16:b630e18103e5 247 RX_TEST
Mike Fiore 16:b630e18103e5 248 };
Mike Fiore 16:b630e18103e5 249
Mike Fiore 16:b630e18103e5 250 /**
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 251 * Beacon info descriptors for the GwSpecific Info field
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 252 */
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 253 enum BeaconInfoDesc {
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 254 GPS_FIRST_ANTENNA = 0, //!< GPS coordinates of the gateway's first antenna
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 255 GPS_SECOND_ANTENNA, //!< GPS coordinates of the gateway's second antenna
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 256 GPS_THIRD_ANTENNA, //!< GPS coordinates of the gateway's third antenna
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 257 };
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 258
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 259 /**
Mike Fiore 16:b630e18103e5 260 * Datarate range for a Channel
Mike Fiore 16:b630e18103e5 261 */
Mike Fiore 16:b630e18103e5 262 typedef union {
Mike Fiore 16:b630e18103e5 263 int8_t Value;
Mike Fiore 16:b630e18103e5 264 struct {
Mike Fiore 16:b630e18103e5 265 int8_t Min :4;
Mike Fiore 16:b630e18103e5 266 int8_t Max :4;
Mike Fiore 16:b630e18103e5 267 } Fields;
Mike Fiore 16:b630e18103e5 268 } DatarateRange;
Mike Fiore 16:b630e18103e5 269
Mike Fiore 16:b630e18103e5 270 /**
Mike Fiore 16:b630e18103e5 271 * Datarate used for transmitting and receiving
Mike Fiore 16:b630e18103e5 272 */
Mike Fiore 16:b630e18103e5 273 typedef struct Datarate {
Mike Fiore 16:b630e18103e5 274 uint8_t Index;
Mike Fiore 16:b630e18103e5 275 uint8_t Bandwidth;
Mike Fiore 16:b630e18103e5 276 uint8_t Coderate;
Mike Fiore 16:b630e18103e5 277 uint8_t PreambleLength;
Mike Fiore 16:b630e18103e5 278 uint8_t SpreadingFactor;
Mike Fiore 16:b630e18103e5 279 uint8_t Crc;
Mike Fiore 16:b630e18103e5 280 uint8_t TxIQ;
Mike Fiore 16:b630e18103e5 281 uint8_t RxIQ;
Mike Fiore 16:b630e18103e5 282 uint8_t SymbolTimeout();
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 283 float Timeout();
Mike Fiore 16:b630e18103e5 284 Datarate();
Mike Fiore 16:b630e18103e5 285 } Datarate;
Mike Fiore 16:b630e18103e5 286
Mike Fiore 16:b630e18103e5 287 /**
Mike Fiore 16:b630e18103e5 288 * Channel used for transmitting
Mike Fiore 16:b630e18103e5 289 */
Mike Fiore 16:b630e18103e5 290 typedef struct {
Mike Fiore 16:b630e18103e5 291 uint8_t Index;
Mike Fiore 16:b630e18103e5 292 uint32_t Frequency;
Mike Fiore 16:b630e18103e5 293 DatarateRange DrRange;
Mike Fiore 16:b630e18103e5 294 } Channel;
Mike Fiore 16:b630e18103e5 295
Mike Fiore 16:b630e18103e5 296 /**
Mike Fiore 16:b630e18103e5 297 * Receive window
Mike Fiore 16:b630e18103e5 298 */
Mike Fiore 16:b630e18103e5 299 typedef struct {
Mike Fiore 16:b630e18103e5 300 uint8_t Index;
Mike Fiore 16:b630e18103e5 301 uint32_t Frequency;
Mike Fiore 16:b630e18103e5 302 uint8_t DatarateIndex;
Mike Fiore 16:b630e18103e5 303 } RxWindow;
Mike Fiore 16:b630e18103e5 304
Mike Fiore 16:b630e18103e5 305 /**
Mike Fiore 16:b630e18103e5 306 * Duty band for limiting time-on-air for regional regulations
Mike Fiore 16:b630e18103e5 307 */
Mike Fiore 16:b630e18103e5 308 typedef struct {
Mike Fiore 16:b630e18103e5 309 uint8_t Index;
Mike Fiore 16:b630e18103e5 310 uint32_t FrequencyMin;
Mike Fiore 16:b630e18103e5 311 uint32_t FrequencyMax;
Mike Fiore 16:b630e18103e5 312 uint8_t PowerMax;
Mike Fiore 16:b630e18103e5 313 uint16_t DutyCycle; //!< Multiplier of time on air, 0:100%, 1:50%, 2:33%, 10:10%, 100:1%, 1000,0.1%
Mike Fiore 16:b630e18103e5 314 uint32_t TimeOffEnd; //!< Timestamp when this band will be available
Mike Fiore 16:b630e18103e5 315 } DutyBand;
Mike Fiore 16:b630e18103e5 316
Mike Fiore 16:b630e18103e5 317 /**
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 318 * Beacon data content (w/o CRCs and RFUs)
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 319 */
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 320 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 321 uint32_t Time;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 322 uint8_t InfoDesc;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 323 uint32_t Latitude;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 324 uint32_t Longitude;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 325 } BeaconData_t;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 326
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 327 /**
Mike Fiore 16:b630e18103e5 328 * Device configuration
Mike Fiore 16:b630e18103e5 329 */
Mike Fiore 16:b630e18103e5 330 typedef struct {
Mike Fiore 16:b630e18103e5 331 uint8_t FrequencyBand; //!< Used to choose ChannelPlan
Mike Fiore 16:b630e18103e5 332 uint8_t EUI[8]; //!< Unique identifier assigned to device
Mike Fiore 16:b630e18103e5 333 } DeviceConfig;
Mike Fiore 16:b630e18103e5 334
Mike Fiore 16:b630e18103e5 335 /**
Mike Fiore 16:b630e18103e5 336 * Network configuration
Mike Fiore 16:b630e18103e5 337 */
Mike Fiore 16:b630e18103e5 338 typedef struct {
Mike Fiore 16:b630e18103e5 339 uint8_t Mode; //!< PUBLIC, PRIVATE or PEER_TO_PEER network mode
Mike Fiore 16:b630e18103e5 340 uint8_t Class; //!< Operating class of device
Mike Fiore 16:b630e18103e5 341 uint8_t EUI[8]; //!< Network ID or AppEUI
Mike Fiore 16:b630e18103e5 342 uint8_t Key[16]; //!< Network Key or AppKey
Mike Fiore 16:b630e18103e5 343 uint8_t JoinDelay; //!< Number of seconds to wait before 1st RX Window
Mike Fiore 16:b630e18103e5 344 uint8_t RxDelay; //!< Number of seconds to wait before 1st RX Window
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 345 uint8_t FrequencySubBand; //!< FrequencySubBand used for US915 hybrid operation 0:72 channels, 1:1-8 channels ...
Mike Fiore 16:b630e18103e5 346 uint8_t AckAttempts; //!< Number of attempts to send packet and receive an ACK from server
Mike Fiore 16:b630e18103e5 347 uint8_t Retries; //!< Number of times to resend a packet without receiving an ACK, redundancy
Mike Fiore 16:b630e18103e5 348 uint8_t ADREnabled; //!< Enable adaptive datarate
Jenkins@KEILDM1.dc.multitech.prv 182:b642f4d0c95b 349 uint16_t AdrAckLimit; //!< Number of uplinks without a downlink to allow before setting ADRACKReq
Jenkins@KEILDM1.dc.multitech.prv 182:b642f4d0c95b 350 uint16_t AdrAckDelay; //!< Number of downlinks to expect ADR ACK Response within
Mike Fiore 16:b630e18103e5 351 uint8_t CADEnabled; //!< Enable listen before talk/channel activity detection
Mike Fiore 16:b630e18103e5 352 uint8_t RepeaterMode; //!< Limit payloads to repeater compatible sizes
Mike Fiore 16:b630e18103e5 353 uint8_t TxPower; //!< Default radio output power in dBm
Mike Fiore 16:b630e18103e5 354 uint8_t TxPowerMax; //!< Max transmit power
Mike Fiore 16:b630e18103e5 355 uint8_t TxDatarate; //!< Datarate for P2P transmit
Mike Fiore 16:b630e18103e5 356 uint32_t TxFrequency; //!< Frequency for P2P transmit
Mike Fiore 16:b630e18103e5 357 int8_t AntennaGain; //!< Antenna Gain
Mike Fiore 16:b630e18103e5 358 uint8_t DisableEncryption; //!< Disable Encryption
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 359 uint8_t DisableCRC; //!< Disable CRC on uplink packets
Mike Fiore 16:b630e18103e5 360 uint16_t P2PACKTimeout;
Mike Fiore 16:b630e18103e5 361 uint16_t P2PACKBackoff;
Mike Fiore 16:b630e18103e5 362 uint8_t JoinRx1DatarateOffset; //!< Offset for datarate for first window
Mike Fiore 16:b630e18103e5 363 uint32_t JoinRx2Frequency; //!< Frequency used in second window
Mike Fiore 16:b630e18103e5 364 uint8_t JoinRx2DatarateIndex; //!< Datarate for second window
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 365 uint8_t PingPeriodicity; //!< Number of ping slots to open in a beacon interval (2^(7-PingPeriodicity))
Mike Fiore 16:b630e18103e5 366 } NetworkConfig;
Mike Fiore 16:b630e18103e5 367
Mike Fiore 16:b630e18103e5 368 /**
Mike Fiore 16:b630e18103e5 369 * Network session info
Mike Fiore 16:b630e18103e5 370 * Some settings are acquired in join message and others may be changed through Mac Commands from server
Mike Fiore 16:b630e18103e5 371 */
Mike Fiore 16:b630e18103e5 372 typedef struct {
Mike Fiore 16:b630e18103e5 373 uint8_t Joined; //!< State of session
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 374 uint8_t Class; //!< Operating class of device
Mike Fiore 16:b630e18103e5 375 uint8_t Rx1DatarateOffset; //!< Offset for datarate for first window
Mike Fiore 16:b630e18103e5 376 uint32_t Rx2Frequency; //!< Frequency used in second window
Mike Fiore 16:b630e18103e5 377 uint8_t Rx2DatarateIndex; //!< Datarate for second window
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 378 uint32_t BeaconFrequency; //!< Frequency used for the beacon window
Jenkins@KEILDM1.dc.multitech.prv 178:8f7d93f3bbb5 379 bool BeaconFreqHop; //!< Beacon frequency hopping enable
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 380 uint32_t PingSlotFrequency; //!< Frequency used for ping slot windows
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 381 uint8_t PingSlotDatarateIndex; //!< Datarate for the ping slots
Jenkins@KEILDM1.dc.multitech.prv 178:8f7d93f3bbb5 382 bool PingSlotFreqHop; //!< Ping slot frequency hopping enable
Mike Fiore 16:b630e18103e5 383 uint8_t TxPower; //!< Current total radiated output power in dBm
Mike Fiore 16:b630e18103e5 384 uint8_t TxDatarate; //!< Current datarate can be changed when ADR is enabled
Mike Fiore 16:b630e18103e5 385 uint32_t Address; //!< Network address
Mike Fiore 16:b630e18103e5 386 uint32_t NetworkID; //!< Network ID 24-bits
Mike Fiore 16:b630e18103e5 387 uint8_t NetworkSessionKey[16]; //!< Network session key
Mike Fiore 16:b630e18103e5 388 uint8_t ApplicationSessionKey[16]; //!< Data session key
Mike Fiore 16:b630e18103e5 389 uint16_t ChannelMask[4]; //!< Current channel mask
Mike Fiore 16:b630e18103e5 390 uint16_t ChannelMask500k; //!< Current channel mask for 500k channels
Mike Fiore 16:b630e18103e5 391 uint32_t DownlinkCounter; //!< Downlink counter of last packet received from server
Mike Fiore 16:b630e18103e5 392 uint32_t UplinkCounter; //!< Uplink counter of last packet received from server
Mike Fiore 16:b630e18103e5 393 uint8_t Redundancy; //!< Number of time to repeat an uplink
Mike Fiore 16:b630e18103e5 394 uint8_t MaxDutyCycle; //!< Current Max Duty Cycle value
Mike Fiore 16:b630e18103e5 395 uint32_t JoinTimeOnAir; //!< Balance of time on air used during join attempts
Mike Fiore 16:b630e18103e5 396 uint32_t JoinTimeOffEnd; //!< RTC time of next join attempt
Mike Fiore 16:b630e18103e5 397 uint32_t JoinFirstAttempt; //!< RTC time of first failed join attempt
Mike Fiore 16:b630e18103e5 398 uint32_t AggregatedTimeOffEnd; //!< Time off air expiration for aggregate duty cycle
Mike Fiore 16:b630e18103e5 399 uint16_t AggregateDutyCycle; //!< Used for enforcing time-on-air
Mike Fiore 16:b630e18103e5 400 uint8_t AckCounter; //!< Current number of packets sent without ACK from server
Mike Fiore 16:b630e18103e5 401 uint8_t AdrCounter; //!< Current number of packets received without downlink from server
Mike Fiore 16:b630e18103e5 402 uint8_t RxDelay; //!< Number of seconds to wait before 1st RX Window
Mike Fiore 16:b630e18103e5 403 uint8_t CommandBuffer[COMMANDS_BUFFER_SIZE]; //!< Buffer to hold Mac Commands and parameters to be sent in next packet
Mike Fiore 16:b630e18103e5 404 uint8_t CommandBufferIndex; //!< Index to place next Mac Command, also current size of Command Buffer
Mike Fiore 16:b630e18103e5 405 bool SrvRequestedAck; //!< Indicator of ACK requested by server in last packet received
Mike Fiore 16:b630e18103e5 406 bool DataPending; //!< Indicator of data pending at server
Mike Fiore 16:b630e18103e5 407 uint8_t RxTimingSetupReqReceived; //!< Indicator that RxTimingSetupAns should be included in uplink
Mike Fiore 16:b630e18103e5 408 uint8_t RxParamSetupReqAnswer; //!< Indicator that RxParamSetupAns should be included in uplink
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 409 uint8_t DlChannelReqAnswer; //!< Indicator that DlChannelAns should be included in uplink
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 410 uint8_t DownlinkDwelltime; //!< On air dwell time for downlink packets 0:NONE,1:400ms
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 411 uint8_t UplinkDwelltime; //!< On air dwell time for uplink packets 0:NONE,1:400ms
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 412 uint8_t Max_EIRP; //!< Maximum allowed EIRP for uplink
Mike Fiore 16:b630e18103e5 413 } NetworkSession;
Mike Fiore 16:b630e18103e5 414
Mike Fiore 16:b630e18103e5 415 /**
Mike Fiore 16:b630e18103e5 416 * Multicast session info
Mike Fiore 16:b630e18103e5 417 */
Mike Fiore 16:b630e18103e5 418 typedef struct {
Mike Fiore 16:b630e18103e5 419 uint32_t Address; //!< Network address
Mike Fiore 16:b630e18103e5 420 uint8_t NetworkSessionKey[16]; //!< Network session key
Mike Fiore 16:b630e18103e5 421 uint8_t DataSessionKey[16]; //!< Data session key
Mike Fiore 16:b630e18103e5 422 uint32_t DownlinkCounter; //!< Downlink counter of last packet received from server
Mike Fiore 16:b630e18103e5 423 } MulticastSession;
Mike Fiore 16:b630e18103e5 424
Mike Fiore 16:b630e18103e5 425 /**
Mike Fiore 16:b630e18103e5 426 * Application configuration
Mike Fiore 16:b630e18103e5 427 */
Mike Fiore 16:b630e18103e5 428 typedef struct {
Mike Fiore 16:b630e18103e5 429 uint8_t Port; //!< Port used by application
Mike Fiore 16:b630e18103e5 430 uint8_t AppEUI; //!< Application ID
Mike Fiore 16:b630e18103e5 431 uint8_t AppKey[16]; //!< Application Key
Mike Fiore 16:b630e18103e5 432 } ApplicationConfig;
Mike Fiore 16:b630e18103e5 433
Mike Fiore 16:b630e18103e5 434 /**
Mike Fiore 16:b630e18103e5 435 * Statistics of current network session
Mike Fiore 16:b630e18103e5 436 */
Mike Fiore 16:b630e18103e5 437 typedef struct Statistics {
Mike Fiore 16:b630e18103e5 438 uint32_t Up; //!< Number of uplink packets sent
Mike Fiore 16:b630e18103e5 439 uint32_t Down; //!< Number of downlink packets received
Mike Fiore 16:b630e18103e5 440 uint32_t Joins; //!< Number of join requests sent
Mike Fiore 16:b630e18103e5 441 uint32_t JoinFails; //!< Number of join requests without response or invalid response
Mike Fiore 16:b630e18103e5 442 uint32_t MissedAcks; //!< Number of missed acknowledgement attempts of confirmed packets
Mike Fiore 16:b630e18103e5 443 uint32_t CRCErrors; //!< Number of CRC errors in received packets
Mike Fiore 16:b630e18103e5 444 int32_t AvgCount; //!< Number of packets used to compute rolling average of RSSI and SNR
Mike Fiore 16:b630e18103e5 445 int16_t Rssi; //!< RSSI of last packet received
Mike Fiore 16:b630e18103e5 446 int16_t RssiMin; //!< Minimum RSSI of last AvgCount packets
Mike Fiore 16:b630e18103e5 447 int16_t RssiMax; //!< Maximum RSSI of last AvgCount packets
Mike Fiore 16:b630e18103e5 448 int16_t RssiAvg; //!< Rolling average RSSI of last AvgCount packets
Mike Fiore 16:b630e18103e5 449 int16_t Snr; //!< SNR of last packet received
Mike Fiore 16:b630e18103e5 450 int16_t SnrMin; //!< Minimum SNR of last AvgCount packets
Mike Fiore 16:b630e18103e5 451 int16_t SnrMax; //!< Maximum SNR of last AvgCount packets
Mike Fiore 16:b630e18103e5 452 int16_t SnrAvg; //!< Rolling average SNR of last AvgCount packets
Mike Fiore 16:b630e18103e5 453 } Statistics;
Mike Fiore 16:b630e18103e5 454
Mike Fiore 16:b630e18103e5 455 /**
Mike Fiore 16:b630e18103e5 456 * Testing settings
Mike Fiore 16:b630e18103e5 457 */
Mike Fiore 16:b630e18103e5 458 typedef struct {
Mike Fiore 16:b630e18103e5 459 uint8_t TestMode;
Mike Fiore 16:b630e18103e5 460 uint8_t SkipMICCheck;
Mike Fiore 16:b630e18103e5 461 uint8_t DisableDutyCycle;
Mike Fiore 16:b630e18103e5 462 uint8_t DisableRx1;
Mike Fiore 16:b630e18103e5 463 uint8_t DisableRx2;
Mike Fiore 16:b630e18103e5 464 uint8_t FixedUplinkCounter;
Mike Fiore 16:b630e18103e5 465 uint8_t DisableRandomJoinDatarate;
Mike Fiore 16:b630e18103e5 466 } Testing;
Mike Fiore 16:b630e18103e5 467
Mike Fiore 16:b630e18103e5 468 /**
Mike Fiore 16:b630e18103e5 469 * Combination of device, network, testing settings and statistics
Mike Fiore 16:b630e18103e5 470 */
Mike Fiore 16:b630e18103e5 471 typedef struct {
Mike Fiore 16:b630e18103e5 472 DeviceConfig Device;
Mike Fiore 16:b630e18103e5 473 NetworkConfig Network;
Mike Fiore 16:b630e18103e5 474 NetworkSession Session;
Mike Fiore 16:b630e18103e5 475 ApplicationConfig Applications[MAX_APPS];
Mike Fiore 16:b630e18103e5 476 MulticastSession Multicast[MAX_MULTICAST_SESSIONS];
Mike Fiore 16:b630e18103e5 477 Statistics Stats;
Mike Fiore 16:b630e18103e5 478 Testing Test;
Mike Fiore 16:b630e18103e5 479 } Settings;
Mike Fiore 16:b630e18103e5 480
Mike Fiore 16:b630e18103e5 481 /**
Mike Fiore 16:b630e18103e5 482 * Downlink settings sent in Join Accept message
Mike Fiore 16:b630e18103e5 483 */
Mike Fiore 16:b630e18103e5 484 typedef union {
Mike Fiore 16:b630e18103e5 485 uint8_t Value;
Mike Fiore 16:b630e18103e5 486 struct {
Mike Fiore 16:b630e18103e5 487 uint8_t Rx2Datarate :4;
Mike Fiore 16:b630e18103e5 488 uint8_t Rx1Offset :3;
Mike Fiore 16:b630e18103e5 489 uint8_t RFU :1;
Mike Fiore 16:b630e18103e5 490 };
Mike Fiore 16:b630e18103e5 491 } DownlinkSettings;
Mike Fiore 16:b630e18103e5 492
Mike Fiore 16:b630e18103e5 493 /**
Mike Fiore 16:b630e18103e5 494 * Frame structure for Join Request
Mike Fiore 16:b630e18103e5 495 */
Mike Fiore 16:b630e18103e5 496 typedef struct {
Mike Fiore 16:b630e18103e5 497 uint8_t Type;
Mike Fiore 16:b630e18103e5 498 uint8_t AppEUI[8];
Mike Fiore 16:b630e18103e5 499 uint8_t DevEUI[8];
Mike Fiore 16:b630e18103e5 500 uint8_t Nonce[2];
Mike Fiore 16:b630e18103e5 501 uint8_t MIC[4];
Mike Fiore 16:b630e18103e5 502 } JoinRequestFrame;
Mike Fiore 16:b630e18103e5 503
Mike Fiore 16:b630e18103e5 504 /**
Mike Fiore 16:b630e18103e5 505 * Mac header of uplink and downlink packets
Mike Fiore 16:b630e18103e5 506 */
Mike Fiore 16:b630e18103e5 507 typedef union {
Mike Fiore 16:b630e18103e5 508 uint8_t Value;
Mike Fiore 16:b630e18103e5 509 struct {
Mike Fiore 16:b630e18103e5 510 uint8_t Major :2;
Mike Fiore 16:b630e18103e5 511 uint8_t RFU :3;
Mike Fiore 16:b630e18103e5 512 uint8_t MType :3;
Mike Fiore 16:b630e18103e5 513 } Bits;
Mike Fiore 16:b630e18103e5 514 } MacHeader;
Mike Fiore 16:b630e18103e5 515
Mike Fiore 16:b630e18103e5 516 /**
Mike Fiore 16:b630e18103e5 517 * Frame control field of uplink packets
Mike Fiore 16:b630e18103e5 518 */
Mike Fiore 16:b630e18103e5 519 typedef union {
Mike Fiore 16:b630e18103e5 520 uint8_t Value;
Mike Fiore 16:b630e18103e5 521 struct {
Mike Fiore 16:b630e18103e5 522 uint8_t OptionsLength :4;
Mike Fiore 16:b630e18103e5 523 uint8_t ClassB :1;
Mike Fiore 16:b630e18103e5 524 uint8_t Ack :1;
Mike Fiore 16:b630e18103e5 525 uint8_t AdrAckReq :1;
Mike Fiore 16:b630e18103e5 526 uint8_t Adr :1;
Mike Fiore 16:b630e18103e5 527 } Bits;
Mike Fiore 16:b630e18103e5 528 } UplinkControl;
Mike Fiore 16:b630e18103e5 529
Mike Fiore 16:b630e18103e5 530 /**
Mike Fiore 16:b630e18103e5 531 * Frame control field of downlink packets
Mike Fiore 16:b630e18103e5 532 */
Mike Fiore 16:b630e18103e5 533 typedef union {
Mike Fiore 16:b630e18103e5 534 uint8_t Value;
Mike Fiore 16:b630e18103e5 535 struct {
Mike Fiore 16:b630e18103e5 536 uint8_t OptionsLength :4;
Mike Fiore 16:b630e18103e5 537 uint8_t FPending :1;
Mike Fiore 16:b630e18103e5 538 uint8_t Ack :1;
Mike Fiore 16:b630e18103e5 539 uint8_t RFU :1;
Mike Fiore 16:b630e18103e5 540 uint8_t Adr :1;
Mike Fiore 16:b630e18103e5 541 } Bits;
Mike Fiore 16:b630e18103e5 542 } DownlinkControl;
Mike Fiore 16:b630e18103e5 543
Mike Fiore 16:b630e18103e5 544 /**
Mike Fiore 16:b630e18103e5 545 * Frame type of packet
Mike Fiore 16:b630e18103e5 546 */
Mike Fiore 16:b630e18103e5 547 typedef enum {
Mike Fiore 16:b630e18103e5 548 FRAME_TYPE_JOIN_REQ = 0x00,
Mike Fiore 16:b630e18103e5 549 FRAME_TYPE_JOIN_ACCEPT = 0x01,
Mike Fiore 16:b630e18103e5 550 FRAME_TYPE_DATA_UNCONFIRMED_UP = 0x02,
Mike Fiore 16:b630e18103e5 551 FRAME_TYPE_DATA_UNCONFIRMED_DOWN = 0x03,
Mike Fiore 16:b630e18103e5 552 FRAME_TYPE_DATA_CONFIRMED_UP = 0x04,
Mike Fiore 16:b630e18103e5 553 FRAME_TYPE_DATA_CONFIRMED_DOWN = 0x05,
Mike Fiore 16:b630e18103e5 554 FRAME_TYPE_RFU = 0x06,
Mike Fiore 16:b630e18103e5 555 FRAME_TYPE_PROPRIETARY = 0x07,
Mike Fiore 16:b630e18103e5 556 } FrameType;
Mike Fiore 16:b630e18103e5 557
Mike Fiore 16:b630e18103e5 558 /**
Mike Fiore 16:b630e18103e5 559 * LoRaWAN mote MAC commands
Mike Fiore 16:b630e18103e5 560 */
Mike Fiore 16:b630e18103e5 561 typedef enum {
Mike Fiore 16:b630e18103e5 562 /* Class A */
Mike Fiore 16:b630e18103e5 563 MOTE_MAC_LINK_CHECK_REQ = 0x02,
Mike Fiore 16:b630e18103e5 564 MOTE_MAC_LINK_ADR_ANS = 0x03,
Mike Fiore 16:b630e18103e5 565 MOTE_MAC_DUTY_CYCLE_ANS = 0x04,
Mike Fiore 16:b630e18103e5 566 MOTE_MAC_RX_PARAM_SETUP_ANS = 0x05,
Mike Fiore 16:b630e18103e5 567 MOTE_MAC_DEV_STATUS_ANS = 0x06,
Mike Fiore 16:b630e18103e5 568 MOTE_MAC_NEW_CHANNEL_ANS = 0x07,
Mike Fiore 16:b630e18103e5 569 MOTE_MAC_RX_TIMING_SETUP_ANS = 0x08,
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 570 MOTE_MAC_TX_PARAM_SETUP_ANS = 0x09,
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 571 MOTE_MAC_DL_CHANNEL_ANS = 0x0A,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 572 MOTE_MAC_REKEY_IND = 0x0B,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 573 MOTE_MAC_ADR_PARAM_SETUP_ANS = 0x0C,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 574 MOTE_MAC_DEVICE_TIME_REQ = 0x0D,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 575 MOTE_MAC_REJOIN_PARAM_SETUP_ANS = 0x0F,
Mike Fiore 16:b630e18103e5 576
Mike Fiore 16:b630e18103e5 577 /* Class B */
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 578 MOTE_MAC_PING_SLOT_INFO_REQ = 0x10,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 579 MOTE_MAC_PING_SLOT_CHANNEL_ANS = 0x11,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 580 MOTE_MAC_BEACON_TIMING_REQ = 0x12,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 581 MOTE_MAC_BEACON_FREQ_ANS = 0x13,
Mike Fiore 16:b630e18103e5 582
Mike Fiore 16:b630e18103e5 583 /* Multitech */
Mike Fiore 16:b630e18103e5 584 MOTE_MAC_PING_REQ = 0x80,
Mike Fiore 16:b630e18103e5 585 MOTE_MAC_CHANGE_CLASS = 0x81,
Mike Fiore 16:b630e18103e5 586 MOTE_MAC_MULTIPART_START_REQ = 0x82,
Mike Fiore 16:b630e18103e5 587 MOTE_MAC_MULTIPART_START_ANS = 0x83,
Mike Fiore 16:b630e18103e5 588 MOTE_MAC_MULTIPART_CHUNK = 0x84,
Mike Fiore 16:b630e18103e5 589 MOTE_MAC_MULTIPART_END_REQ = 0x85,
Mike Fiore 16:b630e18103e5 590 MOTE_MAC_MULTIPART_END_ANS = 0x86
Mike Fiore 16:b630e18103e5 591 } MoteCommand;
Mike Fiore 16:b630e18103e5 592
Mike Fiore 16:b630e18103e5 593 /*!
Mike Fiore 16:b630e18103e5 594 * LoRaWAN server MAC commands
Mike Fiore 16:b630e18103e5 595 */
Mike Fiore 16:b630e18103e5 596 typedef enum {
Mike Fiore 16:b630e18103e5 597 /* Class A */
Mike Fiore 16:b630e18103e5 598 SRV_MAC_LINK_CHECK_ANS = 0x02,
Mike Fiore 16:b630e18103e5 599 SRV_MAC_LINK_ADR_REQ = 0x03,
Mike Fiore 16:b630e18103e5 600 SRV_MAC_DUTY_CYCLE_REQ = 0x04,
Mike Fiore 16:b630e18103e5 601 SRV_MAC_RX_PARAM_SETUP_REQ = 0x05,
Mike Fiore 16:b630e18103e5 602 SRV_MAC_DEV_STATUS_REQ = 0x06,
Mike Fiore 16:b630e18103e5 603 SRV_MAC_NEW_CHANNEL_REQ = 0x07,
Mike Fiore 16:b630e18103e5 604 SRV_MAC_RX_TIMING_SETUP_REQ = 0x08,
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 605 SRV_MAC_TX_PARAM_SETUP_REQ = 0x09,
Jenkins@KEILDM1.dc.multitech.prv 81:d8f2c4e664f5 606 SRV_MAC_DL_CHANNEL_REQ = 0x0A,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 607 SRV_MAC_REKEY_CONF = 0x0B,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 608 SRV_MAC_ADR_PARAM_SETUP_REQ = 0x0C,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 609 SRV_MAC_DEVICE_TIME_ANS = 0x0D,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 610 SRV_MAC_FORCE_REJOIN_REQ = 0x0E,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 611 SRV_MAC_REJOIN_PARAM_SETUP_REQ = 0x0F,
Mike Fiore 16:b630e18103e5 612
Mike Fiore 16:b630e18103e5 613 /* Class B */
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 614 SRV_MAC_PING_SLOT_INFO_ANS = 0x10,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 615 SRV_MAC_PING_SLOT_CHANNEL_REQ = 0x11,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 616 SRV_MAC_BEACON_TIMING_ANS = 0x12,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 617 SRV_MAC_BEACON_FREQ_REQ = 0x13,
Mike Fiore 16:b630e18103e5 618
Mike Fiore 16:b630e18103e5 619 /* Multitech */
Mike Fiore 16:b630e18103e5 620 SRV_MAC_PING_ANS = 0x80,
Mike Fiore 16:b630e18103e5 621 SRV_MAC_CHANGE_CLASS = 0x81,
Mike Fiore 16:b630e18103e5 622 SRV_MAC_MULTIPART_START_REQ = 0x82,
Mike Fiore 16:b630e18103e5 623 SRV_MAC_MULTIPART_START_ANS = 0x83,
Mike Fiore 16:b630e18103e5 624 SRV_MAC_MULTIPART_CHUNK = 0x84,
Mike Fiore 16:b630e18103e5 625 SRV_MAC_MULTIPART_END_REQ = 0x85,
Mike Fiore 16:b630e18103e5 626 SRV_MAC_MULTIPART_END_ANS = 0x86
Mike Fiore 16:b630e18103e5 627 } ServerCommand;
Mike Fiore 16:b630e18103e5 628
Mike Fiore 16:b630e18103e5 629 /**
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 630 * Radio configuration options
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 631 */
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 632 typedef enum RadioCfg {
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 633 NO_RADIO_CFG,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 634 TX_RADIO_CFG,
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 635 RX_RADIO_CFG
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 636 } RadioCfg_t;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 637
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 638 /**
Mike Fiore 16:b630e18103e5 639 * Random seed for software RNG
Mike Fiore 16:b630e18103e5 640 */
Mike Fiore 16:b630e18103e5 641 void srand(uint32_t seed);
Mike Fiore 16:b630e18103e5 642
Mike Fiore 16:b630e18103e5 643 /**
Mike Fiore 16:b630e18103e5 644 * Software RNG for consistent results across differing hardware
Mike Fiore 16:b630e18103e5 645 */
Mike Fiore 16:b630e18103e5 646 int rand(void);
Mike Fiore 16:b630e18103e5 647
Mike Fiore 16:b630e18103e5 648 /**
Mike Fiore 16:b630e18103e5 649 * Generate random number bounded by min and max
Mike Fiore 16:b630e18103e5 650 */
Mike Fiore 16:b630e18103e5 651 int32_t rand_r(int32_t min, int32_t max);
Mike Fiore 16:b630e18103e5 652
Mike Fiore 16:b630e18103e5 653 uint8_t CountBits(uint16_t mask);
Mike Fiore 16:b630e18103e5 654
Mike Fiore 16:b630e18103e5 655 /**
Mike Fiore 16:b630e18103e5 656 * Copy 3-bytes network order from array into LSB of integer value
Mike Fiore 16:b630e18103e5 657 */
Mike Fiore 16:b630e18103e5 658 void CopyNetIDtoInt(const uint8_t* arr, uint32_t& val);
Mike Fiore 16:b630e18103e5 659
Mike Fiore 16:b630e18103e5 660 /**
Mike Fiore 16:b630e18103e5 661 * Copy LSB 3-bytes from integer value into array network order
Mike Fiore 16:b630e18103e5 662 */
Mike Fiore 16:b630e18103e5 663 void CopyNetIDtoArray(uint32_t val, uint8_t* arr);
Mike Fiore 16:b630e18103e5 664
Mike Fiore 16:b630e18103e5 665 /**
Mike Fiore 16:b630e18103e5 666 * Copy 4-bytes network order from array in to integer value
Mike Fiore 16:b630e18103e5 667 */
Mike Fiore 16:b630e18103e5 668 void CopyAddrtoInt(const uint8_t* arr, uint32_t& val);
Mike Fiore 16:b630e18103e5 669
Mike Fiore 16:b630e18103e5 670 /**
Mike Fiore 16:b630e18103e5 671 * Copy 4-bytes from integer in to array network order
Mike Fiore 16:b630e18103e5 672 */
Mike Fiore 16:b630e18103e5 673 void CopyAddrtoArray(uint32_t val, uint8_t* arr);
Mike Fiore 16:b630e18103e5 674
Mike Fiore 16:b630e18103e5 675 /**
Mike Fiore 16:b630e18103e5 676 * Copy 3-bytes network order from array into integer value and multiply by 100
Mike Fiore 16:b630e18103e5 677 */
Mike Fiore 16:b630e18103e5 678 void CopyFreqtoInt(const uint8_t* arr, uint32_t& freq);
Mike Fiore 16:b630e18103e5 679
Mike Fiore 16:b630e18103e5 680 /**
Mike Fiore 16:b630e18103e5 681 * Reverse memory copy
Mike Fiore 16:b630e18103e5 682 */
Mike Fiore 16:b630e18103e5 683 void memcpy_r(uint8_t *dst, const uint8_t *src, size_t n);
Mike Fiore 16:b630e18103e5 684
Mike Fiore 16:b630e18103e5 685 }
Mike Fiore 16:b630e18103e5 686
Mike Fiore 16:b630e18103e5 687 #endif
Mike Fiore 16:b630e18103e5 688