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