Timer rollover and other fixes (#440)

Author: Akubi

README.md

@@ -493,6 +493,8 @@ The following methods are available for all the child:
 	float getValueFloat();
 	double getValueDouble();
 	const char* getValueString();
+	// check if the value must be sended back to the controller
+	bool valueReadyToSend();
 	// send the current value to the gateway
 	void sendValue(bool force = 0);
 	// print the current value on a LCD display
@@ -508,6 +510,8 @@ The following methods are available for all the child:
 	void setMaxThreshold(float value);
 	// do not report values if too close to the previous one (default: 0)
 	void setValueDelta(float value);
+	// set when the last value is updated. Possible values are UPDATE_ALWAYS (at every cycle), UPDATE_ON_SEND (only after sending) (default: UPDATE_ON_SEND)
+	void setUpdateLastValue(last_value_mode value);
 	// get the last value of the child
 	int getLastValueInt();
 	float getLastValueFloat();

nodemanager/Child.cpp

@@ -136,38 +136,60 @@ const char* Child::getValueString(){
 	return _value_string;
 }
 
-// send the value back to the controller
-void Child::sendValue(bool force) {
+
+// check if the value must be sended back to the controller
+bool Child::valueReadyToSend() {
 	// do not send if no samples have been collected, unless instructed otherwise
-	if (! _send_without_value && _samples == 0) return;
+	if (!_send_without_value && _samples == 0) return false;
 #if NODEMANAGER_CONDITIONAL_REPORT == ON
-	// ignore conditional reporting settings if forced to report or if it is the first run
-	if (! force || ! _sensor->getFirstRun()) {
+	// ignore conditional reporting settings if it is the first run
+	if (!_sensor->getFirstRun()) {
 		// if the value is a number
 		if (_format != STRING) {
 			// if below or above the thresholds, do not send the value
-			if (_value < _min_threshold || _value > _max_threshold) return;
-			// if the force update timer is over, send the value regardless and restart it
-			if (_force_update_timer->isOver()) _force_update_timer->start();
-			else {
+			if (_value < _min_threshold || _value > _max_threshold) return false;
+			// if the force update timer is over, send the value
+			if (!_force_update_timer->isOver()) {
 				// if the value does not differ enough from the previous one, do not send the value
 				if (_value > (_last_value - _value_delta) && _value < (_last_value + _value_delta)) {
-					return;
+					return false;
 				}
 			}
 		}
 		// if the value is a string
 		else {
 			// if a delta is configured, do not report if the string is the same as the previous one
 			if (_value_delta > 0 && strcmp(_value_string, _last_value_string) == 0) {
-				return;
+				return false;
 			}
 		}
 	}
+#endif
+	return true;
+}
+
+
+// send the value back to the controller
+void Child::sendValue(bool force) {
+
+#if NODEMANAGER_CONDITIONAL_REPORT == ON
+	// update last value if mode = UPDATE_ALWAYS
+	if (_last_value_mode == UPDATE_ALWAYS) _last_value = _value;
+#endif
+
+	// ignore conditional reporting settings if forced to report
+	if (!force && !valueReadyToSend()) return;
+
+	// we report value
+#if NODEMANAGER_CONDITIONAL_REPORT == ON
+	// if the force update timer is over restart it
+	if (_force_update_timer->isOver()) _force_update_timer->start();
+
 	// keep track of the previous value
 	if (_format != STRING) _last_value = _value;
 	else _last_value_string = _value_string;
 #endif
+
 	// send the value to the gateway
 	if (_format == INT) nodeManager.sendMessage(_child_id,_type,(int)_value);
 	if (_format == FLOAT) nodeManager.sendMessage(_child_id,_type,(float)_value,_float_precision);
@@ -217,6 +239,9 @@ void Child::setMaxThreshold(float value) {
 void Child::setValueDelta(float value) {
 	_value_delta = value;
 }
+void Child::setUpdateLastValue(last_value_mode value) {
+	_last_value_mode = value;
+}
 
 // return the last value of the child in the requested format
 int Child::getLastValueInt() {
@@ -232,6 +257,7 @@ const char* Child::getLastValueString(){
 	return _last_value_string;
 }
 #endif
+
 #if NODEMANAGER_EEPROM == ON
 // setter/getter
 void Child::setPersistValue(bool value) {

nodemanager/Child.h

@@ -73,6 +73,8 @@ class Child {
 	float getValueFloat();
 	double getValueDouble();
 	const char* getValueString();
+	// check if the value must be sended back to the controller
+	bool valueReadyToSend();
 	// send the current value to the gateway
 	void sendValue(bool force = 0);
 	// print the current value on a LCD display
@@ -88,6 +90,8 @@ class Child {
 	void setMaxThreshold(float value);
 	// do not report values if too close to the previous one (default: 0)
 	void setValueDelta(float value);
+	// set when the last value is updated. Possible values are UPDATE_ALWAYS (at every cycle), UPDATE_ON_SEND (only after sending) (default: UPDATE_ON_SEND)
+	void setUpdateLastValue(last_value_mode value);
 	// get the last value of the child
 	int getLastValueInt();
 	float getLastValueFloat();
@@ -125,6 +129,7 @@ class Child {
 	float _min_threshold = -FLT_MAX;
 	float _max_threshold = FLT_MAX;
 	float _value_delta = 0;
+	last_value_mode _last_value_mode = UPDATE_ON_SEND;
 #endif
 #if NODEMANAGER_EEPROM == ON
 	bool _persist_value = false;

nodemanager/Constants.h

@@ -67,6 +67,14 @@ enum value_format {
 	STRING
 };
 
+#if NODEMANAGER_CONDITIONAL_REPORT == ON
+// define update last value modes
+enum last_value_mode {
+	UPDATE_ALWAYS,
+	UPDATE_ON_SEND
+};
+#endif
+
 /***********************************
 Chip type
 */

nodemanager/Node.cpp

@@ -30,7 +30,9 @@ NodeManager::NodeManager(uint8_t sensor_count) {
 	// allocate block for all the sensors if sensor_count is provided
 	if (sensor_count > 0) sensors.allocateBlocks(sensor_count);
 	// setup serial port baud rate
+#ifndef CHIP_NRF5
 	MY_SERIALDEVICE.begin(MY_BAUD_RATE);
+#endif
 	// print out the version
 	debug(PSTR(LOG_INIT "VER=" VERSION "\n"));
 	// print out sketch name

nodemanager/Timer.cpp

@@ -27,17 +27,22 @@ Timer::Timer() {
 	nodeManager.registerTimer(this);
 }
 
+// set the timer mode
 void Timer::setMode(timer_mode mode) {
 	_mode = mode;
 }
+
+// get the timer mode
 timer_mode Timer::getMode() {
 	return _mode;
 }
 
+// set the timer value in seconds
 void Timer::setValue(unsigned long value) {
 	_value = value;
 }
 
+// get the timer value in seconds
 unsigned long Timer::getValue() {
 	return _value;
 }
@@ -104,8 +109,8 @@ bool Timer::isOver() {
 	}
 #else
 	if (_mode == TIME_INTERVAL) {
-		// check if the current millis() is greater than the target
-		if (millis() > _target) return true;
+		// check for a millis() rollover. The difference between millis() and the target (in seconds) cannot be less than value
+		if ( (_target - millis()) >= (_value * 1000UL) ) return true;
 		return false;
 	}
 #endif

nodemanager/Timer.h

@@ -42,8 +42,8 @@ class Timer {
 	bool isOver();
 private:
 	timer_mode _mode = NOT_CONFIGURED;
-	unsigned long _value = 0;
-	unsigned long _target = 0;
+	unsigned long _value = 0;  // s
+	unsigned long _target = 0;  // ms
 	bool _is_running = false;
 #if NODEMANAGER_TIME == ON
 	bool _already_reported = false;

sensors/Display.h

@@ -35,6 +35,9 @@ class Display: public Sensor {
 		new Child(this,STRING,nodeManager.getAvailableChildId(child_id), S_INFO, V_TEXT,_name);
 		// prevent reporting to the gateway at each display update
 		setReportTimerMode(DO_NOT_REPORT);
+		// refresh the display every minute by default
+		setMeasureTimerValue(TIME_INTERVAL);
+		setMeasureTimerValue(60UL);
 	};
 
 	// set a static caption text on header of the display

sensors/SensorBattery.h

@@ -97,7 +97,7 @@ class SensorBattery: public Sensor {
 		}
 		volt = volt * _battery_adj_factor;
 		child->setValue(volt);
-		if (_send_battery_level) {
+		if (_send_battery_level && child->valueReadyToSend()) {
 			// calculate the percentage
 			int percentage = ((volt - _battery_min) / (_battery_max - _battery_min)) * 100;
 			if (percentage > 100) percentage = 100;