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:
Thu Sep 22 16:29:07 2016 -0500
Revision:
2:4569491293d7
Parent:
0:d8b7d49a734c
update from git revision 2.0.12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 1 #ifndef UTILS_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 2 #define UTILS_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 3
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 4 #include <string>
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 5
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 6 //Defines a max function that can be used.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 7 inline int mts_max(int a, int b) { return a > b ? a : b; }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 8
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 9 //Defines a min function that can be used.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 10 inline int mts_min(int a, int b) { return a < b ? a : b; }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 11
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 12 ///An enumeration for relational operators
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 13 enum RelationalOperator {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 14 GREATER, LESS, EQUAL, GREATER_EQUAL, LESS_EQUAL
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 15 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 16
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 17 /** A static method for getting a string representation for the RelationalOperator
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 18 * enumeration.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 19 *
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 20 * @param relationalOperator a RelationalOperator enumeration.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 21 * @returns the enumeration name as a string.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 22 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 23 static inline std::string getRelationalOperatorNames(RelationalOperator relationalOperator)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 24 {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 25 switch(relationalOperator) {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 26 case GREATER:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 27 return "GREATER";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 28 case LESS:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 29 return "LESS";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 30 case EQUAL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 31 return "EQUAL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 32 case GREATER_EQUAL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 33 return "GREATER_EQUAL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 34 case LESS_EQUAL:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 35 return "LESS_EQUAL";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 36 default:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 37 return "UNKNOWN ENUM";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 38 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 39 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 40
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 41 #endif