MultiTech / libmDot-mbed5

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

Fota/Fragmentation/FragmentationMath.h

Committer:
Jenkins@KEILDM1.dc.multitech.prv
Date:
2019-11-08
Revision:
70:0c5b5b02d17b
Parent:
69:e22889c7eaa9
Child:
72:b1e07ec1c30d

File content as of revision 70:0c5b5b02d17b:

/**********************************************************************
* COPYRIGHT 2018 MULTI-TECH SYSTEMS, INC.
*
* ALL RIGHTS RESERVED BY AND FOR THE EXCLUSIVE BENEFIT OF
* MULTI-TECH SYSTEMS, INC.
*
* MULTI-TECH SYSTEMS, INC. - CONFIDENTIAL AND PROPRIETARY
* INFORMATION AND/OR TRADE SECRET.
*
* NOTICE: ALL CODE, PROGRAM, INFORMATION, SCRIPT, INSTRUCTION,
* DATA, AND COMMENT HEREIN IS AND SHALL REMAIN THE CONFIDENTIAL
* INFORMATION AND PROPERTY OF MULTI-TECH SYSTEMS, INC.
* USE AND DISCLOSURE THEREOF, EXCEPT AS STRICTLY AUTHORIZED IN A
* WRITTEN AGREEMENT SIGNED BY MULTI-TECH SYSTEMS, INC. IS PROHIBITED.
*
***********************************************************************/

#ifndef _FRAGMENTATION_MATH_H
#define _FRAGMENTATION_MATH_H
#ifdef FOTA

#include "mbed.h"
#include "mDot.h"
#include "WriteFile.h"

#define FRAG_SESSION_ONGOING    0xffffffff
#ifndef MAX_PARITY
#define MAX_PARITY 300
#endif
class FragmentationMath
{
  public:
    FragmentationMath(mDot* dot, uint16_t frame_count, uint8_t frame_size, WriteFile* fh);
    ~FragmentationMath();
    bool Init();
    int getLostFrameCount();
    void reset(uint16_t fcount);
    void setFrameFound(uint16_t frameCounter);
    bool processParityFrag(uint16_t frameCounter, uint8_t *pFrag);

    int FragmentationPrbs23(int x);
    bool IsPowerOfTwo(unsigned int x);
    int32_t FindMissingFrameIndex(uint16_t x);
    int32_t FindTrueFrameIndex(uint16_t x);
    void GetRowInFlash(int l, uint8_t *rowData);
    int FindFirstOne(uint8_t *boolData, int size);
    void StoreRowInFlash(uint8_t *rowData, int index);
    void XorLineData(uint8_t *dataL1, uint8_t *dataL2, int size);
    void XorLineBit(uint8_t *dataL1, uint8_t *dataL2, int size);
    void XorRowWithMatrix(uint8_t* row, int matrix_row_num);
    void FragmentationGetParityMatrixRow(int N, int M, uint8_t *matrixRow);
    void CondenseRow(uint8_t *row, int row_number, int start);
    void ExpandAndXorRow(uint8_t *row, int row_number);
    bool CheckIfMissing(int row_number, int index);
    void CompleteRow(int row_num);
    void printMatrix();

    uint8_t _frame_size;
    uint16_t _frame_count;
    uint16_t _max_parity;
    uint16_t numFramesMissing;
    uint16_t lastReceiveFrameCnt;

    uint8_t *matrix;
    uint8_t *matrixRow;
    uint8_t *parity_frag;
    uint8_t *missingFrameIndex;
    uint8_t *frag_in_flash;

    bool empty;
    int index_of_first;
    int matrix_row_num;
    int index;

    mDot* _dot;
    WriteFile* _fh;
};
#endif
#endif // _FRAGMENTATION_MATH_H