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 MTSLOG_H
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 2 #define MTSLOG_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 inline const char* className(const std::string& prettyFunction)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 7 {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 8 size_t colons = prettyFunction.find_last_of("::");
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 9 if (colons == std::string::npos)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 10 return "";
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 11 size_t begin = prettyFunction.substr(0,colons).rfind(" ") + 1;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 12 size_t end = colons - begin;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 13
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 14 return prettyFunction.substr(begin,end).c_str();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 15 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 16
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 17 #define __CLASSNAME__ className(__PRETTY_FUNCTION__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 18
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 19
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 20 #ifdef MTS_DEBUG
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 21 #define logFatal(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 22 mts::MTSLog::printMessage(mts::MTSLog::FATAL_LEVEL, "%s:%s:%d| [%s] " format "\r\n", __CLASSNAME__, __func__, __LINE__, mts::MTSLog::FATAL_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 23 #define logError(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 24 mts::MTSLog::printMessage(mts::MTSLog::ERROR_LEVEL, "%s:%s:%d| [%s] " format "\r\n", __CLASSNAME__, __func__, __LINE__, mts::MTSLog::ERROR_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 25 #define logWarning(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 26 mts::MTSLog::printMessage(mts::MTSLog::WARNING_LEVEL, "%s:%s:%d| [%s] " format "\r\n", __CLASSNAME__, __func__, __LINE__, mts::MTSLog::WARNING_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 27 #define logInfo(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 28 mts::MTSLog::printMessage(mts::MTSLog::INFO_LEVEL, "%s:%s:%d| [%s] " format "\r\n", __CLASSNAME__, __func__, __LINE__, mts::MTSLog::INFO_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 29 #define logDebug(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 30 mts::MTSLog::printMessage(mts::MTSLog::DEBUG_LEVEL, "%s:%s:%d| [%s] " format "\r\n", __CLASSNAME__, __func__, __LINE__, mts::MTSLog::DEBUG_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 31 #define logTrace(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 32 mts::MTSLog::printMessage(mts::MTSLog::TRACE_LEVEL, "%s:%s:%d| [%s] " format "\r\n", __CLASSNAME__, __func__, __LINE__, mts::MTSLog::TRACE_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 33 #else
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 34 #define logFatal(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 35 mts::MTSLog::printMessage(mts::MTSLog::FATAL_LEVEL, "[%s] " format "\r\n", mts::MTSLog::FATAL_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 36 #define logError(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 37 mts::MTSLog::printMessage(mts::MTSLog::ERROR_LEVEL, "[%s] " format "\r\n", mts::MTSLog::ERROR_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 38 #define logWarning(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 39 mts::MTSLog::printMessage(mts::MTSLog::WARNING_LEVEL, "[%s] " format "\r\n", mts::MTSLog::WARNING_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 40 #define logInfo(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 41 mts::MTSLog::printMessage(mts::MTSLog::INFO_LEVEL, "[%s] " format "\r\n", mts::MTSLog::INFO_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 42 #define logDebug(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 43 mts::MTSLog::printMessage(mts::MTSLog::DEBUG_LEVEL, "[%s] " format "\r\n", mts::MTSLog::DEBUG_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 44 #define logTrace(format, ...) \
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 45 mts::MTSLog::printMessage(mts::MTSLog::TRACE_LEVEL, "[%s] " format "\r\n", mts::MTSLog::TRACE_LABEL, ##__VA_ARGS__)
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 46 #endif
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 47
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 48 namespace mts {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 49
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 50 class MTSLog
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 51 {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 52 public:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 53
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 54 /** Enum of log levels.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 55 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 56 enum logLevel {
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 57 NONE_LEVEL = 0,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 58 FATAL_LEVEL = 1,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 59 ERROR_LEVEL = 2,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 60 WARNING_LEVEL = 3,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 61 INFO_LEVEL = 4,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 62 DEBUG_LEVEL = 5,
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 63 TRACE_LEVEL = 6
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 64 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 65
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 66 /** Print log message.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 67 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 68 static void printMessage(int level, const char* format, ...);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 69
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 70 /** Determine if the given level is currently printable.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 71 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 72 static bool printable(int level);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 73
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 74 /** Set log level
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 75 * Messages with lower priority than the current level will not be printed.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 76 * If the level is set to NONE, no messages will print.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 77 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 78 static void setLogLevel(int level);
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 79
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 80 /** Get the current log level.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 81 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 82 static int getLogLevel();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 83
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 84 /** Get string representation of the current log level.
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 85 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 86 static const char* getLogLevelString();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 87
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 88 static const char* NONE_LABEL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 89 static const char* FATAL_LABEL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 90 static const char* ERROR_LABEL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 91 static const char* WARNING_LABEL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 92 static const char* INFO_LABEL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 93 static const char* DEBUG_LABEL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 94 static const char* TRACE_LABEL;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 95
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 96 private:
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 97
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 98 /** Constructor
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 99 */
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 100 MTSLog();
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 101
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 102 static int currentLevel;
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 103
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 104 };
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 105
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 106 }
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 107
Jenkins@KEILDM1.dc.multitech.prv 2:4569491293d7 108 #endif