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

Fota/Fragmentation/WriteFile.h

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
2019-04-23
Revision:
66:baa0f3116f1d
Child:
68:5f787643e7d7

File content as of revision 66:baa0f3116f1d:

#ifndef _WRITE_FILE_H
#define _WRITE_FILE_H
#include "mDot.h"
#ifdef FOTA
class WriteFile {
    public:
        WriteFile(mDot* dot);
        ~WriteFile();
        void writeFile(uint8_t* buffer, uint32_t size);
        void readFile(uint8_t* buffer, uint32_t size);
        void seekFile(uint32_t index);
        void createFile(uint16_t numOfFrags, uint8_t fragSize, uint8_t padding); 
        uint64_t completeFile(uint16_t numOfFrags, uint8_t padding, uint32_t total_frags);
        void cleanUp(bool complete);
        void reset();

    private:
        mDot* _dot;
        char* _temp;
        char* _firmware;
        uint8_t* _frag;
        uint8_t _padding;
        uint8_t _frag_size;
        uint16_t _num_frags;
        mDot::mdot_file _upgrade, _file;
}; 
#endif
#endif // WRITE_FILE_H