Stable version of the mDot library for mbed 5. This version of the library is suitable for deployment scenarios. See lastest commit message for version of mbed-os library that has been tested against.

Dependents:   mdot_two_way unh-hackathon-example unh-hackathon-example-raw TelitSensorToCloud ... more

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

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.

FOTA

Full FOTA support is only available with mDot, xDot does not have the required external flash. xDot can use the FOTA example to dynamically join a multicast session only. After joining the multicast session the received Fragmentation packets could be handed to a host MCU for processing and at completion the firmware can be loaded into the xDot using the bootloader and y-modem. See xDot Developer Guide.

  • Add the following code to allow Fota to use the Dot instance

main.cpp

    // Initialize FOTA singleton
    Fota::getInstance(dot);
  • Add fragmentation handling the the PacketRx event

RadioEvent.h

    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, bool dupRx) {
        mDotEvent::PacketRx(port, payload, size, rssi, snr, ctrl, slot, retries, address, dupRx);

#if ACTIVE_EXAMPLE == FOTA_EXAMPLE
        if(port == 200 || port == 201 || port == 202) {
            Fota::getInstance()->processCmd(payload, port, size);
        }
#endif
    }

A definition is needed to enable Fragmentation support on mDot and save fragments to flash. This should not be defined for xDot and will result in a compiler error.

mbed_app.json

{
    "macros": [
        "FOTA=1"
    ]
}

The FOTA implementation has a few differences from the LoRaWAN Protocol

  • Fragmentation Indexing starts at 0
  • McKEKey is 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
  • Start Time is a count-down in seconds to start of session
Committer:
Mike Fiore
Date:
Thu Aug 04 15:11:24 2016 -0500
Revision:
16:b630e18103e5
Child:
17:306ffaa5d79b
update from libmDot-2.0.1-ARMCC.tar.gz

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
Mike Fiore 16:b630e18103e5 28 virtual void TxDone(uint8_t dr) = 0;
Mike Fiore 16:b630e18103e5 29 virtual void TxTimeout(void) = 0;
Mike Fiore 16:b630e18103e5 30
Mike Fiore 16:b630e18103e5 31 virtual void JoinAccept(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) = 0;
Mike Fiore 16:b630e18103e5 32 virtual void JoinFailed(uint8_t *payload, uint16_t size, int16_t rssi, int8_t snr) = 0;
Mike Fiore 16:b630e18103e5 33 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) = 0;
Mike Fiore 16:b630e18103e5 34 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 35
Mike Fiore 16:b630e18103e5 36 virtual void Pong(int16_t m_rssi, int8_t m_snr, int16_t s_rssi, int8_t s_snr) = 0;
Mike Fiore 16:b630e18103e5 37 virtual void NetworkLinkCheck(int16_t m_rssi, int8_t m_snr, int8_t s_snr, uint8_t s_gateways) = 0;
Mike Fiore 16:b630e18103e5 38
Mike Fiore 16:b630e18103e5 39 virtual void RxTimeout(uint8_t slot) = 0;
Mike Fiore 16:b630e18103e5 40 virtual void RxError(uint8_t slot) = 0;
Mike Fiore 16:b630e18103e5 41
Mike Fiore 16:b630e18103e5 42 virtual uint8_t MeasureBattery() = 0;
Mike Fiore 16:b630e18103e5 43
Mike Fiore 16:b630e18103e5 44 private:
Mike Fiore 16:b630e18103e5 45
Mike Fiore 16:b630e18103e5 46
Mike Fiore 16:b630e18103e5 47 };
Mike Fiore 16:b630e18103e5 48
Mike Fiore 16:b630e18103e5 49 }
Mike Fiore 16:b630e18103e5 50
Mike Fiore 16:b630e18103e5 51 #endif