Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
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:
- libmDot-mbed5 -> production-ready build for mDot
- libmDot-dev-mbed5 -> development build for mDot
- libxDot-mbed5 -> production-ready build for xDot
- libxDot-dev-mbed5 -> development build for xDot
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:
- 19:f3a46d2bb9b3
- Parent:
- 17:306ffaa5d79b
- Child:
- 30:c3150500b324
--- a/mDot.h Thu Aug 18 17:38:05 2016 +0000
+++ b/mDot.h Fri Aug 19 16:23:07 2016 -0500
@@ -89,6 +89,7 @@
public:
+#if defined(TARGET_MTS_MDOT_F411RE)
typedef enum {
FM_APPEND = (1 << 0),
FM_TRUNC = (1 << 1),
@@ -98,6 +99,7 @@
FM_RDWR = (FM_RDONLY | FM_WRONLY),
FM_DIRECT = (1 << 5)
} FileMode;
+#endif /* TARGET_MTS_MDOT_F411RE */
typedef enum {
MDOT_OK = 0,
@@ -201,13 +203,29 @@
UBR7,
UBR8,
UBR9
+#if defined (TARGET_XDOT_L151CC)
+ ,UBR10,
+ UBR11,
+ UBR12,
+ UBR13,
+ UBR14,
+ UBR15,
+ UBR16,
+ UBR17,
+ UBR18,
+ UBR19,
+ UBR20,
+ UBR21
+#endif /* TARGET_XDOT_L151CC */
};
+#if defined(TARGET_MTS_MDOT_F411RE)
typedef struct {
int16_t fd;
char name[33];
uint32_t size;
} mdot_file;
+#endif /* TARGET_MTS_MDOT_F411RE */
typedef struct {
uint32_t Up;
@@ -255,7 +273,11 @@
static std::string FrequencyBandStr(uint8_t band);
static std::string FrequencySubBandStr(uint8_t band);
+#if defined(TARGET_MTS_MDOT_F411RE)
uint32_t UserRegisters[10];
+#else
+ uint32_t UserRegisters[22];
+#endif /* TARGET_MTS_MDOT_F411RE */
/** Get a handle to the singleton object
* @returns pointer to mDot object
@@ -989,35 +1011,44 @@
* @param deepsleep if true go into deep sleep mode (lowest power, all memory and registers are lost, peripherals turned off)
* else go into sleep mode (low power, memory and registers are maintained, peripherals stay on)
*
- * in sleep mode, the device can be woken up on an XBEE_DI (2-8) pin or by the RTC alarm
- * in deepsleep mode, the device can only be woken up using the WKUP pin (PA0, XBEE_DIO7) or by the RTC alarm
+ * For the MDOT
+ * in sleep mode, the device can be woken up on an XBEE_DI (2-8) pin or by the RTC alarm
+ * in deepsleep mode, the device can only be woken up using the WKUP pin (PA0, XBEE_DIO7) or by the RTC alarm
+ * For the XDOT
+ * in sleep mode, the device can be woken up on GPIO (0-3), UART1_RX, WAKE or by the RTC alarm
+ * in deepsleep mode, the device can only be woken up using the WKUP pin (PA0, WAKE) or by the RTC alarm
*/
void sleep(const uint32_t& interval, const uint8_t& wakeup_mode = RTC_ALARM, const bool& deepsleep = true);
/** Set wake pin
- * @param pin the pin to use to wake the device from sleep mode XBEE_DI (2-8)
+ * @param pin the pin to use to wake the device from sleep mode
+ * For MDOT, XBEE_DI (2-8)
+ * For XDOT, GPIO (0-3), UART1_RX, or WAKE
*/
void setWakePin(const PinName& pin);
/** Get wake pin
- * @returns the pin to use to wake the device from sleep mode XBEE_DI (2-8)
+ * @returns the pin to use to wake the device from sleep mode
+ * For MDOT, XBEE_DI (2-8)
+ * For XDOT, GPIO (0-3), UART1_RX, or WAKE
*/
PinName getWakePin();
/** Write data in a user backup register
- * @param register one of UBR0 through UBR9
+ * @param register one of UBR0 through UBR9 for MDOT, one of UBR0 through UBR21 for XDOT
* @param data user data to back up
* @returns true if success
*/
bool writeUserBackupRegister(uint32_t reg, uint32_t data);
/** Read data in a user backup register
- * @param register one of UBR0 through UBR9
+ * @param register one of UBR0 through UBR9 for MDOT, one of UBR0 through UBR21 for XDOT
* @param data gets set to content of register
* @returns true if success
*/
bool readUserBackupRegister(uint32_t reg, uint32_t& data);
+#if defined(TARGET_MTS_MDOT_F411RE)
// Save user file data to flash
// file - name of file max 30 chars
// data - data of file
@@ -1082,6 +1113,7 @@
// Move file into the firmware upgrade path to be flashed on next boot
// file - name of file
bool moveUserFileToFirmwareUpgrade(const char* file);
+#endif /* TARGET_MTS_MDOT_F411RE */
// get current statistics
// Join Attempts, Join Fails, Up Packets, Down Packets, Missed Acks
@@ -1262,4 +1294,3 @@
};
#endif
-
