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:
Fri Nov 09 14:56:50 2018 -0600
Revision:
133:4ca51f965419
Parent:
128:ff9ca3779136
xdot-library revision 3.1.0-57-g8e84ec6 and mbed-os revision mbed-os-5.10.2

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 121:b7c80d8c4eb2 66 BeaconLocked(false),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 67 PongReceived(false),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 68 PongRssi(0),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 69 PongSnr(0),
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 70 ServerTimeReceived(false),
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 71 ServerTimeSeconds(0U),
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 72 AckReceived(false),
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 73 DuplicateRx(false),
Jenkins@KEILDM1.dc.multitech.prv 124:85e19115e4a1 74 TxNbRetries(0)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 75 {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 76 memset(&_flags, 0, sizeof(LoRaMacEventFlags));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 77 memset(&_info, 0, sizeof(LoRaMacEventInfo));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 78 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 79
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 80 virtual ~mDotEvent() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 81 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 82
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 83 virtual void MacEvent(LoRaMacEventFlags *flags, LoRaMacEventInfo *info) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 84 if (mts::MTSLog::getLogLevel() == mts::MTSLog::TRACE_LEVEL) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 85 std::string msg = "OK";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 86 switch (info->Status) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 87 case LORAMAC_EVENT_INFO_STATUS_ERROR:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 88 msg = "ERROR";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 89 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 90 case LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 91 msg = "TX_TIMEOUT";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 92 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 93 case LORAMAC_EVENT_INFO_STATUS_RX_TIMEOUT:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 94 msg = "RX_TIMEOUT";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 95 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 96 case LORAMAC_EVENT_INFO_STATUS_RX_ERROR:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 97 msg = "RX_ERROR";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 98 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 99 case LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 100 msg = "JOIN_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 101 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 102 case LORAMAC_EVENT_INFO_STATUS_DOWNLINK_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 103 msg = "DOWNLINK_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 104 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 105 case LORAMAC_EVENT_INFO_STATUS_ADDRESS_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 106 msg = "ADDRESS_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 107 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 108 case LORAMAC_EVENT_INFO_STATUS_MIC_FAIL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 109 msg = "MIC_FAIL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 110 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 111 default:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 112 break;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 113 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 114 logTrace("Event: %s", msg.c_str());
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 115
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 116 logTrace("Flags Tx: %d Rx: %d RxData: %d RxSlot: %d LinkCheck: %d JoinAccept: %d",
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 117 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 118 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 119 info->Status, info->TxAckReceived, info->TxNbRetries, info->TxDatarate, info->RxPort, info->RxBufferSize,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 120 info->RxRssi, info->RxSnr, info->Energy, info->DemodMargin, info->NbGateways);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 121 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 122 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 123
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 124 virtual void TxStart() {
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 125 logDebug("mDotEvent - TxStart");
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 84:7ded4b9b3f37 133 DuplicateRx = false;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 134 PongReceived = false;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 135 TxNbRetries = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 136
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 137 logDebug("mDotEvent - TxDone");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 138 memset(&_flags, 0, sizeof(LoRaMacEventFlags));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 139 memset(&_info, 0, sizeof(LoRaMacEventInfo));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 140
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 141 _flags.Bits.Tx = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 142 _info.TxDatarate = dr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 143 _info.Status = LORAMAC_EVENT_INFO_STATUS_OK;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 144 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 145 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 146
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 147 void Notify() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 148 MacEvent(&_flags, &_info);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 149 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 150
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 151 virtual void TxTimeout(void) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 152 logDebug("mDotEvent - TxTimeout");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 153
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 154 _flags.Bits.Tx = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 155 _info.Status = LORAMAC_EVENT_INFO_STATUS_TX_TIMEOUT;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 156 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 157 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 158
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 159 virtual void JoinAccept(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 160 logDebug("mDotEvent - JoinAccept");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 161
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 162 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 163 _flags.Bits.JoinAccept = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 164 _info.Status = LORAMAC_EVENT_INFO_STATUS_OK;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 165 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 166 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 167
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 168 virtual void JoinFailed(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 169 logDebug("mDotEvent - JoinFailed");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 170
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 171 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 172 _flags.Bits.JoinAccept = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 173 _info.Status = LORAMAC_EVENT_INFO_STATUS_JOIN_FAIL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 174 Notify();
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 MissedAck(uint8_t retries) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 178 logDebug("mDotEvent - MissedAck : retries %u", retries);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 179 TxNbRetries = retries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 180 _info.TxNbRetries = retries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 181 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 182
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 183 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 184 logDebug("mDotEvent - PacketRx ADDR: %08x", address);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 185 RxPort = port;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 186 PacketReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 187
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 188 memcpy(RxPayload, payload, size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 189 RxPayloadSize = size;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 190
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 191 if (ctrl.Bits.Ack) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 192 AckReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 193 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 194
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 195 DuplicateRx = dupRx;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 196
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 197 if (mts::MTSLog::getLogLevel() == mts::MTSLog::TRACE_LEVEL) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 198 std::string packet = mts::Text::bin2hexString(RxPayload, size);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 199 logTrace("Payload: %s", packet.c_str());
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 200 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 201
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 202 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 203 _flags.Bits.Rx = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 204 _flags.Bits.RxData = size > 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 205 _flags.Bits.RxSlot = slot;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 206 _info.RxBuffer = payload;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 207 _info.RxBufferSize = size;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 208 _info.RxPort = port;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 209 _info.RxRssi = rssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 210 _info.RxSnr = snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 211 _info.TxAckReceived = AckReceived;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 212 _info.DuplicateRx = DuplicateRx;
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 128:ff9ca3779136 222 virtual void BeaconRx(const lora::BeaconData_t& beacon_data, int16_t rssi, int8_t snr) {
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 223 logDebug("mDotEvent - BeaconRx");
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 224 BeaconLocked = true;
Jenkins@KEILDM1.dc.multitech.prv 128:ff9ca3779136 225 BeaconData = beacon_data;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 226 }
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 227
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 228 virtual void BeaconLost() {
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 229 logDebug("mDotEvent - BeaconLost");
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 230 BeaconLocked = false;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 231 }
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 232
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 233 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 234 logDebug("mDotEvent - Pong");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 235 PongReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 236 PongRssi = s_rssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 237 PongSnr = s_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 238 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 239
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 240 virtual void ServerTime(uint32_t seconds, uint8_t sub_seconds) {
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 241 logDebug("mDotEvent - ServerTime");
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 242 ServerTimeReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 243 ServerTimeSeconds = seconds;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 244 }
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 245
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 246 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 247 logDebug("mDotEvent - NetworkLinkCheck");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 248 LinkCheckAnsReceived = true;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 249 DemodMargin = s_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 250 NbGateways = s_gateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 251
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 252 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 253 _flags.Bits.LinkCheck = 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 254 _info.RxRssi = m_rssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 255 _info.RxSnr = m_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 256 _info.DemodMargin = s_snr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 257 _info.NbGateways = s_gateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 258 _info.Status = LORAMAC_EVENT_INFO_STATUS_OK;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 259 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 260 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 261
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 262 virtual void RxTimeout(uint8_t slot) {
Jenkins@KEILDM1.dc.multitech.prv 61:e8eb2d72ecd6 263 logDebug("mDotEvent - RxTimeout on Slot %d", slot);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 264
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 265 _flags.Bits.Tx = 0;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 266 _flags.Bits.RxSlot = slot;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 267 _info.Status = LORAMAC_EVENT_INFO_STATUS_RX_TIMEOUT;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 268 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 269 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 270
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 271 virtual void RxError(uint8_t slot) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 272 logDebug("mDotEvent - RxError");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 273
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 274 memset(&_flags, 0, sizeof(LoRaMacEventFlags));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 275 memset(&_info, 0, sizeof(LoRaMacEventInfo));
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 276
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 277 _flags.Bits.RxSlot = slot;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 278 _info.Status = LORAMAC_EVENT_INFO_STATUS_RX_ERROR;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 279 Notify();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 280 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 281
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 282 virtual uint8_t MeasureBattery(void) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 283 return 255;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 284 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 285
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 286 bool LinkCheckAnsReceived;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 287 uint8_t DemodMargin;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 288 uint8_t NbGateways;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 289
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 290 bool PacketReceived;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 291 uint8_t RxPort;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 292 uint8_t RxPayload[255];
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 293 uint8_t RxPayloadSize;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 294
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 295 bool BeaconLocked;
Jenkins@KEILDM1.dc.multitech.prv 128:ff9ca3779136 296 lora::BeaconData_t BeaconData;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 297
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 298 bool PongReceived;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 299 int16_t PongRssi;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 300 int16_t PongSnr;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 301
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 302 bool ServerTimeReceived;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 303 uint32_t ServerTimeSeconds;
Jenkins@KEILDM1.dc.multitech.prv 121:b7c80d8c4eb2 304
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 305 bool AckReceived;
Jenkins@KEILDM1.dc.multitech.prv 84:7ded4b9b3f37 306 bool DuplicateRx;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 307 uint8_t TxNbRetries;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 308
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 309 LoRaMacEventFlags& Flags() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 310 return _flags;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 311 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 312 LoRaMacEventInfo& Info() {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 313 return _info;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 314 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 315
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 316 private:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 317 LoRaMacEventFlags _flags;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 318 LoRaMacEventInfo _info;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 319
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 320 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 321 // /*!
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 322 // * MAC layer event callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 323 // *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 324 // * \param [IN] flags Bit field indicating the MAC events occurred
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 325 // * \param [IN] info Details about MAC events occurred
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 326 // */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 327 // virtual void MacEvent(LoRaMacEventFlags *flags, LoRaMacEventInfo *info) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 328 // logDebug("mDotEvent");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 329 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 330 // if (flags->Bits.Rx) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 331 // logDebug("Rx");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 332 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 333 // // Event Object must delete RxBuffer
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 334 // delete[] info->RxBuffer;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 335 // }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 336 // }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 337 //
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 338
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 339 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 340
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 341 #endif // __MDOT_EVENT_H__