MultiTech / libmDot-dev-mbed5-deprecated

Bleeding edge development version of the mDot library for mbed 5. This version of the library is not guaranteed to be stable or well tested and should not be used in production or deployment scenarios.

Dependents:   mDot-IKS01A1 mDot-IKS01A1 mDot-Examples mDot-IKS01A1-Explora ... more

Fork of libmDot-dev-mbed2-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.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. Channel plans are included with the 3.x.x Dot Library releases. The following code snippet demonstrates how to create a channel plan and inject it into the stack.

#include "mDot.h"
#include "channel_plans.h"

int main() {
    ChannelPlan* plan = new lora::ChannelPlan_US915();
    assert(plan);
    mDot* dot = mDot::getInstance(plan);
    assert(dot);

    // ...
}

Dot devices must not be deployed with software using a different channel plan than the Dot's default plan! This functionality is for development and testing only!

Multicast Sessions

Multicast sessions and packet rx events in library. When in Class C mode Multicast downlinks can be received. Recieved packets should be filtered on address, counter value will be maintained in the session or can be set explicitly depending on Application support to share Multicast Address, Keys and Counters.

mDot.h

        /**
         * Add a multicast session address and keys
         * Downlink counter is set to 0
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastSession(uint8_t index, uint32_t addr, const uint8_t* nsk, const uint8_t* dsk);
 
        /**
         * Set a multicast session counter
         * Up to 3 MULTICAST_SESSIONS can be set
         */
        int32_t setMulticastDownlinkCounter(uint8_t index, uint32_t count);

mDotEvent.h

The address field was added to PacketRx event.

        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);

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.

Diff: mDot.h

Revision:
31:7fdee197d415
Parent:
30:c3150500b324
Child:
43:ba29a595814e
--- a/mDot.h	Wed Sep 07 15:40:13 2016 -0500
+++ b/mDot.h	Thu Sep 08 11:15:32 2016 -0500
@@ -1043,31 +1043,40 @@
         bool readUserBackupRegister(uint32_t reg, uint32_t& data);
 
 #if defined(TARGET_MTS_MDOT_F411RE)
+        ///////////////////////////////////////////////////////////////////
+        // Filesystem (Non Volatile Memory) Operation Functions for mDot //
+        ///////////////////////////////////////////////////////////////////
+
         // Save user file data to flash
         // file - name of file max 30 chars
         // data - data of file
         // size - size of file
+        // returns true if successful
         bool saveUserFile(const char* file, void* data, uint32_t size);
 
         // Append user file data to flash
         // file - name of file max 30 chars
         // data - data of file
         // size - size of file
+        // returns true if successful
         bool appendUserFile(const char* file, void* data, uint32_t size);
 
         // Read user file data from flash
         // file - name of file max 30 chars
         // data - data of file
         // size - size of file
+        // returns true if successful
         bool readUserFile(const char* file, void* data, uint32_t size);
 
         // Move a user file in flash
         // file     - name of file
         // new_name - new name of file
+        // returns true if successful
         bool moveUserFile(const char* file, const char* new_name);
 
         // Delete user file data from flash
         // file - name of file max 30 chars
+        // returns true if successful
         bool deleteUserFile(const char* file);
 
         // Open user file in flash, max of 4 files open concurrently
@@ -1081,24 +1090,26 @@
         // file - mdot file struct
         // offset - offset in bytes
         // whence - where offset is based SEEK_SET, SEEK_CUR, SEEK_END
+        // returns true if successful
         bool seekUserFile(mDot::mdot_file& file, size_t offset, int whence);
 
         // Read bytes from open file
         // file - mdot file struct
         // data - mem location to store data
         // length - number of bytes to read
-        // returns - number of bytes written
+        // returns - number of bytes read, negative if error
         int readUserFile(mDot::mdot_file& file, void* data, size_t length);
 
         // Write bytes to open file
         // file - mdot file struct
         // data - data to write
         // length - number of bytes to write
-        // returns - number of bytes written
+        // returns - number of bytes written, negative if error
         int writeUserFile(mDot::mdot_file& file, void* data, size_t length);
 
         // Close open file
         // file - mdot file struct
+        // returns true if successful
         bool closeUserFile(mDot::mdot_file& file);
 
         // List user files stored in flash
@@ -1106,7 +1117,26 @@
 
         // Move file into the firmware upgrade path to be flashed on next boot
         // file - name of file
+        // returns true if successful
         bool moveUserFileToFirmwareUpgrade(const char* file);
+#else
+        ///////////////////////////////////////////////////////////////
+        // EEPROM (Non Volatile Memory) Operation Functions for xDot //
+        ///////////////////////////////////////////////////////////////
+        
+        // Write to EEPROM
+        // addr - address to write to (0 - 0x17FF)
+        // data - data to write
+        // size - size of data
+        // returns true if successful
+        bool nvmWrite(uint16_t addr, void* data, uint16_t size);
+
+        // Read from EEPROM
+        // addr - address to read from (0 - 0x17FF)
+        // data - buffer for data
+        // size - size of buffer
+        // returns true if successful
+        bool nvmRead(uint16_t addr, void* data, uint16_t size);
 #endif /* TARGET_MTS_MDOT_F411RE */
 
         // get current statistics