MultiTech
Example programs for MultiTech Dot devices demonstrating how to use the Dot devices and the Dot libraries for LoRa communication.
Dependencies: ISL29011
Dependents: Dot-Examples-delujoc
This project has moved to github
Please see GitHub Dot-Examples
Dot Library Not Included!
Because these example programs can be used for both mDot and xDot devices, the LoRa stack is not included. The libmDot library should be imported if building for mDot devices. The libxDot library should be imported if building for xDot devices.
Dot Library Limitations
Commit messages in Dot Library repositories specify the version of the library and the version of mbed-os it was compiled against. We recommend building your application with the version of mbed-os specified in the commit message of the version of the Dot library you're using. This will ensure that you don't run into any runtime issues caused by differences in the mbed-os versions.
Example Programs Description
This application contains multiple example programs. Each example demonstrates a different way to configure and use a Dot. A short summary of each example is provided below. Common code used by multiple examples is in the dot_utils.cpp file.
All examples print logging, including RX data, on the USB debug port at 115200 baud. Each example defaults the Dot's configuration and saves the new configuration to NVM.
OTA Example
This example demonstrates configuring the Dot for OTA join mode and entering sleep or deepsleep mode between transactions with the gateway. If deepsleep mode is used, the session is saved and restored so that a rejoin is not necessary after waking up even though RAM contents have been lost. ACKs are disabled, but network link checks are configured - if enough link checks are missed, the Dot will no longer be considered joined to the network and will attempt to rejoin before transmitting more data.
AUTO_OTA Example
This example demonstrates configuring the Dot for AUTO_OTA join mode and entering sleep or deepsleep mode between transactions with the gateway. AUTO_OTA join mode automatically saves and restores the session when deepsleep mode is used, so the manual saving and restoring of the session is not necessary. ACKs are disabled, but network link checks are configured - if enough link checks are missed, the Dot will no longer be considered joined to the network and will attempt to rejoin before transmitting more data.
Manual Example
This example demonstrates configuring the Dot for MANUAL join mode and entering sleep or deepsleep mode between transactions with the gateway. The Dot must be provisioned on the gateway before its packets will be accepted! Follow these steps to provision the Dot on a Conduit gateway:
- ssh into the conduit
- use the lorq-query application to provision the Dot on the gateway
- lora-query -a 01020304 A 0102030401020304 <your Dot's device ID> 01020304010203040102030401020304 01020304010203040102030401020304
- if any of the credentials change on the Dot side, they must be updated on the gateway side as well
To provision a Dot on a third-party gateway, see the gateway or network provider documentation.
Class B Example
This example demonstrates how to configure the dot for an OTA join, how to acquire a lock on a GPS synchronized beacon, and then to subsequently enter class B mode of operation. After a successful join, the device will request to the dot-library to switch to class B. When this happens, the library will send an uplink to the network server (hence we must be joined first before entering this mode) requesting the GPS time to calculate when the next beacon is expected. Once this time elapses, the dot will open an rx window to demodulate the broadcasted beacon and fire an mDotEvent::BeaconRx event upon successful reception. After the beacon is received, the example sends an uplink which will have the class B bit in the packet's frame control set to indicate to the network server that downlinks may now be scheduled on ping slots. The lora-query application can be used to configure a Conduit gateway to communicate with a Dot in class B mode. For information on how to inform a third-party gateway that a Dot is operating in class B mode, see the gateway or network provider documentation.
Class C Example
This example demonstrates configuring the Dot for OTA join mode and communicating with the gateway using class C mode. In class C mode the gateway can send a packet to the Dot at any time, so it must be listening whenever it is not transmitting. This means that the Dot cannot enter sleep or deepsleep mode. The gateway will not immediately send packets to the Dot (outside the receive windows following a transmission from the Dot) until it is informed that the Dot is operating in class C mode. The lora-query application can be used to configure a Conduit gateway to communicate with a Dot in class C mode. For information on how to inform a third-party gateway that a Dot is operating in class C mode, see the gateway or network provider documentation.
FOTA Example
Full FOTA support is available on mDot and on xDot with external flash. See this article for details on adding external flash for xDot FOTA.
Without 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.
This example demonstrates how to incorporate over-the-air updates to an application. The example uses a Class C application. Class A or B functionality could also be used. The device will automatically enter into Class C operation for the FOTA operation, Class B would be disabled during the FOTA transfer.
- 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 and multicast 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, uint32_t fcnt, bool dupRx) {
mDotEvent::PacketRx(port, payload, size, rssi, snr, ctrl, slot, retries, address, fcnt, 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 FOTA.
mbed_app.json
{
"macros": [
"FOTA=1"
]
}
Peer to Peer Example
This example demonstrates configuring Dots for peer to peer communication without a gateway. It should be compiled and run on two Dots. Peer to peer communication uses LoRa modulation but uses a single higher throughput (usually 500kHz or 250kHz) datarate. It is similar to class C operation - when a Dot isn't transmitting, it's listening for packets from the other Dot. Both Dots must be configured exactly the same for peer to peer communication to be successful.
Choosing An Example Program and Channel Plan
Only the active example is compiled. The active example can be updated by changing the ACTIVE_EXAMPLE definition in the examples/example_config.h file.
By default the OTA_EXAMPLE will be compiled and the US915 channel plan will be used.
example_config.h
#ifndef __EXAMPLE__CONFIG_H__ #define __EXAMPLE__CONFIG_H__ #define OTA_EXAMPLE 1 // see ota_example.cpp #define AUTO_OTA_EXAMPLE 2 // see auto_ota_example.cpp #define MANUAL_EXAMPLE 3 // see manual_example.cpp #define PEER_TO_PEER_EXAMPLE 4 // see peer_to_peer_example.cpp #define CLASS_C_EXAMPLE 5 // see class_c_example.cpp // the active example is the one that will be compiled #if !defined(ACTIVE_EXAMPLE) #define ACTIVE_EXAMPLE OTA_EXAMPLE #endif // the active channel plan is the one that will be compiled // options are : // CP_US915 // CP_AU915 // CP_EU868 // CP_KR920 // CP_AS923 // CP_AS923_JAPAN #if !defined(CHANNEL_PLAN) #define CHANNEL_PLAN CP_US915 #endif #endif
Compile the AUTO_OTA_EXAMPLE and use the EU868 channel plan instead.
example_config.h
#ifndef __EXAMPLE__CONFIG_H__ #define __EXAMPLE__CONFIG_H__ #define OTA_EXAMPLE 1 // see ota_example.cpp #define AUTO_OTA_EXAMPLE 2 // see auto_ota_example.cpp #define MANUAL_EXAMPLE 3 // see manual_example.cpp #define PEER_TO_PEER_EXAMPLE 4 // see peer_to_peer_example.cpp #define CLASS_C_EXAMPLE 5 // see class_c_example.cpp // the active example is the one that will be compiled #if !defined(ACTIVE_EXAMPLE) #define ACTIVE_EXAMPLE AUTO_OTA_EXAMPLE #endif // the active channel plan is the one that will be compiled // options are : // CP_US915 // CP_AU915 // CP_EU868 // CP_KR920 // CP_AS923 // CP_AS923_JAPAN #if !defined(CHANNEL_PLAN) #define CHANNEL_PLAN CP_EU868 #endif #endif
Dot Libraries
Stable and development libraries are available for both mDot and xDot platforms. The library chosen must match the target platform. Compiling for the mDot platform with the xDot library or vice versa will not succeed.
mDot Library
Development library for mDot.
Stable library for mDot.
For mbed-os 5 use:
Import librarylibmDot-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.
Last commit 25 Mar 2020 by 
MultiTech
xDot Library
Development library for xDot.
Stable library for xDot.
For mbed-os 5 use:
Import librarylibxDot-mbed5
Stable version of the xDot library for mbed 5. This version of the library is suitable for deployment scenarios.
Last commit 02 Apr 2020 by MultiTech
Revision 31:b1d5811e3d5d, committed 2018-08-23
- Comitter:
- Evan Hosseini
- Date:
- Thu Aug 23 15:40:00 2018 -0500
- Parent:
- 30:2f5ae37e6c47
- Child:
- 32:febff0fd3195
- Commit message:
- Updates for version 3.1 of the dot library
Changed in this revision
--- a/examples/inc/dot_util.h Mon Apr 30 14:46:28 2018 -0500 +++ b/examples/inc/dot_util.h Thu Aug 23 15:40:00 2018 -0500 @@ -13,11 +13,11 @@ void display_config(); -void update_ota_config_name_phrase(std::string network_name, std::string network_passphrase, uint8_t frequency_sub_band, bool public_network, uint8_t ack); +void update_ota_config_name_phrase(std::string network_name, std::string network_passphrase, uint8_t frequency_sub_band, lora::NetworkType network_type, uint8_t ack); void update_ota_config_id_key(uint8_t *network_id, uint8_t *network_key, uint8_t frequency_sub_band, bool public_network, uint8_t ack); -void update_manual_config(uint8_t *network_address, uint8_t *network_session_key, uint8_t *data_session_key, uint8_t frequency_sub_band, bool public_network, uint8_t ack); +void update_manual_config(uint8_t *network_address, uint8_t *network_session_key, uint8_t *data_session_key, uint8_t frequency_sub_band, lora::NetworkType public_network, uint8_t ack); void update_peer_to_peer_config(uint8_t *network_address, uint8_t *network_session_key, uint8_t *data_session_key, uint32_t tx_frequency, uint8_t tx_datarate, uint8_t tx_power);
--- a/examples/src/auto_ota_example.cpp Mon Apr 30 14:46:28 2018 -0500
+++ b/examples/src/auto_ota_example.cpp Thu Aug 23 15:40:00 2018 -0500
@@ -27,7 +27,7 @@
static uint8_t network_id[] = { 0x6C, 0x4E, 0xEF, 0x66, 0xF4, 0x79, 0x86, 0xA6 };
static uint8_t network_key[] = { 0x1F, 0x33, 0xA1, 0x70, 0xA5, 0xF1, 0xFD, 0xA0, 0xAB, 0x69, 0x7A, 0xAE, 0x2B, 0x95, 0x91, 0x6B };
static uint8_t frequency_sub_band = 0;
-static bool public_network = true;
+static lora::NetworkType network_type = lora::PUBLIC_LORAWAN;
static uint8_t join_delay = 5;
static uint8_t ack = 0;
static bool adr = true;
@@ -108,8 +108,8 @@
// only one method or the other should be used!
// network ID = crc64(network name)
// network KEY = cmac(network passphrase)
- update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
- //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
+ update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, network_type, ack);
+ //update_ota_config_id_key(network_id, network_key, frequency_sub_band, network_type, ack);
// configure network link checks
// network link checks are a good alternative to requiring the gateway to ACK every packet and should allow a single gateway to handle more Dots
--- a/examples/src/class_c_example.cpp Mon Apr 30 14:46:28 2018 -0500
+++ b/examples/src/class_c_example.cpp Thu Aug 23 15:40:00 2018 -0500
@@ -27,7 +27,7 @@
static uint8_t network_id[] = { 0x6C, 0x4E, 0xEF, 0x66, 0xF4, 0x79, 0x86, 0xA6 };
static uint8_t network_key[] = { 0x1F, 0x33, 0xA1, 0x70, 0xA5, 0xF1, 0xFD, 0xA0, 0xAB, 0x69, 0x7A, 0xAE, 0x2B, 0x95, 0x91, 0x6B };
static uint8_t frequency_sub_band = 0;
-static bool public_network = true;
+static lora::NetworkType network_type = lora::PUBLIC_LORAWAN;
static uint8_t join_delay = 5;
static uint8_t ack = 1;
static bool adr = true;
@@ -100,8 +100,8 @@
// only one method or the other should be used!
// network ID = crc64(network name)
// network KEY = cmac(network passphrase)
- update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
- //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
+ update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, network_type, ack);
+ //update_ota_config_id_key(network_id, network_key, frequency_sub_band, network_type, ack);
// configure the Dot for class C operation
// the Dot must also be configured on the gateway for class C
--- a/examples/src/dot_util.cpp Mon Apr 30 14:46:28 2018 -0500
+++ b/examples/src/dot_util.cpp Thu Aug 23 15:40:00 2018 -0500
@@ -24,7 +24,17 @@
if (lora::ChannelPlan::IsPlanFixed(dot->getFrequencyBand())) {
logInfo("frequency sub band ------- %u", dot->getFrequencySubBand());
}
- logInfo("public network ----------- %s", dot->getPublicNetwork() ? "on" : "off");
+
+ std::string network_mode_str("Undefined");
+ uint8_t network_mode = dot->getPublicNetwork();
+ if (network_mode == lora::PRIVATE_MTS)
+ network_mode_str = "Private MTS";
+ else if (network_mode == lora::PUBLIC_LORAWAN)
+ network_mode_str = "Public LoRaWAN";
+ else if (network_mode == lora::PRIVATE_LORAWAN)
+ network_mode_str = "Private LoRaWAN";
+ logInfo("public network ----------- %s", network_mode_str.c_str());
+
logInfo("=========================");
logInfo("credentials configuration");
logInfo("=========================");
@@ -58,11 +68,11 @@
}
}
-void update_ota_config_name_phrase(std::string network_name, std::string network_passphrase, uint8_t frequency_sub_band, bool public_network, uint8_t ack) {
+void update_ota_config_name_phrase(std::string network_name, std::string network_passphrase, uint8_t frequency_sub_band, lora::NetworkType network_type, uint8_t ack) {
std::string current_network_name = dot->getNetworkName();
std::string current_network_passphrase = dot->getNetworkPassphrase();
uint8_t current_frequency_sub_band = dot->getFrequencySubBand();
- bool current_public_network = dot->getPublicNetwork();
+ uint8_t current_network_type = dot->getPublicNetwork();
uint8_t current_ack = dot->getAck();
if (current_network_name != network_name) {
@@ -88,10 +98,9 @@
}
}
- if (current_public_network != public_network) {
- logInfo("changing public network from %s to %s", current_public_network ? "on" : "off", public_network ? "on" : "off");
- if (dot->setPublicNetwork(public_network) != mDot::MDOT_OK) {
- logError("failed to set public network to %s", public_network ? "on" : "off");
+ if (current_network_type != network_type) {
+ if (dot->setPublicNetwork(network_type) != mDot::MDOT_OK) {
+ logError("failed to set network type");
}
}
@@ -103,11 +112,11 @@
}
}
-void update_ota_config_id_key(uint8_t *network_id, uint8_t *network_key, uint8_t frequency_sub_band, bool public_network, uint8_t ack) {
+void update_ota_config_id_key(uint8_t *network_id, uint8_t *network_key, uint8_t frequency_sub_band, lora::NetworkType network_type, uint8_t ack) {
std::vector<uint8_t> current_network_id = dot->getNetworkId();
std::vector<uint8_t> current_network_key = dot->getNetworkKey();
uint8_t current_frequency_sub_band = dot->getFrequencySubBand();
- bool current_public_network = dot->getPublicNetwork();
+ uint8_t current_network_type = dot->getPublicNetwork();
uint8_t current_ack = dot->getAck();
std::vector<uint8_t> network_id_vector(network_id, network_id + 8);
@@ -136,10 +145,9 @@
}
}
- if (current_public_network != public_network) {
- logInfo("changing public network from %s to %s", current_public_network ? "on" : "off", public_network ? "on" : "off");
- if (dot->setPublicNetwork(public_network) != mDot::MDOT_OK) {
- logError("failed to set public network to %s", public_network ? "on" : "off");
+ if (current_network_type != network_type) {
+ if (dot->setPublicNetwork(network_type) != mDot::MDOT_OK) {
+ logError("failed to set network type");
}
}
@@ -151,12 +159,12 @@
}
}
-void update_manual_config(uint8_t *network_address, uint8_t *network_session_key, uint8_t *data_session_key, uint8_t frequency_sub_band, bool public_network, uint8_t ack) {
+void update_manual_config(uint8_t *network_address, uint8_t *network_session_key, uint8_t *data_session_key, uint8_t frequency_sub_band, lora::NetworkType network_type, uint8_t ack) {
std::vector<uint8_t> current_network_address = dot->getNetworkAddress();
std::vector<uint8_t> current_network_session_key = dot->getNetworkSessionKey();
std::vector<uint8_t> current_data_session_key = dot->getDataSessionKey();
uint8_t current_frequency_sub_band = dot->getFrequencySubBand();
- bool current_public_network = dot->getPublicNetwork();
+ uint8_t current_network_type = dot->getPublicNetwork();
uint8_t current_ack = dot->getAck();
std::vector<uint8_t> network_address_vector(network_address, network_address + 4);
@@ -191,10 +199,9 @@
}
}
- if (current_public_network != public_network) {
- logInfo("changing public network from %s to %s", current_public_network ? "on" : "off", public_network ? "on" : "off");
- if (dot->setPublicNetwork(public_network) != mDot::MDOT_OK) {
- logError("failed to set public network to %s", public_network ? "on" : "off");
+ if (current_network_type != network_type) {
+ if (dot->setPublicNetwork(network_type) != mDot::MDOT_OK) {
+ logError("failed to set network type");
}
}
--- a/examples/src/manual_example.cpp Mon Apr 30 14:46:28 2018 -0500
+++ b/examples/src/manual_example.cpp Thu Aug 23 15:40:00 2018 -0500
@@ -24,7 +24,7 @@
static uint8_t network_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
static uint8_t data_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
static uint8_t frequency_sub_band = 6;
-static bool public_network = true;
+static lora::NetworkType network_type = lora::PUBLIC_LORAWAN;
static uint8_t join_delay = 5;
static uint8_t ack = 1;
static bool adr = true;
@@ -111,7 +111,7 @@
// lora-query -a 01020304 A 0102030401020304 <your Dot's device ID> 01020304010203040102030401020304 01020304010203040102030401020304
// * if you change the network address, network session key, or data session key, make sure you update them on the gateway
// to provision your Dot with a 3rd party gateway, see the gateway or network provider documentation
- update_manual_config(network_address, network_session_key, data_session_key, frequency_sub_band, public_network, ack);
+ update_manual_config(network_address, network_session_key, data_session_key, frequency_sub_band, network_type, ack);
// enable or disable Adaptive Data Rate
dot->setAdr(adr);
--- a/examples/src/ota_example.cpp Mon Apr 30 14:46:28 2018 -0500
+++ b/examples/src/ota_example.cpp Thu Aug 23 15:40:00 2018 -0500
@@ -27,7 +27,7 @@
static uint8_t network_id[] = { 0x6C, 0x4E, 0xEF, 0x66, 0xF4, 0x79, 0x86, 0xA6 };
static uint8_t network_key[] = { 0x1F, 0x33, 0xA1, 0x70, 0xA5, 0xF1, 0xFD, 0xA0, 0xAB, 0x69, 0x7A, 0xAE, 0x2B, 0x95, 0x91, 0x6B };
static uint8_t frequency_sub_band = 0;
-static bool public_network = true;
+static lora::NetworkType network_type = lora::PUBLIC_LORAWAN;
static uint8_t join_delay = 5;
static uint8_t ack = 0;
static bool adr = true;
@@ -107,8 +107,8 @@
// only one method or the other should be used!
// network ID = crc64(network name)
// network KEY = cmac(network passphrase)
- update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
- //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
+ update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, network_type, ack);
+ //update_ota_config_id_key(network_id, network_key, frequency_sub_band, network_type, ack);
// configure network link checks
// network link checks are a good alternative to requiring the gateway to ACK every packet and should allow a single gateway to handle more Dots
--- a/mbed-os.lib Mon Apr 30 14:46:28 2018 -0500 +++ b/mbed-os.lib Thu Aug 23 15:40:00 2018 -0500 @@ -1,1 +1,1 @@ -https://github.com/ARMmbed/mbed-os/#fc1836545dcc2fc86f03b01292b62bf2089f67c3 +https://github.com/ARMmbed/mbed-os/#16bac101a6b7b4724023dcf86ece1548e3a23cbf