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:
Tue Apr 23 08:51:44 2019 -0500
Revision:
16:4a382fe8f51b
Child:
18:d7332302f5f1
mdot-library revision 3.2.0 and mbed-os revision mbed-os-5.11.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 1 #ifndef FOTA_H
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 2 #define FOTA_H
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 3 #include "mDot.h"
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 4 #ifdef FOTA
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 5 #include "FragmentationSession.h"
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 6 #endif
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 7 #include "MulticastGroup.h"
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 8
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 9 class Fota {
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 10
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 11 public:
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 12 Fota(mDot* dot);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 13 ~Fota();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 14
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 15 static Fota* getInstance(mDot* dot);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 16 static Fota* getInstance();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 17 void processCmd(uint8_t* payload, uint8_t port, uint8_t size);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 18 void reset();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 19 void enable(bool enabled);
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 20 bool enable();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 21 void fixEventQueue();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 22 int32_t timeToStart();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 23
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 24 private:
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 25 static void start();
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 26
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 27 bool _enabled;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 28 Thread _send_thread;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 29 uint8_t p[242];
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 30 static Fota* _instance;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 31 mDot* _dot;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 32 #ifdef FOTA
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 33 FragmentationSession* _frag_session;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 34 #endif
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 35 MulticastGroup* _mc_group;
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 36 };
Jenkins@KEILDM1.dc.multitech.prv 16:4a382fe8f51b 37 #endif