Merge pull request #13 from TheThingsNetwork/feature/low-power-mode

Low power mode example

Author: johanstokking

.travis.yml

@@ -11,7 +11,7 @@ before_install:
   - sudo ln -s /usr/local/share/arduino/arduino /usr/local/bin/arduino
 install:
   - ln -s $PWD /usr/local/share/arduino/libraries/TheThingsNode
-  - arduino --install-library "DHT sensor library:1.3.0,Adafruit Unified Sensor:1.0.2,TheThingsNetwork:2.3.1"
+  - arduino --install-library "DHT sensor library:1.3.0,Adafruit Unified Sensor:1.0.2,TheThingsNetwork:2.5.6"
   - git clone https://github.com/sparkfun/arduino_boards /tmp/sparkfun
   - mv /tmp/sparkfun/sparkfun /usr/local/share/arduino/hardware/sparkfun
 before_script:

docs/TheThingsNode.md

@@ -81,6 +81,9 @@ void sleep() {
 }
 ```
 
+Pay attention, this internal sleep method of the library does not put the LoRa module (RN2483 or RN2903) into sleep mode and thus your node may consume 3mA even in sleep mode. You need to manually set the LoRa module to sleep and wake. 
+Check the example [BatteryMonitorLPP](../examples/BatteryMonitorLPP/)
+
 ## Interval
 Instead of using your `loop()` function, use `configInterval()` and `onInterval()` to set a function to be called on a certain interval:
 

examples/Basic/Basic.ino

@@ -118,6 +118,9 @@ void onButtonRelease(unsigned long duration)
 
 void sendData(uint8_t port)
 {
+  // Wake RN2483
+  ttn.wake();
+
   ttn.showStatus();
   node->showStatus();
 
@@ -140,4 +143,11 @@ void sendData(uint8_t port)
   payload[5] = bytes[0];
 
   ttn.sendBytes(payload, sizeof(payload), port);
+
+  // Set RN2483 to sleep mode
+  ttn.sleep(60000);
+
+  // This one is not optionnal, remove it
+  // and say bye bye to RN2983 sleep mode
+  delay(50);
 }

examples/BatteryMonitorLPP/BatteryMonitorLPP.ino

@@ -0,0 +1,153 @@
+#include <TheThingsNode.h>
+#include <TheThingsNetwork.h>
+#include <CayenneLPP.h>
+
+// Set your AppEUI and AppKey
+const char *appEui = "0000000000000000";
+const char *appKey = "00000000000000000000000000000000";
+
+// Replace REPLACE_ME with TTN_FP_EU868 or TTN_FP_US915
+#define freqPlan REPLACE_ME
+
+#define loraSerial Serial1
+#define debugSerial Serial
+
+TheThingsNetwork ttn(loraSerial, debugSerial, freqPlan);
+TheThingsNode *node;
+CayenneLPP lpp(16);
+
+#define PORT_SETUP 1
+#define PORT_INTERVAL 2
+#define PORT_MOTION 3
+#define PORT_BUTTON 4
+
+// Interval between send in seconds, so 300s = 5min
+#define CONFIG_INTERVAL ((uint32_t) 300)
+
+void sendData(uint8_t port = PORT_SETUP, uint32_t duration = 0);
+
+// This is called on each interval we defined so mainly
+// this is where we need to do our job
+void interval()
+{
+  node->setColor(TTN_BLUE);
+  debugSerial.println(F("-- SEND: INTERVAL"));
+  sendData(PORT_INTERVAL);
+}
+
+// This is called on each wake, every 8S or by an sensor/button interrupt
+// if it's watchdog, we mainly do nothing (core IRQ, we don't have choice)
+// but if it's an interupt it will ne bone ine loop
+void wake()
+{
+  debugSerial.println(F("-- WAKE"));
+
+  // Just if you want to see this IRQ with a LED, remove for LOW power
+  //node->setColor(TTN_GREEN);
+  //delay(50);
+  //node->setColor(TTN_BLACK);
+  //delay(100);
+}
+
+void sleep()
+{
+  node->setColor(TTN_BLACK);
+
+  // Just in case, disable all sensors
+  // this couldn't hurt except time to do job
+  node->configMotion(false);
+  node->configLight(false);
+  node->configTemperature(false);
+}
+
+void onButtonRelease(unsigned long duration)
+{
+  uint16_t adc_value;
+  uint32_t timepressed = (uint32_t) duration;
+
+  node->setColor(TTN_BLUE);
+
+  debugSerial.print(F("-- SEND: BUTTON "));
+  debugSerial.print(timepressed);
+  debugSerial.println(F(" ms"));
+
+  sendData(PORT_BUTTON, timepressed);
+}
+
+void sendData(uint8_t port, uint32_t value)
+{
+  // Wake RN2483 
+  ttn.wake();
+
+  // Read battery voltage
+  uint16_t vbat = node->getBattery();
+
+  debugSerial.print(F("Battery:\t"));
+  debugSerial.print(vbat);
+  debugSerial.println(F("mV"));
+
+  // Just send battery voltage 
+  lpp.reset();
+  lpp.addAnalogInput(4, vbat/1000.0);
+
+  // If button pressed, send press duration
+  // please myDeviceCayenne add counter value type to
+  // avoid us using analog values to send counters
+  if (port == PORT_BUTTON) {
+    debugSerial.print(F("Button:\t"));
+    debugSerial.print(value);
+    debugSerial.println(F("ms"));
+    lpp.addAnalogInput(7, value / 1000.0);
+  }
+
+  ttn.sendBytes(lpp.getBuffer(), lpp.getSize(), port);
+
+  // Set RN2483 to sleep mode
+  ttn.sleep(CONFIG_INTERVAL * 1000);
+
+  // This one is not optionnal, remove it
+  // and say bye bye to RN2983 sleep mode
+  delay(50);
+}
+
+void setup()
+{
+  loraSerial.begin(57600);
+  debugSerial.begin(9600);
+
+  // Wait a maximum of 10s for Serial Monitor
+  while (!debugSerial && millis() < 10000)
+    ;
+
+  // Config Node, Disable all sensors 
+  // Check node schematics here
+  // https://github.com/TheThingsProducts/node
+  node = TheThingsNode::setup();
+
+  // Each interval
+  node->configInterval(true, CONFIG_INTERVAL*1000); 
+  node->onWake(wake);
+  node->onInterval(interval);
+  node->onSleep(sleep);
+
+  // We monitor just button release
+  node->onButtonRelease(onButtonRelease);
+
+  // Test sensors and set LED to GREEN if it works
+  node->showStatus();
+  node->setColor(TTN_GREEN);
+
+  debugSerial.println(F("-- TTN: STATUS"));
+  ttn.showStatus();
+
+  debugSerial.println(F("-- TTN: JOIN"));
+  ttn.join(appEui, appKey);
+
+  debugSerial.println(F("-- SEND: SETUP"));
+  sendData(PORT_SETUP);
+}
+
+void loop()
+{
+  node->loop();
+}

examples/CayenneLPP/CayenneLPP.ino

@@ -97,6 +97,10 @@ void onButtonRelease(unsigned long duration)
 
 void sendData(uint8_t port)
 {
+
+  // Wake RN2483
+  ttn.wake();
+
   printSensors();
 
   lpp.reset();
@@ -112,6 +116,9 @@ void sendData(uint8_t port)
   lpp.addAccelerometer(7, x, y, z);
 
   ttn.sendBytes(lpp.getBuffer(), lpp.getSize(), port);
+
+  // Set RN module to sleep mode
+  ttn.sleep(60000);
 }
 
 void printSensors()

src/TheThingsNode.cpp

@@ -11,6 +11,7 @@
 #define TTN_GREEN_LED 5
 #define TTN_BLUE_LED 6
 #define TTN_BUTTON 16
+#define TTN_LORA_RESET 21
 #define TTN_VBAT_MEAS_EN A2
 #define TTN_VBAT_MEAS 1
 #define TTN_TEMPERATURE_SENSOR_ADDRESS 0x18
@@ -41,12 +42,12 @@
 
 Hackscribble_MCP9804 TTN_TEMPERATURE_SENSOR(TTN_TEMPERATURE_SENSOR_ADDRESS);
 
-bool TTN_TEMPERATURE = false;
-bool TTN_MOTION_START = false;
-bool TTN_MOTION_STOP = false;
-bool TTN_BUTTON_PRESS = false;
-bool TTN_BUTTON_RELEASE = false;
-uint32_t TTN_INTERVAL = 0;
+volatile bool TTN_TEMPERATURE = false;
+volatile bool TTN_MOTION_START = false;
+volatile bool TTN_MOTION_STOP = false;
+volatile bool TTN_BUTTON_PRESS = false;
+volatile bool TTN_BUTTON_RELEASE = false;
+volatile uint32_t TTN_INTERVAL = 0;
 
 void TTN_TEMPERATURE_FN()
 {
@@ -74,7 +75,9 @@ void TTN_BUTTON_FN()
   {
     TTN_BUTTON_PRESS = true;
   }
-  else if (trigger == RISING)
+
+  // Be sure main loop ACK press button before rising the release 
+  if (TTN_BUTTON_PRESS == false && trigger == RISING ) 
   {
     TTN_BUTTON_RELEASE = true;
   }
@@ -217,8 +220,16 @@ void TheThingsNode::loop()
   }
   else
   {
-    Serial.flush();
-    deepSleep();
+    // Don't go to sleep mode while button is still pressed
+    // because if so, timer of ms will be stopped and duration
+    // of pressed button will not work
+    if (this->buttonPressed) {
+      delay(100);
+      TTN_INTERVAL = TTN_INTERVAL + 100;
+    } else {
+      Serial.flush();
+      deepSleep();
+    }
   }
 }
 
@@ -737,6 +748,15 @@ TheThingsNode::TheThingsNode()
   pinMode(TTN_BLUE_LED, OUTPUT);
   setColor(TTN_BLACK);
 
+  // hardware reset of LoRa module, so module is reset on sketch upload 
+  #ifdef TTN_LORA_RESET
+  pinMode(TTN_LORA_RESET, OUTPUT);
+  digitalWrite(TTN_LORA_RESET, LOW);
+  delay(100);
+  digitalWrite(TTN_LORA_RESET, HIGH);
+  #endif
+
+
   // TODO: Can we enable/disable this at will to save memory?
   USBCON |= (1 << OTGPADE);