MultiTech / libxDot-dev-mbed5-deprecated

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.

Diff: ChannelPlan.h

Revision:
121:b7c80d8c4eb2
Parent:
116:1320cce45cc9
Child:
127:db053d511848
--- a/ChannelPlan.h	Tue Aug 14 15:45:14 2018 -0500
+++ b/ChannelPlan.h	Thu Aug 30 09:06:17 2018 -0500
@@ -16,6 +16,8 @@
 #ifndef __CHANNEL_STRATEGY_H__
 #define __CHANNEL_STRATEGY_H__
 
+#include "mbed_events.h"
+
 #include "Lora.h"
 #include "SxRadio.h"
 #include <vector>
@@ -96,6 +98,11 @@
             virtual void SetSettings(Settings* settings);
 
             /**
+             * Setter for the event queue
+             */
+            virtual void SetEventQueue(EventQueue* queue);
+
+            /**
              * Get the next channel to use to transmit
              * @return LORA_OK if channel was found
              * @return LORA_NO_CHANS_ENABLED
@@ -256,9 +263,10 @@
              * Set the SxRadio rx config provided window
              * @param window to be opened
              * @param continuous keep window open
+             * @param wnd_growth factor to increase the rx window by
              * @return LORA_OK
              */
-            virtual uint8_t SetRxConfig(uint8_t window, bool continuous) = 0;
+            virtual uint8_t SetRxConfig(uint8_t window, bool continuous, uint16_t wnd_growth = 1) = 0;
 
             /**
              * Set frequency sub band if supported by plan
@@ -468,8 +476,9 @@
             /**
              * Get time on air with current settings
              * @param bytes number of bytes to be sent
+             * @param cfg for setting up the radio before getting time on air
              */
-            virtual uint32_t GetTimeOnAir(uint8_t bytes);
+            virtual uint32_t GetTimeOnAir(uint8_t bytes, RadioCfg_t cfg = TX_RADIO_CFG);
 
             /**
              * Reset the duty timers with the current time off air
@@ -556,11 +565,34 @@
              * use to clear downlink channels on join
              */
             virtual void ClearChannels();
-    
+
+            /**
+             * Check if this packet is a beacon and if so extract parameters needed
+             * @param payload of potential beacon
+             * @param size of the packet
+             * @param [out] data extracted from the beacon if this packet was indeed a beacon
+             * @return true if this packet is beacon, false if not
+             */
+            virtual bool DecodeBeacon(const uint8_t* payload,
+                                      size_t size,
+                                      BeaconData_t& data) = 0;
+
+            /**
+             * Update class B beacon and ping slot settings if frequency hopping enabled
+             * @param time received in the last beacon
+             * @param period of the beacon
+             * @param devAddr of this end device
+             */
+            virtual void FrequencyHop(uint32_t time, uint32_t period, uint32_t devAddr) { }
+
         protected:
 
             SxRadio* GetRadio();                //!< Get pointer to the SxRadio object or assert if it is null
             Settings* GetSettings();            //!< Get pointer to the settings object or assert if it is null
+            /**
+             * 16 bit ITU-T CRC implementation
+             */
+            uint16_t CRC16(const uint8_t* data, size_t size);
 
             uint8_t _txChannel;                 //!< Current channel for transmit
             uint8_t _txFrequencySubBand;        //!< Current frequency sub band for hybrid operation
@@ -578,9 +610,6 @@
             uint32_t _minFrequency;             //!< Minimum Frequency
             uint32_t _maxFrequency;             //!< Maximum Frequency
 
-            Channel _beaconChannel;             //!< Beacon window settings
-            Channel _beaconRxChannel;           //!< Beacon slot rx window settings
-
             uint8_t _minDatarate;               //!< Minimum datarate to accept in ADR request
             uint8_t _maxDatarate;               //!< Maximum datarate to accept in ADR request
 
@@ -606,11 +635,11 @@
             std::vector<uint16_t> _channelMask; //!< Bit mask for currently enabled channels
 
             Timer _dutyCycleTimer;              //!< Timer for tracking time-off-air
-            RtosTimer _txDutyTimer;             //!< Event timer for expiration of time-off-air
+            int _txDutyEvtId;                   //!< Event ID for expiration of time-off-air
 
             bool _txDutyCyclePending;           //!< Flag for pending duty cycle event
 
-            static void OnTxDutyCycleEvent(const void* arg);    //!< Rtos callback for duty cycle event
+            void OnTxDutyCycleEvent();          //!< Callback for duty cycle event
             void OnTxDutyCycleEventBottom();                    //!< Callback for duty cycle event
 
             static const uint8_t* TX_POWERS;                    //!< List of available tx powers
@@ -625,6 +654,7 @@
 
             SxRadio* _radio;                    //!< Injected SxRadio dependency
             Settings* _settings;                //!< Current settings
+            EventQueue* _evtQueue;              //!< mbed Event Queue
     };
 }