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:
180:a78812699800
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
Mike Fiore 16:b630e18103e5 1 /** __ ___ ____ _ ______ __ ____ __ ____
Mike Fiore 16:b630e18103e5 2 * / |/ /_ __/ / /_(_)__/_ __/__ ____/ / / __/_ _____ / /____ __ _ ___ / _/__ ____
Mike Fiore 16:b630e18103e5 3 * / /|_/ / // / / __/ /___// / / -_) __/ _ \ _\ \/ // (_-</ __/ -_) ' \(_-< _/ // _ \/ __/ __
Mike Fiore 16:b630e18103e5 4 * /_/ /_/\_,_/_/\__/_/ /_/ \__/\__/_//_/ /___/\_, /___/\__/\__/_/_/_/___/ /___/_//_/\__/ /_/
Mike Fiore 16:b630e18103e5 5 * Copyright (C) 2015 by Multi-Tech Systems /___/
Mike Fiore 16:b630e18103e5 6 *
Mike Fiore 16:b630e18103e5 7 *
Mike Fiore 16:b630e18103e5 8 * @author Jason Reiss
Mike Fiore 16:b630e18103e5 9 * @date 10-31-2015
Mike Fiore 16:b630e18103e5 10 * @brief lora::MacEvents provides an interface for events from the Mac layer
Mike Fiore 16:b630e18103e5 11 *
Mike Fiore 16:b630e18103e5 12 * @details
Mike Fiore 16:b630e18103e5 13 *
Mike Fiore 16:b630e18103e5 14 */
Mike Fiore 16:b630e18103e5 15
Mike Fiore 16:b630e18103e5 16 #ifndef __LORA_MAC_EVENTS_H__
Mike Fiore 16:b630e18103e5 17 #define __LORA_MAC_EVENTS_H__
Mike Fiore 16:b630e18103e5 18
Mike Fiore 16:b630e18103e5 19 #include "Lora.h"
Mike Fiore 16:b630e18103e5 20
Mike Fiore 16:b630e18103e5 21 namespace lora {
Mike Fiore 16:b630e18103e5 22
Mike Fiore 16:b630e18103e5 23 class MacEvents {
Mike Fiore 16:b630e18103e5 24
Mike Fiore 16:b630e18103e5 25 public:
Mike Fiore 16:b630e18103e5 26 virtual ~MacEvents() {};
Mike Fiore 16:b630e18103e5 27
Jenkins@KEILDM1.dc.multitech.prv 114:8462870088eb 28 virtual void TxStart(void) = 0;
Mike Fiore 16:b630e18103e5 29 virtual void TxDone(uint8_t dr) = 0;
Mike Fiore 16:b630e18103e5 30 virtual void TxTimeout(void) = 0;
Mike Fiore 16:b630e18103e5 31
Mike Fiore 16:b630e18103e5 32 virtual void JoinAccept(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) = 0;
Mike Fiore 16:b630e18103e5 33 virtual void JoinFailed(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) = 0;
Jenkins@KEILDM1.dc.multitech.prv 137:893a90334924 34 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=0, uint32_t address=0, bool dupRx=false) = 0;
Mike Fiore 16:b630e18103e5 35 virtual void RxDone(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr, lora::DownlinkControl ctrl, uint8_t slot) = 0;
Mike Fiore 16:b630e18103e5 36
Jenkins@KEILDM1.dc.multitech.prv 180:a78812699800 37 virtual void BeaconRx(const BeaconData_t& beacon_data, int16_t rssi, int8_t snr) = 0;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 38 virtual void BeaconLost() = 0;
Jenkins@KEILDM1.dc.multitech.prv 179:578d8030ba57 39 virtual void ServerTime(uint32_t seconds, uint8_t sub_seconds) = 0;
Jenkins@KEILDM1.dc.multitech.prv 172:7ec44396a51b 40
Mike Fiore 16:b630e18103e5 41 virtual void Pong(int16_t m_rssi, int8_t m_snr, int16_t s_rssi, int8_t s_snr) = 0;
Mike Fiore 16:b630e18103e5 42 virtual void NetworkLinkCheck(int16_t m_rssi, int8_t m_snr, int8_t s_snr, uint8_t s_gateways) = 0;
Mike Fiore 16:b630e18103e5 43
Mike Fiore 16:b630e18103e5 44 virtual void RxTimeout(uint8_t slot) = 0;
Mike Fiore 16:b630e18103e5 45 virtual void RxError(uint8_t slot) = 0;
Mike Fiore 16:b630e18103e5 46
Jenkins@KEILDM1.dc.multitech.prv 37:85ab51620cca 47 virtual void MissedAck(uint8_t retries) = 0;
Jenkins@KEILDM1.dc.multitech.prv 26:17479e0039f6 48
Mike Fiore 16:b630e18103e5 49 virtual uint8_t MeasureBattery() = 0;
Mike Fiore 16:b630e18103e5 50
Mike Fiore 16:b630e18103e5 51 private:
Mike Fiore 16:b630e18103e5 52
Mike Fiore 16:b630e18103e5 53
Mike Fiore 16:b630e18103e5 54 };
Mike Fiore 16:b630e18103e5 55
Mike Fiore 16:b630e18103e5 56 }
Mike Fiore 16:b630e18103e5 57
Mike Fiore 16:b630e18103e5 58 #endif