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:
14:f0c24ce93427
Parent:
11:be2a6466d680
Child:
16:4a382fe8f51b
--- a/ChannelPlan.h	Thu Jul 27 11:08:40 2017 -0500
+++ b/ChannelPlan.h	Thu Aug 23 14:21:20 2018 -0500
@@ -74,6 +74,11 @@
              * ChannelPlan destructor
              */
             virtual ~ChannelPlan();
+            
+            /**
+             * Checks that at least one channel exist for the data rate
+             */
+            virtual uint8_t ValidateAdrDatarate(uint8_t status);
 
             /**
              * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
@@ -312,6 +317,16 @@
             virtual uint8_t HandleNewChannel(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status) = 0;
 
             /**
+             * Callback to for downlink channel request ServerCommand
+             * @param payload packet data
+             * @param index of start of command buffer
+             * @param size number of bytes in command buffer
+             * @param[out] status to be returned in MoteCommand answer
+             * @return LORA_OK
+             */
+            virtual uint8_t HandleDownlinkChannelReq(const uint8_t* payload, uint8_t index, uint8_t size, uint8_t& status);
+
+            /**
              * Callback to for ping slot channel request ServerCommand
              * @param payload packet data
              * @param index of start of command buffer
@@ -441,7 +456,7 @@
             /**
              * Update duty cycle with current settings
              */
-            virtual void UpdateDutyCycle(uint8_t bytes);
+            void UpdateDutyCycle(uint8_t bytes);
 
             /**
              * Update duty cycle with at given frequency and time on air
@@ -536,7 +551,12 @@
             virtual void DefaultLBT();
 
             virtual bool ListenBeforeTalk();
-
+        
+            /**
+             * use to clear downlink channels on join
+             */
+            virtual void ClearChannels();
+    
         protected:
 
             SxRadio* GetRadio();                //!< Get pointer to the SxRadio object or assert if it is null