Stable version of the xDot library for mbed 5. This version of the library is suitable for deployment scenarios.

Dependents:   Dot-Examples XDOT-Devicewise Dot-Examples-delujoc Dot-Examples_receive ... more

Fork of libxDot-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

examples/src/fota_example.cpp

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

examples/inc/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
    }

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:
Jenkins@KEILDM1.dc.multitech.prv
Date:
Mon Feb 17 14:42:01 2020 -0600
Revision:
25:3101c522ae11
Parent:
20:bc12c888e7dc
xdot-library revision 3.3.5 and mbed-os revision mbed-os-5.13.4

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 1 /**********************************************************************
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 2 * COPYRIGHT 2018 MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 3 *
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 4 * ALL RIGHTS RESERVED BY AND FOR THE EXCLUSIVE BENEFIT OF
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 5 * MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 6 *
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 7 * MULTI-TECH SYSTEMS, INC. - CONFIDENTIAL AND PROPRIETARY
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 8 * INFORMATION AND/OR TRADE SECRET.
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 9 *
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 10 * NOTICE: ALL CODE, PROGRAM, INFORMATION, SCRIPT, INSTRUCTION,
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 11 * DATA, AND COMMENT HEREIN IS AND SHALL REMAIN THE CONFIDENTIAL
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 12 * INFORMATION AND PROPERTY OF MULTI-TECH SYSTEMS, INC.
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 13 * USE AND DISCLOSURE THEREOF, EXCEPT AS STRICTLY AUTHORIZED IN A
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 14 * WRITTEN AGREEMENT SIGNED BY MULTI-TECH SYSTEMS, INC. IS PROHIBITED.
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 15 *
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 16 ***********************************************************************/
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 17
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 18 #ifndef MULTICASTGROUP_H
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 19 #define MULTICASTGROUP_H
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 20 #include "mDot.h"
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 21 #include "mbed.h"
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 22 #define GPS_EPOCH 315964800U
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 23 #define MULTICAST_SESSIONS 3
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 24
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 25 class MulticastGroup {
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 26 public:
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 27 MulticastGroup(mDot* dot, std::vector<uint8_t>* ret, bool* filled);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 28 ~MulticastGroup();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 29 void reset();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 30 //void newTime();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 31 void processCmd(uint8_t* payload, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 32 int32_t timeToStart();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 33 void fixEventQueue();
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 34 void setClockOffset(int32_t offset);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 35
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 36 private:
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 37 enum MulticastCommands {
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 38 PACKAGE_VERSION,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 39 STATUS,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 40 SETUP,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 41 DELETE,
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 42 CLASS_C_SESSION,
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 43 CLASS_B_SESSION_REQ
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 44 };
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 45
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 46 typedef struct {
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 47 bool valid;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 48 uint8_t dr;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 49 uint8_t fragGroup;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 50 uint16_t timeout;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 51 uint32_t tme;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 52 uint32_t freq;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 53 uint32_t addr;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 54 uint32_t max_frame_count;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 55 int32_t timetostart;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 56 int32_t class_c_end;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 57 int32_t class_c_start;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 58 time_t time_setup;
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 59 int8_t periodicity;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 60 } mcgroup;
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 61
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 62 bool* _filled;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 63 uint8_t _groupId;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 64 uint8_t _ans;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 65 uint8_t _delay;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 66 uint8_t _token;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 67 uint8_t _dr;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 68 uint32_t _freq;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 69 uint32_t _frame_count;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 70 time_t _now;
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 71 int32_t _clk_sync;
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 72
Jenkins@KEILDM1.dc.multitech.prv 20:bc12c888e7dc 73 mDot* _dot;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 74 Thread _event_thread;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 75 EventQueue _switch_class_queue;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 76 mcgroup _mcGroup[MULTICAST_SESSIONS];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 77 std::vector<uint8_t>* _ret;
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 78 char _org_class;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 79
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 80 void setupClassB(uint8_t id);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 81 void setupClassC(uint8_t id);
Jenkins@KEILDM1.dc.multitech.prv 25:3101c522ae11 82 static void switchClass(uint32_t freq, uint8_t dr, char newClass);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 83 };
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 84 #endif