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_MATH_H
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 19 #define _FRAGMENTATION_MATH_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 "mDot.h"
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 24 #include "WriteFile.h"
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 25
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 26 #define FRAG_SESSION_ONGOING 0xffffffff
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 27
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 28 #ifndef MAX_PARITY
Jenkins@KEILDM1.dc.multitech.prv 67:a9d4d7cdeca1 29 #define MAX_PARITY 300
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 30 #endif
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 31
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 32 class FragmentationMath
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 33 {
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 34 public:
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 35 FragmentationMath(mDot* dot, uint16_t frame_count, uint8_t frame_size, WriteFile* fh);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 36 ~FragmentationMath();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 37 bool Init();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 38 int getLostFrameCount();
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 39 int getTotalMissingFrameCount();
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 40 int getTotalRcvdFrameCount();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 41 void reset(uint16_t fcount);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 42 void setFrameFound(uint16_t frameCounter);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 43 bool processParityFrag(uint16_t frameCounter, uint8_t *pFrag);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 44
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 45 int FragmentationPrbs23(int x);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 46 bool IsPowerOfTwo(unsigned int x);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 47 int32_t FindMissingFrameIndex(uint16_t x);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 48 int32_t FindTrueFrameIndex(uint16_t x);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 49 void GetRowInFlash(int l, uint8_t *rowData);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 50 int FindFirstOne(uint8_t *boolData, int size);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 51 void StoreRowInFlash(uint8_t *rowData, int index);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 52 void XorLineData(uint8_t *dataL1, uint8_t *dataL2, int size);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 53 void XorLineBit(uint8_t *dataL1, uint8_t *dataL2, int size);
Jenkins@KEILDM1.dc.multitech.prv 67:a9d4d7cdeca1 54 void XorRowWithMatrix(uint8_t* row, int matrix_row_num);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 55 void FragmentationGetParityMatrixRow(int N, int M, uint8_t *matrixRow);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 56 void CondenseRow(uint8_t *row, int row_number, int start);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 57 void ExpandAndXorRow(uint8_t *row, int row_number);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 58 bool CheckIfMissing(int row_number, int index);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 59 void CompleteRow(int row_num);
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 60 void printMatrix();
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 61
Jenkins@KEILDM1.dc.multitech.prv 67:a9d4d7cdeca1 62 uint8_t _frame_size;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 63 uint16_t _frame_count;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 64 uint16_t _max_parity;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 65 int16_t numFramesMissing;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 66 uint16_t lastReceiveFrameCnt;
Jenkins@KEILDM1.dc.multitech.prv 72:b1e07ec1c30d 67 int filled;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 68
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 69 uint8_t *matrix;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 70 uint8_t *matrixRow;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 71 uint8_t *parity_frag;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 72 uint8_t *missingFrameIndex;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 73 uint8_t *frag_in_flash;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 74
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 75 bool empty;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 76 int index_of_first;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 77 int matrix_row_num;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 78 int index;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 79
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 80 mDot* _dot;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 81 WriteFile* _fh;
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 82 };
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 83 #endif
Jenkins@KEILDM1.dc.multitech.prv 66:baa0f3116f1d 84 #endif // _FRAGMENTATION_MATH_H