MultiTech / libmDot-mbed5

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

MTS-Lora/vendor/multitech/MTS-Utils/Utils.h@74:8b02b1a9a1b6, 2020-03-25 (annotated)

Committer:
jreiss
Date:
Wed Mar 25 17:06:41 2020 +0000
Revision:
74:8b02b1a9a1b6
Parent:
16:b630e18103e5 
Remove old ARMCC archive, only ARMC6 is available.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 16:b630e18103e5 1 #ifndef UTILS_H
Mike Fiore 16:b630e18103e5 2 #define UTILS_H
Mike Fiore 16:b630e18103e5 3
Mike Fiore 16:b630e18103e5 4 #include <string>
Mike Fiore 16:b630e18103e5 5
Mike Fiore 16:b630e18103e5 6 //Defines a max function that can be used.
Mike Fiore 16:b630e18103e5 7 inline int mts_max(int a, int b) { return a > b ? a : b; }
Mike Fiore 16:b630e18103e5 8
Mike Fiore 16:b630e18103e5 9 //Defines a min function that can be used.
Mike Fiore 16:b630e18103e5 10 inline int mts_min(int a, int b) { return a < b ? a : b; }
Mike Fiore 16:b630e18103e5 11
Mike Fiore 16:b630e18103e5 12 ///An enumeration for relational operators
Mike Fiore 16:b630e18103e5 13 enum RelationalOperator {
Mike Fiore 16:b630e18103e5 14 GREATER, LESS, EQUAL, GREATER_EQUAL, LESS_EQUAL
Mike Fiore 16:b630e18103e5 15 };
Mike Fiore 16:b630e18103e5 16
Mike Fiore 16:b630e18103e5 17 /** A static method for getting a string representation for the RelationalOperator
Mike Fiore 16:b630e18103e5 18 * enumeration.
Mike Fiore 16:b630e18103e5 19 *
Mike Fiore 16:b630e18103e5 20 * @param relationalOperator a RelationalOperator enumeration.
Mike Fiore 16:b630e18103e5 21 * @returns the enumeration name as a string.
Mike Fiore 16:b630e18103e5 22 */
Mike Fiore 16:b630e18103e5 23 static inline std::string getRelationalOperatorNames(RelationalOperator relationalOperator)
Mike Fiore 16:b630e18103e5 24 {
Mike Fiore 16:b630e18103e5 25 switch(relationalOperator) {
Mike Fiore 16:b630e18103e5 26 case GREATER:
Mike Fiore 16:b630e18103e5 27 return "GREATER";
Mike Fiore 16:b630e18103e5 28 case LESS:
Mike Fiore 16:b630e18103e5 29 return "LESS";
Mike Fiore 16:b630e18103e5 30 case EQUAL:
Mike Fiore 16:b630e18103e5 31 return "EQUAL";
Mike Fiore 16:b630e18103e5 32 case GREATER_EQUAL:
Mike Fiore 16:b630e18103e5 33 return "GREATER_EQUAL";
Mike Fiore 16:b630e18103e5 34 case LESS_EQUAL:
Mike Fiore 16:b630e18103e5 35 return "LESS_EQUAL";
Mike Fiore 16:b630e18103e5 36 default:
Mike Fiore 16:b630e18103e5 37 return "UNKNOWN ENUM";
Mike Fiore 16:b630e18103e5 38 }
Mike Fiore 16:b630e18103e5 39 }
Mike Fiore 16:b630e18103e5 40
Mike Fiore 16:b630e18103e5 41 #endif