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 MULTICASTGROUP_H
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 19 #define MULTICASTGROUP_H
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 20 #include "mDot.h"
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 21 #include "mbed.h"
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 22 #define GPS_EPOCH 315964800U
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 23 #define MULTICAST_SESSIONS 3
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 24
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 25 class MulticastGroup {
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 26 public:
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 27 MulticastGroup(mDot* dot, std::vector<uint8_t>* ret, bool* filled);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 28 ~MulticastGroup();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 29 void reset();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 30 //void newTime();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 31 void processCmd(uint8_t* payload, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 32 int32_t timeToStart();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 33 void fixEventQueue();
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 34 void setClockOffset(int32_t offset);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 35
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 36 private:
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 37 enum MulticastCommands {
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 38 PACKAGE_VERSION,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 39 STATUS,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 40 SETUP,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 41 DELETE,
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 42 CLASS_C_SESSION,
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 43 CLASS_B_SESSION_REQ
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 44 };
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 45
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 46 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 47 bool valid;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 48 uint8_t dr;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 49 uint8_t fragGroup;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 50 uint16_t timeout;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 51 uint32_t tme;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 52 uint32_t freq;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 53 uint32_t addr;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 54 uint32_t max_frame_count;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 55 int32_t timetostart;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 56 int32_t class_c_end;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 57 int32_t class_c_start;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 58 time_t time_setup;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 59 int8_t periodicity;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 60 } mcgroup;
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 61
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 62 bool* _filled;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 63 uint8_t _groupId;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 64 uint8_t _ans;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 65 uint8_t _delay;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 66 uint8_t _token;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 67 uint8_t _dr;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 68 uint32_t _freq;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 69 uint32_t _frame_count;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 70 time_t _now;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 71 int32_t _clk_sync;
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 72
Jenkins@KEILDM1.dc.multitech.prv 70:0c5b5b02d17b 73 mDot* _dot;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 74 Thread _event_thread;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 75 EventQueue _switch_class_queue;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 76 mcgroup _mcGroup[MULTICAST_SESSIONS];
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 77 std::vector<uint8_t>* _ret;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 78 char _org_class;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 79
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 80 void setupClassB(uint8_t id);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 81 void setupClassC(uint8_t id);
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 82 static void switchClass(uint32_t freq, uint8_t dr, char newClass);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 83 };
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 84 #endif