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: Mote.h

Revision:
35:1f130b29595b
Parent:
2:4569491293d7
Child:
41:4174881d578f
--- a/Mote.h	Fri Feb 10 11:11:11 2017 -0600
+++ b/Mote.h	Mon Jun 19 12:51:10 2017 -0500
@@ -128,10 +128,16 @@
 
     class Mote {
         public:
-            Mote(Settings* settings);
+            Mote(Settings* settings, ChannelPlan* plan);
             virtual ~Mote();
 
             /**
+             * MTS LoRa version
+             * @return string containing version information
+             */
+            const char* getId();
+
+            /**
              * Indicator for network session join status
              * @return true if joined to network
              */
@@ -159,10 +165,12 @@
 
             /**
              * Configure the channel plan
-             * @param freqBand EU868, US915, AU915
+             * @param plan pointer to ChannelPlan object
              * @return LORA_OK
              */
-            uint8_t SetChannelPlan(uint8_t freqBand);
+            uint8_t SetChannelPlan(ChannelPlan* plan);
+
+            Settings* GetSettings();
 
             /**
              * Get the channel mask of currently enabled channels
@@ -179,20 +187,20 @@
             virtual uint8_t SetChannelMask(uint8_t index, uint16_t mask);
 
             /**
-             * Set the current channel group for hybrid operation 1-8 else 0 for 64 channel operation
-             * @param group 0-8
+             * Set the current frequency sub band for hybrid operation 1-8 else 0 for 64 channel operation
+             * @param sub_band 0-8
              */
-            uint8_t SetChannelGroup(uint8_t group);
+            uint8_t SetFrequencySubBand(uint8_t sub_band);
 
             /**
-             * Get the current channel group
-             * @return group 0-8
+             * Get the current frequency sub band
+             * @return sub band 0-8
              */
-            uint8_t GetChannelGroup();
+            uint8_t GetFrequencySubBand();
 
             /**
              * Add a channel to the channel plan
-             * EU868 allows additional channels to be added
+             * EU868, AS923 and KR920 allows additional channels to be added
              * Channels 0-2 are fixed default channels
              *
              * @param index of the channel
@@ -203,12 +211,22 @@
             uint8_t AddChannel(uint8_t index, uint32_t frequency, lora::DatarateRange range);
 
             /**
+             * Add a downlink channel to the channel plan
+             * EU868, AS923 and KR920 allows downlink channels to be added
+             *
+             * @param index of the channel
+             * @param frequency of the channel or 0 to remove channel
+             * @return LORA_OK if channel was added
+             */
+            uint8_t AddDownlinkChannel(uint8_t index, uint32_t frequency);
+
+            /**
              * Set network mode
              * Choose Public LoRaWAN mode or Private Multitech mode
              *
              * Public mode uses 0x34 sync word with 5/6 second join windows
              * Private mode uses 0x12 sync word with 1/2 second join windows
-             *  US915/AU915 Rx1 and Rx2 are fixed per Channel Group setting
+             *  US915/AU915 Rx1 and Rx2 are fixed per frequency sub band setting
              *
              * @param mode public or private
              * @return LORA_OK
@@ -236,6 +254,11 @@
             Statistics& GetStats();
 
             /**
+             * Reset the current statistics for the device
+             */
+            void ResetStats();
+
+            /**
              * Get time on air with current settings for provided payload bytes
              * 13 overhead bytes will be added to payload
              * @param bytes of payload data
@@ -244,6 +267,12 @@
             uint32_t GetTimeOnAir(uint8_t bytes);
 
             /**
+             * Get time off air required to adhere to duty-cycle limitations
+             * @return time-off-air in ms
+             */
+            uint32_t GetTimeOffAir();
+
+            /**
              * Call before setting device in sleep mode to place radio in sleep
              */
             void Sleep();