MultiTech / libxDot-mbed5

Stable version of the xDot library for mbed 5. This version of the library is suitable for deployment scenarios.

Dependents:   Dot-Examples XDOT-Devicewise Dot-Examples-delujoc Dot-Examples_receive ... more

Fork of libxDot-dev-mbed5-deprecated by MultiTech

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

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.

FOTA

Full FOTA support is only available with mDot, xDot does not have the required external flash. xDot can use the FOTA example to dynamically join a multicast session only. After joining the multicast session the received Fragmentation packets could be handed to a host MCU for processing and at completion the firmware can be loaded into the xDot using the bootloader and y-modem. See xDot Developer Guide.

  • Add the following code to allow Fota to use the Dot instance

examples/src/fota_example.cpp

    // Initialize FOTA singleton
    Fota::getInstance(dot);
  • Add fragmentation handling the the PacketRx event

examples/inc/RadioEvent.h

    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) {
        mDotEvent::PacketRx(port, payload, size, rssi, snr, ctrl, slot, retries, address, dupRx);

#if ACTIVE_EXAMPLE == FOTA_EXAMPLE
        if(port == 200 || port == 201 || port == 202) {
            Fota::getInstance()->processCmd(payload, port, size);
        }
#endif
    }

The FOTA implementation has a few differences from the LoRaWAN Protocol

  • Fragmentation Indexing starts at 0
  • McKEKey is 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
  • Start Time is a count-down in seconds to start of session

Diff: ChannelPlan.h

Revision:
29:fb5769f4a67c
Parent:
20:bc12c888e7dc
--- a/ChannelPlan.h	Thu Apr 02 09:18:21 2020 -0500
+++ b/ChannelPlan.h	Thu Apr 02 09:36:13 2020 -0500
@@ -193,12 +193,18 @@
             virtual uint8_t GetMaxPayloadSize();
 
             /**
+             * Get max payload size for a given datarate
+             * @return size in bytes
+             */
+            virtual uint8_t GetMaxPayloadSize(uint8_t dr);
+
+            /**
              * Get rx window settings for requested window
              * RX_1, RX_2, RX_BEACON, RX_SLOT
              * @param window
              * @return RxWindow
              */
-            virtual RxWindow GetRxWindow(uint8_t window) = 0;
+            virtual RxWindow GetRxWindow(uint8_t window, int8_t id = 0) = 0;
 
             /**
              * Get current channel to use for transmitting
@@ -271,7 +277,8 @@
             virtual uint8_t SetRxConfig(uint8_t window,
                                         bool continuous,
                                         uint16_t wnd_growth = 1,
-                                        uint16_t pad_ms = 0) = 0;
+                                        uint16_t pad_ms = 0,
+                                        int8_t id = 0);
 
             /**
              * Set frequency sub band if supported by plan
@@ -287,11 +294,6 @@
             virtual uint8_t GetFrequencySubBand();
 
             /**
-             * Reset the ack counter used to lower datarate if ACK's are missed
-             */
-            virtual void ResetAckCounter();
-
-            /**
              * Callback for radio to request channel change when frequency hopping
              * @param currentChannel
              */
@@ -578,7 +580,7 @@
              * @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,
+            virtual uint8_t DecodeBeacon(const uint8_t* payload,
                                       size_t size,
                                       BeaconData_t& data) = 0;
 
@@ -600,10 +602,12 @@
              * Search enabled channels for lowest available datarate
              */
             virtual uint8_t GetMinEnabledDatarate();
-        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
+
+        protected:
+
             /**
              * 16 bit ITU-T CRC implementation
              */
@@ -663,6 +667,8 @@
             static const uint8_t* MAX_PAYLOAD_SIZE;             //!< List of max payload sizes for each datarate
             static const uint8_t* MAX_PAYLOAD_SIZE_REPEATER;    //!< List of repeater compatible max payload sizes for each datarate
 
+            uint8_t _beaconSize;
+
             uint8_t _plan;
             std::string _planName;