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.
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.
examples/src/auto_ota_example.cpp@29:9e2c0d990ace, 2018-04-20 (annotated)
- Committer:
- Evan Hosseini
- Date:
- Fri Apr 20 14:42:46 2018 -0500
- Revision:
- 29:9e2c0d990ace
- Parent:
- 25:56f7775c702f
- Child:
- 30:2f5ae37e6c47
Back out NetworkMode config so code still builds with stable 3.0 library
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
mfiore | 0:a151a6350d7f | 1 | #include "dot_util.h" |
Mike Fiore |
14:19fae4509473 | 2 | #include "RadioEvent.h" |
mfiore | 0:a151a6350d7f | 3 | |
mfiore | 0:a151a6350d7f | 4 | #if ACTIVE_EXAMPLE == AUTO_OTA_EXAMPLE |
mfiore | 0:a151a6350d7f | 5 | |
mfiore | 17:d4f82e16de5f | 6 | ///////////////////////////////////////////////////////////////////////////// |
mfiore | 17:d4f82e16de5f | 7 | // -------------------- DOT LIBRARY REQUIRED ------------------------------// |
mfiore | 17:d4f82e16de5f | 8 | // * Because these example programs can be used for both mDot and xDot // |
mfiore | 17:d4f82e16de5f | 9 | // devices, the LoRa stack is not included. The libmDot library should // |
mfiore | 17:d4f82e16de5f | 10 | // be imported if building for mDot devices. The libxDot library // |
mfiore | 17:d4f82e16de5f | 11 | // should be imported if building for xDot devices. // |
mfiore | 17:d4f82e16de5f | 12 | // * https://developer.mbed.org/teams/MultiTech/code/libmDot-dev-mbed5/ // |
mfiore | 17:d4f82e16de5f | 13 | // * https://developer.mbed.org/teams/MultiTech/code/libmDot-mbed5/ // |
mfiore | 17:d4f82e16de5f | 14 | // * https://developer.mbed.org/teams/MultiTech/code/libxDot-dev-mbed5/ // |
mfiore | 17:d4f82e16de5f | 15 | // * https://developer.mbed.org/teams/MultiTech/code/libxDot-mbed5/ // |
mfiore | 17:d4f82e16de5f | 16 | ///////////////////////////////////////////////////////////////////////////// |
mfiore | 17:d4f82e16de5f | 17 | |
Mike Fiore |
5:97ed5f2f099e | 18 | ///////////////////////////////////////////////////////////// |
Mike Fiore |
5:97ed5f2f099e | 19 | // * these options must match the settings on your gateway // |
Mike Fiore |
5:97ed5f2f099e | 20 | // * edit their values to match your configuration // |
Mike Fiore |
5:97ed5f2f099e | 21 | // * frequency sub band is only relevant for the 915 bands // |
Mike Fiore |
5:97ed5f2f099e | 22 | // * either the network name and passphrase can be used or // |
Mike Fiore |
5:97ed5f2f099e | 23 | // the network ID (8 bytes) and KEY (16 bytes) // |
Mike Fiore |
5:97ed5f2f099e | 24 | ///////////////////////////////////////////////////////////// |
mfiore | 3:0e3e776e2862 | 25 | static std::string network_name = "MultiTech"; |
mfiore | 3:0e3e776e2862 | 26 | static std::string network_passphrase = "MultiTech"; |
Mike Fiore |
5:97ed5f2f099e | 27 | static uint8_t network_id[] = { 0x6C, 0x4E, 0xEF, 0x66, 0xF4, 0x79, 0x86, 0xA6 }; |
Mike Fiore |
5:97ed5f2f099e | 28 | static uint8_t network_key[] = { 0x1F, 0x33, 0xA1, 0x70, 0xA5, 0xF1, 0xFD, 0xA0, 0xAB, 0x69, 0x7A, 0xAE, 0x2B, 0x95, 0x91, 0x6B }; |
mfiore | 3:0e3e776e2862 | 29 | static uint8_t frequency_sub_band = 0; |
Evan Hosseini |
25:56f7775c702f | 30 | static uint8_t join_delay = 5; |
Mike Fiore |
15:364df461110f | 31 | static uint8_t ack = 0; |
Mike Fiore |
21:09d05faf0e13 | 32 | static bool adr = true; |
mfiore | 0:a151a6350d7f | 33 | |
mfiore | 0:a151a6350d7f | 34 | // deepsleep consumes slightly less current than sleep |
mfiore | 0:a151a6350d7f | 35 | // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up |
mfiore | 0:a151a6350d7f | 36 | // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up |
mfiore | 0:a151a6350d7f | 37 | // if deep_sleep == true, device will enter deepsleep mode |
mfiore | 1:c4915e00d2ce | 38 | static bool deep_sleep = true; |
mfiore | 0:a151a6350d7f | 39 | |
mfiore | 0:a151a6350d7f | 40 | mDot* dot = NULL; |
Mike Fiore |
21:09d05faf0e13 | 41 | lora::ChannelPlan* plan = NULL; |
mfiore | 0:a151a6350d7f | 42 | |
mfiore | 0:a151a6350d7f | 43 | Serial pc(USBTX, USBRX); |
mfiore | 0:a151a6350d7f | 44 | |
mfiore | 0:a151a6350d7f | 45 | int main() { |
Mike Fiore |
14:19fae4509473 | 46 | // Custom event handler for automatically displaying RX data |
Mike Fiore |
14:19fae4509473 | 47 | RadioEvent events; |
Mike Fiore |
14:19fae4509473 | 48 | |
mfiore | 0:a151a6350d7f | 49 | pc.baud(115200); |
mfiore | 0:a151a6350d7f | 50 | |
mfiore | 0:a151a6350d7f | 51 | mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL); |
mfiore | 0:a151a6350d7f | 52 | |
Mike Fiore |
21:09d05faf0e13 | 53 | #if CHANNEL_PLAN == CP_US915 |
Mike Fiore |
21:09d05faf0e13 | 54 | plan = new lora::ChannelPlan_US915(); |
Mike Fiore |
21:09d05faf0e13 | 55 | #elif CHANNEL_PLAN == CP_AU915 |
Mike Fiore |
21:09d05faf0e13 | 56 | plan = new lora::ChannelPlan_AU915(); |
Mike Fiore |
21:09d05faf0e13 | 57 | #elif CHANNEL_PLAN == CP_EU868 |
Mike Fiore |
21:09d05faf0e13 | 58 | plan = new lora::ChannelPlan_EU868(); |
Mike Fiore |
21:09d05faf0e13 | 59 | #elif CHANNEL_PLAN == CP_KR920 |
Mike Fiore |
21:09d05faf0e13 | 60 | plan = new lora::ChannelPlan_KR920(); |
Mike Fiore |
21:09d05faf0e13 | 61 | #elif CHANNEL_PLAN == CP_AS923 |
Mike Fiore |
21:09d05faf0e13 | 62 | plan = new lora::ChannelPlan_AS923(); |
Mike Fiore |
21:09d05faf0e13 | 63 | #elif CHANNEL_PLAN == CP_AS923_JAPAN |
Mike Fiore |
21:09d05faf0e13 | 64 | plan = new lora::ChannelPlan_AS923_Japan(); |
mfiore | 22:d9bc10bbc433 | 65 | #elif CHANNEL_PLAN == CP_IN865 |
mfiore | 22:d9bc10bbc433 | 66 | plan = new lora::ChannelPlan_IN865(); |
Mike Fiore |
21:09d05faf0e13 | 67 | #endif |
Mike Fiore |
21:09d05faf0e13 | 68 | assert(plan); |
Mike Fiore |
21:09d05faf0e13 | 69 | |
Mike Fiore |
21:09d05faf0e13 | 70 | dot = mDot::getInstance(plan); |
Mike Fiore |
21:09d05faf0e13 | 71 | assert(dot); |
mfiore | 0:a151a6350d7f | 72 | |
Mike Fiore |
14:19fae4509473 | 73 | // attach the custom events handler |
Mike Fiore |
14:19fae4509473 | 74 | dot->setEvents(&events); |
Mike Fiore |
14:19fae4509473 | 75 | |
Mike Fiore |
12:ec9768677cea | 76 | if (!dot->getStandbyFlag()) { |
Mike Fiore |
16:a3832552dfe1 | 77 | logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION); |
Mike Fiore |
16:a3832552dfe1 | 78 | |
Mike Fiore |
12:ec9768677cea | 79 | // start from a well-known state |
Mike Fiore |
12:ec9768677cea | 80 | logInfo("defaulting Dot configuration"); |
Mike Fiore |
12:ec9768677cea | 81 | dot->resetConfig(); |
Mike Fiore |
12:ec9768677cea | 82 | dot->resetNetworkSession(); |
Mike Fiore |
12:ec9768677cea | 83 | |
Mike Fiore |
12:ec9768677cea | 84 | // make sure library logging is turned on |
Mike Fiore |
12:ec9768677cea | 85 | dot->setLogLevel(mts::MTSLog::INFO_LEVEL); |
mfiore | 0:a151a6350d7f | 86 | |
Mike Fiore |
12:ec9768677cea | 87 | // update configuration if necessary |
Mike Fiore |
12:ec9768677cea | 88 | // in AUTO_OTA mode the session is automatically saved, so saveNetworkSession and restoreNetworkSession are not needed |
Mike Fiore |
12:ec9768677cea | 89 | if (dot->getJoinMode() != mDot::AUTO_OTA) { |
Mike Fiore |
12:ec9768677cea | 90 | logInfo("changing network join mode to AUTO_OTA"); |
Mike Fiore |
12:ec9768677cea | 91 | if (dot->setJoinMode(mDot::AUTO_OTA) != mDot::MDOT_OK) { |
Mike Fiore |
12:ec9768677cea | 92 | logError("failed to set network join mode to AUTO_OTA"); |
Mike Fiore |
12:ec9768677cea | 93 | } |
mfiore | 0:a151a6350d7f | 94 | } |
Mike Fiore |
12:ec9768677cea | 95 | // in OTA and AUTO_OTA join modes, the credentials can be passed to the library as a name and passphrase or an ID and KEY |
Mike Fiore |
12:ec9768677cea | 96 | // only one method or the other should be used! |
Mike Fiore |
12:ec9768677cea | 97 | // network ID = crc64(network name) |
Mike Fiore |
12:ec9768677cea | 98 | // network KEY = cmac(network passphrase) |
Evan Hosseini |
29:9e2c0d990ace | 99 | update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, ack); |
Mike Fiore |
12:ec9768677cea | 100 | //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack); |
Mike Fiore |
12:ec9768677cea | 101 | |
Mike Fiore |
15:364df461110f | 102 | // configure network link checks |
Mike Fiore |
15:364df461110f | 103 | // 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 |
Mike Fiore |
15:364df461110f | 104 | // check the link every count packets |
Mike Fiore |
15:364df461110f | 105 | // declare the Dot disconnected after threshold failed link checks |
Mike Fiore |
21:09d05faf0e13 | 106 | // for count = 3 and threshold = 5, the Dot will ask for a link check response every 5 packets and will consider the connection lost if it fails to receive 3 responses in a row |
Mike Fiore |
15:364df461110f | 107 | update_network_link_check_config(3, 5); |
Mike Fiore |
15:364df461110f | 108 | |
Mike Fiore |
21:09d05faf0e13 | 109 | // enable or disable Adaptive Data Rate |
Mike Fiore |
21:09d05faf0e13 | 110 | dot->setAdr(adr); |
Evan Hosseini |
25:56f7775c702f | 111 | |
Evan Hosseini |
25:56f7775c702f | 112 | // Configure the join delay |
Evan Hosseini |
25:56f7775c702f | 113 | dot->setJoinDelay(join_delay); |
Mike Fiore |
21:09d05faf0e13 | 114 | |
Mike Fiore |
12:ec9768677cea | 115 | // save changes to configuration |
Mike Fiore |
12:ec9768677cea | 116 | logInfo("saving configuration"); |
Mike Fiore |
12:ec9768677cea | 117 | if (!dot->saveConfig()) { |
Mike Fiore |
12:ec9768677cea | 118 | logError("failed to save configuration"); |
Mike Fiore |
12:ec9768677cea | 119 | } |
Mike Fiore |
12:ec9768677cea | 120 | |
Mike Fiore |
12:ec9768677cea | 121 | // display configuration |
Mike Fiore |
12:ec9768677cea | 122 | display_config(); |
mfiore | 0:a151a6350d7f | 123 | } |
mfiore | 0:a151a6350d7f | 124 | |
Evan Hosseini |
25:56f7775c702f | 125 | uint8_t counter = 0; |
mfiore | 0:a151a6350d7f | 126 | while (true) { |
mfiore | 0:a151a6350d7f | 127 | std::vector<uint8_t> tx_data; |
mfiore | 0:a151a6350d7f | 128 | |
mfiore | 0:a151a6350d7f | 129 | // join network if not joined |
mfiore | 0:a151a6350d7f | 130 | if (!dot->getNetworkJoinStatus()) { |
mfiore | 0:a151a6350d7f | 131 | join_network(); |
mfiore | 0:a151a6350d7f | 132 | } |
mfiore | 0:a151a6350d7f | 133 | |
Evan Hosseini |
25:56f7775c702f | 134 | tx_data.push_back(++counter); |
Evan Hosseini |
25:56f7775c702f | 135 | logInfo("sending uplink with data = %d", counter); |
mfiore | 0:a151a6350d7f | 136 | send_data(tx_data); |
mfiore | 0:a151a6350d7f | 137 | |
mfiore | 0:a151a6350d7f | 138 | // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method |
mfiore | 0:a151a6350d7f | 139 | //sleep_wake_rtc_only(deep_sleep); |
mfiore | 0:a151a6350d7f | 140 | //sleep_wake_interrupt_only(deep_sleep); |
mfiore | 0:a151a6350d7f | 141 | sleep_wake_rtc_or_interrupt(deep_sleep); |
mfiore | 0:a151a6350d7f | 142 | } |
mfiore | 0:a151a6350d7f | 143 | |
mfiore | 0:a151a6350d7f | 144 | return 0; |
mfiore | 0:a151a6350d7f | 145 | } |
mfiore | 0:a151a6350d7f | 146 | |
mfiore | 0:a151a6350d7f | 147 | #endif |