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
Child:
61:e8eb2d72ecd6
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 _____) ) ____| | | || |_| ____( (___| | | |
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 6 (______/|_____)_|_|_| \__)_____)\____)_| |_|
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 7 (C)2013 Semtech
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 8
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 9 Description: Generic radio driver definition
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 10
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 11 License: Revised BSD License, see LICENSE.TXT file include in the project
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 12
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 13 Maintainer: Miguel Luis and Gregory Cristian
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 14 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 15 #ifndef __SXRADIOEVENTS_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 16 #define __SXRADIOEVENTS_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 17
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 18 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 19 * \brief Radio driver callback functions
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 20 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 21 class SxRadioEvents
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 22 {
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 23 public:
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 24 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 25 * \brief Tx Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 26 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 27 virtual void TxDone( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 28 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 29 * \brief Tx Timeout callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 30 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 31 virtual void TxTimeout( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 32 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 33 * \brief Rx Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 34 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 35 * \param [IN] payload Received buffer pointer
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 36 * \param [IN] size Received buffer size
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 37 * \param [IN] rssi RSSI value computed while receiving the frame [dBm]
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 38 * \param [IN] snr Raw SNR value given by the radio hardware
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 39 * FSK : N/A ( set to 0 )
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 40 * LoRa: SNR value is two's complement in 1/4 dB
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 41 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 42 virtual void RxDone( uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 43 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 44 * \brief Rx Timeout callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 45 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 46 virtual void RxTimeout( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 47 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 48 * \brief Rx Error callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 49 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 50 virtual void RxError( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 51 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 52 * \brief FHSS Change Channel callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 53 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 54 * \param [IN] currentChannel Index number of the current channel
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 55 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 56 virtual void FhssChangeChannel( uint8_t currentChannel ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 57 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 58 * \brief CAD Done callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 59 *
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 60 * \param [IN] channelActivityDetected Channel Activity detected during the CAD
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 61 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 62 virtual void CadDone( bool channelActivityDetected ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 63 /*!
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 64 * \brief Mac Event callback prototype.
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 65 */
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 66 virtual void MacEvent( void ) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 67
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 68 virtual void LinkIdle(void) {}
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 69 };
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 70
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 71 #endif // __SXRADIOEVENTS_H__
Jenkins@KEILDM1.dc.multitech.prv 36:bf7b1b13d7da 72