Bleeding edge development version of the mDot 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:   mDot-IKS01A1 mDot-IKS01A1 mDot-Examples mDot-IKS01A1-Explora ... more

Fork of libmDot-dev-mbed2-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.

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:
Fri Oct 26 16:14:07 2018 -0500
Revision:
183:f205b2eea7c2
Parent:
141:c6247c5469ff
mdot-library revision 3.1.0-49-g926b83a and mbed-os revision mbed-os-5.9.6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 1 /**********************************************************************
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 2 * COPYRIGHT 2016 MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 3 *
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 4 * ALL RIGHTS RESERVED BY AND FOR THE EXCLUSIVE BENEFIT OF
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 5 * MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 6 *
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 7 * MULTI-TECH SYSTEMS, INC. - CONFIDENTIAL AND PROPRIETARY
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 8 * INFORMATION AND/OR TRADE SECRET.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 9 *
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 10 * NOTICE: ALL CODE, PROGRAM, INFORMATION, SCRIPT, INSTRUCTION,
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 11 * DATA, AND COMMENT HEREIN IS AND SHALL REMAIN THE CONFIDENTIAL
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 12 * INFORMATION AND PROPERTY OF MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 13 * USE AND DISCLOSURE THEREOF, EXCEPT AS STRICTLY AUTHORIZED IN A
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 14 * WRITTEN AGREEMENT SIGNED BY MULTI-TECH SYSTEMS, INC. IS PROHIBITED.
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 15 *
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 16 ***********************************************************************/
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 17
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 18 #include "ChannelPlan_AS923_Japan.h"
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 19
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 20 using namespace lora;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 21
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 22 ChannelPlan_AS923_Japan::ChannelPlan_AS923_Japan()
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 23 :
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 24 ChannelPlan_AS923(NULL, NULL)
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 25 {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 26
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 27 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 28
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 29 ChannelPlan_AS923_Japan::ChannelPlan_AS923_Japan(Settings* settings)
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 30 :
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 31 ChannelPlan_AS923(NULL, settings)
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 32 {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 33
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 34 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 35
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 36 ChannelPlan_AS923_Japan::ChannelPlan_AS923_Japan(SxRadio* radio, Settings* settings)
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 37 :
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 38 ChannelPlan_AS923(radio, settings)
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 39 {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 40
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 41 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 42
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 43 ChannelPlan_AS923_Japan::~ChannelPlan_AS923_Japan() {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 44
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 45 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 46
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 47 void ChannelPlan_AS923_Japan::Init() {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 48 ChannelPlan_AS923::Init();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 49
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 50 _plan = AS923_JAPAN;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 51 _planName = "AS923-JAPAN";
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 52 _minFrequency = 920600000;
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 53 _maxFrequency = 928000000;
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 54
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 55 _minDatarate = 2;
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 56 _maxDatarate = 5;
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 57
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 58 _minRx2Datarate = DR_2;
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 59 _maxRx2Datarate = DR_5;
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 60
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 61 _minDatarateOffset = 2;
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 62 _maxDatarateOffset = 5;
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 63
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 64 GetSettings()->Session.UplinkDwelltime = 1;
Jenkins@KEILDM1.dc.multitech.prv 141:c6247c5469ff 65 GetSettings()->Session.Max_EIRP = 13;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 66
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 67 DefaultLBT();
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 68 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 69
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 70 void ChannelPlan_AS923_Japan::DefaultLBT() {
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 71 _LBT_TimeUs = 5000;
Jenkins@KEILDM1.dc.multitech.prv 125:e2a22b15adaa 72 _LBT_Threshold = -80;
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 73 }
Jenkins@KEILDM1.dc.multitech.prv 82:0f5a742a08cd 74