Bleeding edge development version of the xDot 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:   Dot-Examples Dot-AT-Firmware Dot-Examples TEST_FF1705 ... more

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:
Thu Feb 22 11:37:03 2018 -0600
Revision:
84:7ded4b9b3f37
Parent:
83:bc2e615d8595
Child:
121:b7c80d8c4eb2
xdot-library revision 3.0.2-53-g4c557ea and mbed-os revision mbed-os-5.5.7

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1 #ifndef MDOT_EVENT_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 2 #define MDOT_EVENT_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 3
Jenkins@KEILDM1.dc.multitech.prv 41:4174881d578f 4 #include "mbed.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 5 #include "mDot.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 6 #include "MacEvents.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 7 #include "MTSLog.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 8 #include "MTSText.h"
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 9
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 10 typedef union {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 11 uint8_t Value;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 12 struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 13 uint8_t :1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 14 uint8_t Tx :1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 15 uint8_t Rx :1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 16 uint8_t RxData :1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 17 uint8_t RxSlot :2;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 18 uint8_t LinkCheck :1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 19 uint8_t JoinAccept :1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 20 } Bits;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 21 } LoRaMacEventFlags;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 22
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 23 typedef enum {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 24 LORAMAC_EVENT_INFO_STATUS_OK = 0,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 25 LORAMAC_EVENT_INFO_STATUS_ERROR,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 26 LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 27 LORAMAC_EVENT_INFO_STATUS_RX_TIMEOUT,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 28 LORAMAC_EVENT_INFO_STATUS_RX_ERROR,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 29 LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 30 LORAMAC_EVENT_INFO_STATUS_DOWNLINK_FAIL,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 31 LORAMAC_EVENT_INFO_STATUS_ADDRESS_FAIL,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 32 LORAMAC_EVENT_INFO_STATUS_MIC_FAIL,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 33 } LoRaMacEventInfoStatus;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 34
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 35 /*!
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 36 * LoRaMAC event information
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 37 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 38 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 39 LoRaMacEventInfoStatus Status;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 40 lora::DownlinkControl Ctrl;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 41 bool TxAckReceived;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 42 bool DuplicateRx;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 43 uint8_t TxNbRetries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 44 uint8_t TxDatarate;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 45 uint8_t RxPort;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 46 uint8_t *RxBuffer;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 47 uint8_t RxBufferSize;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 48 int16_t RxRssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 49 uint8_t RxSnr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 50 uint16_t Energy;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 51 uint8_t DemodMargin;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 52 uint8_t NbGateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 53 } LoRaMacEventInfo;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 54
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 55 class mDotEvent: public lora::MacEvents {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 56 public:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 57
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 58 mDotEvent()
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 59 :
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 60 LinkCheckAnsReceived(false),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 61 DemodMargin(0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 62 NbGateways(0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 63 PacketReceived(false),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 64 RxPort(0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 65 RxPayloadSize(0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 66 PongReceived(false),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 67 PongRssi(0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 68 PongSnr(0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 69 AckReceived(false),
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 70 DuplicateRx(false),
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 71 TxNbRetries(0),
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 72 _sleep_cb(NULL)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 73 {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 74 memset(&_flags, 0, sizeof(LoRaMacEventFlags));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 75 memset(&_info, 0, sizeof(LoRaMacEventInfo));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 76 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 77
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 78 virtual ~mDotEvent() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 79 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 80
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 81 virtual void MacEvent(LoRaMacEventFlags *flags, LoRaMacEventInfo *info) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 82 if (mts::MTSLog::getLogLevel() == mts::MTSLog::TRACE_LEVEL) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 83 std::string msg = "OK";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 84 switch (info->Status) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 85 case LORAMAC_EVENT_INFO_STATUS_ERROR:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 86 msg = "ERROR";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 87 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 88 case LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 89 msg = "TX_TIMEOUT";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 90 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 91 case LORAMAC_EVENT_INFO_STATUS_RX_TIMEOUT:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 92 msg = "RX_TIMEOUT";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 93 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 94 case LORAMAC_EVENT_INFO_STATUS_RX_ERROR:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 95 msg = "RX_ERROR";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 96 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 97 case LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 98 msg = "JOIN_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 99 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 100 case LORAMAC_EVENT_INFO_STATUS_DOWNLINK_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 101 msg = "DOWNLINK_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 102 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 103 case LORAMAC_EVENT_INFO_STATUS_ADDRESS_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 104 msg = "ADDRESS_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 105 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 106 case LORAMAC_EVENT_INFO_STATUS_MIC_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 107 msg = "MIC_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 108 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 109 default:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 110 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 111 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 112 logTrace("Event: %s", msg.c_str());
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 113
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 114 logTrace("Flags Tx: %d Rx: %d RxData: %d RxSlot: %d LinkCheck: %d JoinAccept: %d",
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 115 flags->Bits.Tx, flags->Bits.Rx, flags->Bits.RxData, flags->Bits.RxSlot, flags->Bits.LinkCheck, flags->Bits.JoinAccept);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 116 logTrace("Info: Status: %d ACK: %d Retries: %d TxDR: %d RxPort: %d RxSize: %d RSSI: %d SNR: %d Energy: %d Margin: %d Gateways: %d",
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 117 info->Status, info->TxAckReceived, info->TxNbRetries, info->TxDatarate, info->RxPort, info->RxBufferSize,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 118 info->RxRssi, info->RxSnr, info->Energy, info->DemodMargin, info->NbGateways);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 119 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 120 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 121
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 122 virtual void TxStart() {
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 123 logDebug("mDotEvent - TxStart");
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 124
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 125 // Fire auto sleep cfg event if enabled
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 126 if (_sleep_cb)
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 127 _sleep_cb(mDot::AUTO_SLEEP_EVT_CFG);
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 128 }
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 129
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 130 virtual void TxDone(uint8_t dr) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 131 RxPayloadSize = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 132 LinkCheckAnsReceived = false;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 133 PacketReceived = false;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 134 AckReceived = false;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 135 DuplicateRx = false;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 136 PongReceived = false;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 137 TxNbRetries = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 138
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 139 logDebug("mDotEvent - TxDone");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 140 memset(&_flags, 0, sizeof(LoRaMacEventFlags));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 141 memset(&_info, 0, sizeof(LoRaMacEventInfo));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 142
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 143 _flags.Bits.Tx = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 144 _info.TxDatarate = dr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 145 _info.Status = LORAMAC_EVENT_INFO_STATUS_OK;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 146 Notify();
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 147
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 148 // If configured, we can sleep until the rx window opens
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 149 if (_sleep_cb)
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 150 _sleep_cb(mDot::AUTO_SLEEP_EVT_TXDONE);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 151 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 152
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 153 void Notify() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 154 MacEvent(&_flags, &_info);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 155 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 156
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 157 virtual void TxTimeout(void) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 158 logDebug("mDotEvent - TxTimeout");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 159
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 160 _flags.Bits.Tx = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 161 _info.Status = LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 162 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 163 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 164
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 165 virtual void JoinAccept(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 166 logDebug("mDotEvent - JoinAccept");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 167
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 168 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 169 _flags.Bits.JoinAccept = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 170 _info.Status = LORAMAC_EVENT_INFO_STATUS_OK;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 171 Notify();
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 172
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 173 if (_sleep_cb)
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 174 _sleep_cb(mDot::AUTO_SLEEP_EVT_CLEANUP);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 175 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 176
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 177 virtual void JoinFailed(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 178 logDebug("mDotEvent - JoinFailed");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 179
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 180 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 181 _flags.Bits.JoinAccept = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 182 _info.Status = LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 183 Notify();
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 184
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 185 if (_sleep_cb)
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 186 _sleep_cb(mDot::AUTO_SLEEP_EVT_CLEANUP);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 187 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 188
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 189 virtual void MissedAck(uint8_t retries) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 190 logDebug("mDotEvent - MissedAck : retries %u", retries);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 191 TxNbRetries = retries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 192 _info.TxNbRetries = retries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 193 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 194
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 195 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, bool dupRx) {
Jenkins@KEILDM1.dc.multitech.prv 41:4174881d578f 196 logDebug("mDotEvent - PacketRx ADDR: %08x", address);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 197 RxPort = port;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 198 PacketReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 199
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 200 memcpy(RxPayload, payload, size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 201 RxPayloadSize = size;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 202
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 203 if (ctrl.Bits.Ack) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 204 AckReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 205 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 206
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 207 DuplicateRx = dupRx;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 208
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 209 if (mts::MTSLog::getLogLevel() == mts::MTSLog::TRACE_LEVEL) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 210 std::string packet = mts::Text::bin2hexString(RxPayload, size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 211 logTrace("Payload: %s", packet.c_str());
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 212 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 213
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 214 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 215 _flags.Bits.Rx = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 216 _flags.Bits.RxData = size > 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 217 _flags.Bits.RxSlot = slot;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 218 _info.RxBuffer = payload;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 219 _info.RxBufferSize = size;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 220 _info.RxPort = port;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 221 _info.RxRssi = rssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 222 _info.RxSnr = snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 223 _info.TxAckReceived = AckReceived;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 224 _info.DuplicateRx = DuplicateRx;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 225 _info.TxNbRetries = retries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 226 _info.Status = LORAMAC_EVENT_INFO_STATUS_OK;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 227 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 228 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 229
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 230 virtual void RxDone(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 231 logDebug("mDotEvent - RxDone");
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 232
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 233 if (_sleep_cb)
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 234 _sleep_cb(mDot::AUTO_SLEEP_EVT_CLEANUP);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 235 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 236
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 237 virtual void Pong(int16_t m_rssi, int8_t m_snr, int16_t s_rssi, int8_t s_snr) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 238 logDebug("mDotEvent - Pong");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 239 PongReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 240 PongRssi = s_rssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 241 PongSnr = s_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 242 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 243
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 244 virtual void NetworkLinkCheck(int16_t m_rssi, int8_t m_snr, int8_t s_snr, uint8_t s_gateways) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 245 logDebug("mDotEvent - NetworkLinkCheck");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 246 LinkCheckAnsReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 247 DemodMargin = s_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 248 NbGateways = s_gateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 249
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 250 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 251 _flags.Bits.LinkCheck = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 252 _info.RxRssi = m_rssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 253 _info.RxSnr = m_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 254 _info.DemodMargin = s_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 255 _info.NbGateways = s_gateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 256 _info.Status = LORAMAC_EVENT_INFO_STATUS_OK;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 257 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 258 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 259
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 260 virtual void RxTimeout(uint8_t slot) {
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 261 logDebug("mDotEvent - RxTimeout on Slot %d", slot);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 262
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 263 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 264 _flags.Bits.RxSlot = slot;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 265 _info.Status = LORAMAC_EVENT_INFO_STATUS_RX_TIMEOUT;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 266 Notify();
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 267
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 268 if (_sleep_cb) {
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 269 // If this is the first rx window we can sleep until the next one
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 270 if (slot == 1)
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 271 _sleep_cb(mDot::AUTO_SLEEP_EVT_RX1_TIMEOUT);
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 272 else
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 273 _sleep_cb(mDot::AUTO_SLEEP_EVT_CLEANUP);
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 274 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 275 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 276
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 277 virtual void RxError(uint8_t slot) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 278 logDebug("mDotEvent - RxError");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 279
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 280 memset(&_flags, 0, sizeof(LoRaMacEventFlags));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 281 memset(&_info, 0, sizeof(LoRaMacEventInfo));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 282
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 283 _flags.Bits.RxSlot = slot;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 284 _info.Status = LORAMAC_EVENT_INFO_STATUS_RX_ERROR;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 285 Notify();
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 286
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 287 if (_sleep_cb)
Jenkins@KEILDM1.dc.multitech.prv 83:bc2e615d8595 288 _sleep_cb(mDot::AUTO_SLEEP_EVT_CLEANUP);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 289 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 290
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 291 virtual uint8_t MeasureBattery(void) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 292 return 255;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 293 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 294
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 295 void AttachSleepCallback(Callback<void(mDot::AutoSleepEvent_t)> cb) {
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 296 _sleep_cb = cb;
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 297 }
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 298
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 299 void DetachSleepCallback() {
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 300 _sleep_cb = NULL;
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 301 }
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 302
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 303 bool LinkCheckAnsReceived;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 304 uint8_t DemodMargin;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 305 uint8_t NbGateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 306
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 307 bool PacketReceived;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 308 uint8_t RxPort;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 309 uint8_t RxPayload[255];
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 310 uint8_t RxPayloadSize;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 311
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 312 bool PongReceived;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 313 int16_t PongRssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 314 int16_t PongSnr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 315
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 316 bool AckReceived;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 317 bool DuplicateRx;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 318 uint8_t TxNbRetries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 319
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 320 LoRaMacEventFlags& Flags() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 321 return _flags;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 322 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 323 LoRaMacEventInfo& Info() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 324 return _info;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 325 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 326
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 327 private:
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 328 /* Hook to inject a sleep method in between receive windows */
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 329 Callback<void(mDot::AutoSleepEvent_t)> _sleep_cb;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 330
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 331 LoRaMacEventFlags _flags;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 332 LoRaMacEventInfo _info;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 333
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 334 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 335 // /*!
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 336 // * MAC layer event callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 337 // *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 338 // * \param [IN] flags Bit field indicating the MAC events occurred
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 339 // * \param [IN] info Details about MAC events occurred
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 340 // */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 341 // virtual void MacEvent(LoRaMacEventFlags *flags, LoRaMacEventInfo *info) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 342 // logDebug("mDotEvent");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 343 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 344 // if (flags->Bits.Rx) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 345 // logDebug("Rx");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 346 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 347 // // Event Object must delete RxBuffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 348 // delete[] info->RxBuffer;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 349 // }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 350 // }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 351 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 352
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 353 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 354
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 355 #endif // __MDOT_EVENT_H__