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:
jreiss
Date:
Wed Mar 25 17:06:41 2020 +0000
Revision:
74:8b02b1a9a1b6
Parent:
72:b1e07ec1c30d
Remove old ARMCC archive, only ARMC6 is available.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 1 /**********************************************************************
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 2 * COPYRIGHT 2018 MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 3 *
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 4 * ALL RIGHTS RESERVED BY AND FOR THE EXCLUSIVE BENEFIT OF
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 5 * MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 6 *
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 7 * MULTI-TECH SYSTEMS, INC. - CONFIDENTIAL AND PROPRIETARY
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 8 * INFORMATION AND/OR TRADE SECRET.
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 9 *
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 10 * NOTICE: ALL CODE, PROGRAM, INFORMATION, SCRIPT, INSTRUCTION,
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 11 * DATA, AND COMMENT HEREIN IS AND SHALL REMAIN THE CONFIDENTIAL
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 12 * INFORMATION AND PROPERTY OF MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 13 * USE AND DISCLOSURE THEREOF, EXCEPT AS STRICTLY AUTHORIZED IN A
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 14 * WRITTEN AGREEMENT SIGNED BY MULTI-TECH SYSTEMS, INC. IS PROHIBITED.
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 15 *
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 16 ***********************************************************************/
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 17
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 18 #ifndef _FRAGMENTATION_SESSION_H
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 19 #define _FRAGMENTATION_SESSION_H
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 20 #ifdef FOTA
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 21
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 22 #include "mbed.h"
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 23 #include "FragmentationMath.h"
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 24 #include "mDot.h"
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 25 #include "WriteFile.h"
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 26
Jenkins@KEILDM1.dc.multitech.prv 67:a9d4d7cdeca1 27 #define MAX_PARITY 300
Jenkins@KEILDM1.dc.multitech.prv 67:a9d4d7cdeca1 28 #define FRAG_OFFSET 3
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 29 #define MULTICAST_SESSIONS 3
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 30
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 31 class FragmentationSession {
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 32
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 33 public:
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 34 FragmentationSession(mDot* dot, std::vector<uint8_t>* ret, bool* filled, uint32_t* delay);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 35 ~FragmentationSession();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 36 void processCmd(uint8_t* payload, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 37 void reset();
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 38 bool isComplete() const;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 39 bool cleanUp();
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 40
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 41 enum FragCmd {
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 42 PACKAGE_VERSION_FRAG,
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 43 FRAG_STATUS,
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 44 FRAG_SESSION_SETUP,
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 45 FRAG_SESSION_DELETE,
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 46 DATA_FRAGMENT = 0x08,
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 47 CHECKSUM = 0x80,
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 48 FRAG_SESSION_COMPLETE = 0x90
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 49 };
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 50
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 51 private:
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 52
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 53 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 54 uint8_t Padding;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 55 uint8_t FragmentSize;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 56 uint16_t NumberOfFragments;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 57 } FragmentationSessionOpts_t;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 58
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 59 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 60 bool reset;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 61 bool failed;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 62 uint8_t fragMatrix;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 63 uint8_t blockAckDelay;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 64 uint8_t total_sessions;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 65 uint8_t mcGroupBitMask;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 66 uint8_t current_session;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 67 uint16_t index;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 68 uint16_t last_frag_num;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 69 uint32_t total_frags;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 70 FragmentationMath* math;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 71 FragmentationSessionOpts_t opts;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 72 } fragGroup;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 73
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 74
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 75 enum FragResult {
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 76 FRAG_OK,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 77 FRAG_SIZE_INCORRECT,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 78 FRAG_FLASH_WRITE_ERROR,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 79 FRAG_NO_MEMORY,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 80 FRAG_COMPLETE
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 81 };
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 82
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 83 void reset(uint16_t num);
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 84 void upgradeFile(uint8_t sessionIndex);
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 85 bool processFrame(uint8_t fragIndex, uint16_t index, uint8_t buffer[], size_t size);
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 86 uint32_t getDescriptor() { return _descriptor; }
Jenkins@KEILDM1.dc.multitech.prv 67:a9d4d7cdeca1 87
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 88 mDot* _dot;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 89 WriteFile* _fh;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 90 fragGroup _sessions[MULTICAST_SESSIONS];
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 91
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 92 uint8_t ans;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 93 bool* _filled;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 94 uint32_t* _delay;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 95 uint8_t _session_index;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 96 uint32_t _descriptor;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 97 std::vector<uint8_t>* _ret;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 98 bool _complete;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 99 bool _validated;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 100 };
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 101 #endif
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 102 #endif // _FRAGMENTATION_SESSION_H