Revision 4:36e214ebfa56, committed 2015-09-30

Comitter:

mfiore

Date:

Wed Sep 30 19:49:02 2015 +0000

Parent:

3:fa15d594858c

Child:

5:6b988a804fcb

Commit message:

add comments clarifying configuration and behavior

Changed in this revision

--- a/main.cpp	Thu Sep 10 18:23:17 2015 +0000
+++ b/main.cpp	Wed Sep 30 19:49:02 2015 +0000
@@ -1,8 +1,9 @@
 #include "mbed.h"
 #include "mDot.h"
+#include "MTSLog.h"
 #include <string>
 #include <vector>
-#include "MTSLog.h"
+#include <algorithm>
 
 // these options must match the settings on your Conduit
 // uncomment the following lines and edit their values to match your configuration
@@ -14,7 +15,7 @@
     int32_t ret;
     mDot* dot;
     std::vector<uint8_t> data;
-    std::string data_str = "hello world!";
+    std::string data_str = "hello!";
     
     // get a mDot handle
     dot = mDot::getInstance();
@@ -28,22 +29,44 @@
     // reset to default config so we know what state we're in
     dot->resetConfig();
     
-    dot->setLogLevel(mts::MTSLog::TRACE_LEVEL);
+    dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
 
     // set up the mDot with our network information: frequency sub band, network name, and network password
     // these can all be saved in NVM so they don't need to be set every time - see mDot::saveConfig()
+    
+    // frequency sub band is only applicable in the 915 (US) frequency band
+    // if using a MultiTech Conduit gateway, use the same sub band as your Conduit (1-8) - the mDot will use the 8 channels in that sub band
+    // if using a gateway that supports all 64 channels, use sub band 0 - the mDot will use all 64 channels
     logInfo("setting frequency sub band");
     if ((ret = dot->setFrequencySubBand(config_frequency_sub_band)) != mDot::MDOT_OK) {
         logError("failed to set frequency sub band %d:%s", ret, mDot::getReturnCodeString(ret).c_str());
     }
+    
     logInfo("setting network name");
     if ((ret = dot->setNetworkName(config_network_name)) != mDot::MDOT_OK) {
         logError("failed to set network name %d:%s", ret, mDot::getReturnCodeString(ret).c_str());
     }
+    
     logInfo("setting network password");
     if ((ret = dot->setNetworkPassphrase(config_network_pass)) != mDot::MDOT_OK) {
         logError("failed to set network password %d:%s", ret, mDot::getReturnCodeString(ret).c_str());
     }
+    
+    // a higher spreading factor allows for longer range but lower throughput
+    // in the 915 (US) frequency band, spreading factors 7 - 10 are available
+    // in the 868 (EU) frequency band, spreading factors 7 - 12 are available
+    logInfo("setting TX spreading factor");
+    if ((ret = dot->setTxDataRate(mDot::SF_10)) != mDot::MDOT_OK) {
+        logError("failed to set TX datarate %d:%s", ret, mDot::getReturnCodeString(ret).c_str());
+    }
+    
+    // request receive confirmation of packets from the gateway
+    logInfo("enabling ACKs");
+    if ((ret = dot->setAck(1)) != mDot::MDOT_OK) {
+        logError("failed to enable ACKs %d:%s", ret, mDot::getReturnCodeString(ret).c_str());
+    }
+    
+    // save this configuration to the mDot's NVM
     logInfo("saving config");
     if (! dot->saveConfig()) {
         logError("failed to save configuration");
@@ -56,7 +79,8 @@
     logInfo("joining network");
     while ((ret = dot->joinNetwork()) != mDot::MDOT_OK) {
         logError("failed to join network %d:%s", ret, mDot::getReturnCodeString(ret).c_str());
-        wait(2);
+        // in the 868 (EU) frequency band, we need to wait until another channel is available before transmitting again
+        osDelay(std::max((uint32_t)1000, (uint32_t)dot->getNextTxMs()));
     }
 
     // format data for sending to the gateway
@@ -64,15 +88,15 @@
         data.push_back((uint8_t) *it);
 
     while (true) {
-        // send the data
-        // ACKs are enabled by default, so we're expecting to get one back
+        // send the data to the gateway
         if ((ret = dot->send(data)) != mDot::MDOT_OK) {
             logError("failed to send", ret, mDot::getReturnCodeString(ret).c_str());
         } else {
             logInfo("successfully sent data to gateway");
         }
 
-        wait(5);
+        // in the 868 (EU) frequency band, we need to wait until another channel is available before transmitting again
+        osDelay(std::max((uint32_t)5000, (uint32_t)dot->getNextTxMs()));
     }
 
     return 0;

--- a/mbed-rtos.lib	Thu Sep 10 18:23:17 2015 +0000
+++ b/mbed-rtos.lib	Wed Sep 30 19:49:02 2015 +0000
@@ -1,1 +1,1 @@
-http://mbed.org/users/mbed_official/code/mbed-rtos/#ef0a22cdf839
+http://mbed.org/users/mbed_official/code/mbed-rtos/#d7bd06319118

--- a/mbed.bld	Thu Sep 10 18:23:17 2015 +0000
+++ b/mbed.bld	Wed Sep 30 19:49:02 2015 +0000
@@ -1,1 +1,1 @@
-http://mbed.org/users/mbed_official/code/mbed/builds/8ed44a420e5c
\ No newline at end of file
+http://mbed.org/users/mbed_official/code/mbed/builds/4f6c30876dfa
\ No newline at end of file