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:
Mon Jun 19 16:03:56 2017 -0500
Revision:
36:bf7b1b13d7da
xdot-library revision 3.0.0-rc7-1-ga5165ae and mbed-os revision mbed-os-5.4.7

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 1 /** __ ___ ____ _ ______ __ ____ __ ____
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 6 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 7 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 8 * @author Mike Fiore
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 9 * @date 5-16-2017
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 10 * @brief lora::ChannelPlan provides an interface for LoRaWAN channel schemes
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 11 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 12 * @details
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 13 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 14 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 15
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 16 #ifndef __CHANNEL_PLAN_AS923_JAPAN_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 17 #define __CHANNEL_PLAN_AS923_JAPAN_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 18
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 19 #include "ChannelPlan_AS923.h"
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 20
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 21 namespace lora {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 22
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 23 class ChannelPlan_AS923_Japan: public lora::ChannelPlan_AS923 {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 24 public:
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 25 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 26 * ChannelPlan constructor
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 27 * @param radio SxRadio object used to set Tx/Rx config
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 28 * @param settings Settings object
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 29 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 30 ChannelPlan_AS923_Japan();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 31 ChannelPlan_AS923_Japan(Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 32 ChannelPlan_AS923_Japan(SxRadio* radio, Settings* settings);
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 33
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 34 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 35 * ChannelPlan destructor
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 36 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 37 virtual ~ChannelPlan_AS923_Japan();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 38
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 39 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 40 * Initialize channels, datarates and duty cycle bands according to current channel plan in settings
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 41 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 42 virtual void Init();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 43
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 44 /**
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 45 * Set LBT time and threshold to defaults
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 46 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 47 virtual void DefaultLBT();
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 48 };
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 49 }
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 50
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 51 #endif //__CHANNEL_PLAN_AS923JAPAN_H__