Add library status indication & improve error LED feedback (#462)

Yveaux · Yveaux · commit e0e78a6bae18 · 2016-06-06T18:43:42.000+02:00
* Added MyIndication to provide status feedback from the library

* Fix: Allow led blinking for hardware errors

* Refactor LED blinking implementation to show blink patterns

* Refactor LED blinking to show blink pattern
diff --git a/libraries/MySensors/MySensor.h b/libraries/MySensors/MySensor.h
@@ -142,6 +142,8 @@
 	#include "core/MyLeds.h"
 #endif
 
+#include "core/MyIndication.cpp"
+
 
 // INCLUSION MODE
 #if defined(MY_INCLUSION_MODE_FEATURE)
diff --git a/libraries/MySensors/core/MyGatewayTransportEthernet.cpp b/libraries/MySensors/core/MyGatewayTransportEthernet.cpp
@@ -151,6 +151,8 @@ bool gatewayTransportSend(MyMessage &message)
 	bool ret = true;
 	char *_ethernetMsg = protocolFormat(message);
 
+    setIndication(INDICATION_GW_TX);
+
 	_w5100_spi_en(true);
 	#if defined(MY_CONTROLLER_IP_ADDRESS)
 		#if defined(MY_USE_UDP)
@@ -267,6 +269,7 @@ bool gatewayTransportAvailable()
 
 		if (packet_size) {
 			//debug(PSTR("UDP packet available. Size:%d\n"), packet_size);
+            setIndication(INDICATION_GW_RX);
 			#if defined(MY_GATEWAY_ESP8266)
 				_ethernetServer.read(inputString[0].string, MY_GATEWAY_MAX_RECEIVE_LENGTH);
 				inputString[0].string[packet_size] = 0;
@@ -316,6 +319,7 @@ bool gatewayTransportAvailable()
 				// Loop over clients connect and read available data
 			for (uint8_t i = 0; i < ARRAY_SIZE(clients); i++) {
 				if (_readFromClient(i)) {
+                    setIndication(INDICATION_GW_RX);
 					_w5100_spi_en(false);
 					return true;
 				}
@@ -341,6 +345,7 @@ bool gatewayTransportAvailable()
 					client.stop();
 				} else {
 					if (_readFromClient()) {
+                        setIndication(INDICATION_GW_RX);
 						_w5100_spi_en(false);
 						return true;
 					}
diff --git a/libraries/MySensors/core/MyGatewayTransportMQTTClient.cpp b/libraries/MySensors/core/MyGatewayTransportMQTTClient.cpp
@@ -59,6 +59,8 @@ MyMessage _mqttMsg;
 bool gatewayTransportSend(MyMessage &message) {
 	if (!_client.connected())
 		return false;
+    setIndication(INDICATION_GW_TX);
+
 	snprintf_P(_fmtBuffer, MY_GATEWAY_MAX_SEND_LENGTH, PSTR(MY_MQTT_PUBLISH_TOPIC_PREFIX "/%d/%d/%d/%d/%d"), message.sender, message.sensor, mGetCommand(message), mGetAck(message), message.type);
 	debug(PSTR("Sending message on topic: %s\n"), _fmtBuffer);
 	return _client.publish(_fmtBuffer, message.getString(_convBuffer));
diff --git a/libraries/MySensors/core/MyGatewayTransportSerial.cpp b/libraries/MySensors/core/MyGatewayTransportSerial.cpp
@@ -31,6 +31,7 @@ MyMessage _serialMsg;
 
 
 bool gatewayTransportSend(MyMessage &message) {
+    setIndication(INDICATION_GW_TX);
 	MY_SERIALDEVICE.print(protocolFormat(message));
 	// Serial print is always successful
 	return true;
diff --git a/libraries/MySensors/core/MyIndication.cpp b/libraries/MySensors/core/MyIndication.cpp
@@ -0,0 +1,42 @@
+/**
+ * The MySensors Arduino library handles the wireless radio link and protocol
+ * between your home built sensors/actuators and HA controller of choice.
+ * The sensors forms a self healing radio network with optional repeaters. Each
+ * repeater and gateway builds a routing tables in EEPROM which keeps track of the
+ * network topology allowing messages to be routed to nodes.
+ *
+ * Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
+ * Copyright (C) 2013-2016 Sensnology AB
+ * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+ *
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ */
+
+#include "MyIndication.h"
+#ifdef MY_LEDS_BLINKING_FEATURE
+#include "MyLeds.h"
+#endif
+
+void setIndication( const indication_t ind )
+{
+#ifdef MY_LEDS_BLINKING_FEATURE
+    if ((INDICATION_TX == ind) || (INDICATION_GW_TX == ind))
+    {
+        ledsBlinkTx(1);
+    } else if ((INDICATION_RX == ind) || (INDICATION_GW_RX == ind))
+    {
+        ledsBlinkRx(1);
+    } else if (ind > INDICATION_ERR_START)
+    {
+        // Number of blinks indicates which error occurred.
+        ledsBlinkErr(ind-INDICATION_ERR_START);
+    }
+#endif
+    if (indication)
+        indication(ind);
+}
diff --git a/libraries/MySensors/core/MyIndication.h b/libraries/MySensors/core/MyIndication.h
@@ -0,0 +1,72 @@
+/**
+ * The MySensors Arduino library handles the wireless radio link and protocol
+ * between your home built sensors/actuators and HA controller of choice.
+ * The sensors forms a self healing radio network with optional repeaters. Each
+ * repeater and gateway builds a routing tables in EEPROM which keeps track of the
+ * network topology allowing messages to be routed to nodes.
+ *
+ * Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
+ * Copyright (C) 2013-2016 Sensnology AB
+ * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+ *
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ */
+
+#ifndef MyIndication_h
+#define MyIndication_h
+
+/**
+ * Indication type
+ */
+typedef enum {
+    INDICATION_TX = 0,                        //!< Sent a message.
+    INDICATION_RX,                            //!< Received a message.
+                                             
+    INDICATION_GW_TX,                         //!< Gateway transmit message.
+    INDICATION_GW_RX,                         //!< Gateway receive message.
+                                             
+    INDICATION_FIND_PARENT,                   //!< Start finding parent node.
+    INDICATION_GOT_PARENT,                    //!< Found parent node.
+    INDICATION_REQ_NODEID,                    //!< Request node ID.
+    INDICATION_GOT_NODEID,                    //!< Got a node ID.
+    INDICATION_REBOOT,                        //!< Rebooting node.
+    INDICATION_PRESENT,                       //!< Presenting node to gateway.
+    INDICATION_CLEAR_ROUTING,                 //!< Clear rrouting table requested.
+    INDICATION_SLEEP,                         //!< Node goes to sleep.
+    INDICATION_WAKEUP,                        //!< Node just woke from sleep.
+    INDICATION_FW_UPDATE_START,               //!< Start of OTA firmware update process.
+    INDICATION_FW_UPDATE_RX,                  //!< Received a piece of firmware data.
+
+    INDICATION_ERR_START = 100,
+    INDICATION_ERR_TX,                        //!< Failed to transmit message.
+    INDICATION_ERR_INIT_TRANSPORT,            //!< MySensors transport hardware (radio) init failure.
+    INDICATION_ERR_FIND_PARENT,               //!< Failed to find parent node.
+    INDICATION_ERR_GET_NODEID,                //!< Failed to receive node ID.
+    INDICATION_ERR_SIGN,                      //!< Error signing.
+    INDICATION_ERR_VERSION,                   //!< Protocol version mismatch.
+    INDICATION_ERR_NET_FULL,                  //!< Network full. All node ID's are taken.
+    INDICATION_ERR_INIT_GWTRANSPORT,          //!< Gateway transport hardware init failure.
+    INDICATION_ERR_LOCKED,                    //!< Node is locked.
+    INDICATION_ERR_FW_FLASH_INIT,             //!< Firmware update flash initialisation failure.
+    INDICATION_ERR_FW_TIMEOUT,                //!< Firmware update timeout.
+    INDICATION_ERR_FW_CHECKSUM,               //!< Firmware update checksum mismatch.
+    INDICATION_ERR_END
+} indication_t;
+
+/**
+ * Function which is called when something changes about the internal state of MySensors.
+ * @param ind  Event indication of what happened.
+ */
+void setIndication( const indication_t ind );
+
+/**
+ * Allow user to define their own indication handler.
+ */
+void indication( const indication_t ) __attribute__((weak));
+
+#endif
diff --git a/libraries/MySensors/core/MyLeds.cpp b/libraries/MySensors/core/MyLeds.cpp
@@ -19,81 +19,64 @@
 
 #include "MyLeds.h"
 
+#define LED_ON_OFF_RATIO        (4)       // Power of 2 please
+#define LED_PROCESS_INTERVAL_MS (MY_DEFAULT_LED_BLINK_PERIOD/LED_ON_OFF_RATIO)
+
 // these variables don't need to be volatile, since we are not using interrupts
-uint8_t _countRx;
-uint8_t _countTx;
-uint8_t _countErr;
-unsigned long _blink_next_time;
+static uint8_t countRx;
+static uint8_t countTx;
+static uint8_t countErr;
+static unsigned long prevTime = millis() - LED_PROCESS_INTERVAL_MS;     // Substract some, to make sure leds gets updated on first run.
+
+
+inline void ledsInit()
+{
+	// initialize counters
+	countRx = 0;
+	countTx = 0;
+	countErr = 0;
 
-inline void ledsInit() {
 	// Setup led pins
-	pinMode(MY_DEFAULT_RX_LED_PIN, OUTPUT);
-	pinMode(MY_DEFAULT_TX_LED_PIN, OUTPUT);
+	pinMode(MY_DEFAULT_RX_LED_PIN,  OUTPUT);
+	pinMode(MY_DEFAULT_TX_LED_PIN,  OUTPUT);
 	pinMode(MY_DEFAULT_ERR_LED_PIN, OUTPUT);
 
-	// Set initial state of leds
-	hwDigitalWrite(MY_DEFAULT_RX_LED_PIN, LED_OFF);
-	hwDigitalWrite(MY_DEFAULT_TX_LED_PIN, LED_OFF);
-	hwDigitalWrite(MY_DEFAULT_ERR_LED_PIN, LED_OFF);
-
-	// initialize counters
-	_countRx = 0;
-	_countTx = 0;
-	_countErr = 0;
+    ledsProcess();
 }
 
-inline void ledsProcess() {
+void ledsProcess() {
 	// Just return if it is not the time...
-	// http://playground.arduino.cc/Code/TimingRollover
-	if ((long)(hwMillis() - _blink_next_time) < 0)
+	if ((hwMillis() - prevTime) < LED_PROCESS_INTERVAL_MS)
 		return;
-	else
-		_blink_next_time = hwMillis() + MY_DEFAULT_LED_BLINK_PERIOD;
-
-	// do the actual blinking
-	if(_countRx && _countRx != 255) {
-		// switch led on
-		hwDigitalWrite(MY_DEFAULT_RX_LED_PIN, LED_ON);
-	}
-	else if(!_countRx) {
-		// switching off
-		hwDigitalWrite(MY_DEFAULT_RX_LED_PIN, LED_OFF);
-	}
-	if(_countRx != 255)
-		--_countRx;
-
-	if(_countTx && _countTx != 255) {
-		// switch led on
-		hwDigitalWrite(MY_DEFAULT_TX_LED_PIN, LED_ON);
-	}
-	else if(!_countTx) {
-		// switching off
-		hwDigitalWrite(MY_DEFAULT_TX_LED_PIN, LED_OFF);
-	}
-	if(_countTx != 255)
-		--_countTx;
-
-	if(_countErr && _countErr != 255) {
-		// switch led on
-		hwDigitalWrite(MY_DEFAULT_ERR_LED_PIN, LED_ON);
-	}
-	else if(!_countErr) {
-		// switching off
-		hwDigitalWrite(MY_DEFAULT_ERR_LED_PIN, LED_OFF);
-	}
-	if(_countErr != 255)
-		--_countErr;
+
+	prevTime += LED_PROCESS_INTERVAL_MS;
+
+    uint8_t state;
+
+    // For an On/Off ratio of 4, the pattern repeated will be [on, on, on, off]
+    // until the counter becomes 0.
+    state = (countRx & (LED_ON_OFF_RATIO-1)) ? LED_ON : LED_OFF;
+    hwDigitalWrite(MY_DEFAULT_RX_LED_PIN, state);
+    if (countRx)  --countRx;
+
+    state = (countTx & (LED_ON_OFF_RATIO-1)) ? LED_ON : LED_OFF;
+    hwDigitalWrite(MY_DEFAULT_TX_LED_PIN, state);
+    if (countTx)  --countTx;
+
+    state = (countErr & (LED_ON_OFF_RATIO-1)) ? LED_ON : LED_OFF;
+    hwDigitalWrite(MY_DEFAULT_ERR_LED_PIN, state);
+    if (countErr) --countErr;
 }
 
 void ledsBlinkRx(uint8_t cnt) {
-  if(_countRx == 255) { _countRx = cnt; }
+  if (!countRx) { countRx = cnt*LED_ON_OFF_RATIO; }
 }
 
 void ledsBlinkTx(uint8_t cnt) {
-  if(_countTx == 255) { _countTx = cnt; }
+  if(!countTx) { countTx = cnt*LED_ON_OFF_RATIO; }
 }
 
 void ledsBlinkErr(uint8_t cnt) {
-  if(_countErr == 255) { _countErr = cnt; }
+  if(!countErr) { countErr = cnt*LED_ON_OFF_RATIO; }
 }
 
diff --git a/libraries/MySensors/core/MyOTAFirmwareUpdate.cpp b/libraries/MySensors/core/MyOTAFirmwareUpdate.cpp
@@ -34,6 +34,7 @@ inline void firmwareOTAUpdateRequest() {
 	unsigned long enter = hwMillis();
 	if (_fwUpdateOngoing && (enter - _fwLastRequestTime > MY_OTA_RETRY_DELAY)) {
 		if (!_fwRetry) {
+            setIndication(INDICATION_ERR_FW_TIMEOUT);
 			debug(PSTR("fw upd fail\n"));
 			// Give up. We have requested MY_OTA_RETRY times without any packet in return.
 			_fwUpdateOngoing = false;
@@ -57,11 +58,13 @@ inline bool firmwareOTAUpdateProcess() {
 		NodeFirmwareConfig *firmwareConfigResponse = (NodeFirmwareConfig *)_msg.data;
 		// compare with current node configuration, if they differ, start fw fetch process
 		if (memcmp(&_fc,firmwareConfigResponse,sizeof(NodeFirmwareConfig))) {
+            setIndication(INDICATION_FW_START);
 			debug(PSTR("fw update\n"));
 			// copy new FW config
 			memcpy(&_fc,firmwareConfigResponse,sizeof(NodeFirmwareConfig));
 			// Init flash
 			if (!_flash.initialize()) {
+                setIndication(INDICATION_ERR_FW_FLASH_INIT);
 				debug(PSTR("flash init fail\n"));
 				_fwUpdateOngoing = false;
 			} else {
@@ -81,6 +84,7 @@ inline bool firmwareOTAUpdateProcess() {
 	} else if (_msg.type == ST_FIRMWARE_RESPONSE) {
 		if (_fwUpdateOngoing) {
 			// Save block to flash
+            setIndication(INDICATION_FW_RX);
 			debug(PSTR("fw block %d\n"), _fwBlock);
 			// extract FW block
 			ReplyFWBlock *firmwareResponse = (ReplyFWBlock *)_msg.data;
@@ -102,6 +106,7 @@ inline bool firmwareOTAUpdateProcess() {
 					hwWriteConfigBlock((void*)&_fc, (void*)EEPROM_FIRMWARE_TYPE_ADDRESS, sizeof(NodeFirmwareConfig));
 					hwReboot();
 				} else {
+                    setIndication(INDICATION_ERR_FW_CHECKSUM);
 					debug(PSTR("fw checksum fail\n"));
 				}
 			}
diff --git a/libraries/MySensors/core/MySensorCore.cpp b/libraries/MySensors/core/MySensorCore.cpp
diff --git a/libraries/MySensors/core/MyTransport.cpp b/libraries/MySensors/core/MyTransport.cpp
diff --git a/libraries/MySensors/examples/BinarySwitchSensorIndication/BinarySwitchSensorIndication.ino b/libraries/MySensors/examples/BinarySwitchSensorIndication/BinarySwitchSensorIndication.ino
