Minor optimizations & code harmonization (#708)

tekka007 · henrikekblad · commit dd9dff77ed19 · 2016-12-28T22:47:41.000+01:00
diff --git a/MySensors.h b/MySensors.h
@@ -59,11 +59,6 @@
 
 // HARDWARE
 #if defined(ARDUINO_ARCH_ESP8266)
-// Remove PSTR macros from debug prints
-#undef PSTR
-#define PSTR(x) (x)
-//#undef F
-//#define F(x) (x)
 #include "core/MyHwESP8266.cpp"
 #elif defined(ARDUINO_ARCH_AVR)
 #include "drivers/AVR/DigitalWriteFast/digitalWriteFast.h"
diff --git a/core/MyGatewayTransport.cpp b/core/MyGatewayTransport.cpp
@@ -25,7 +25,7 @@ extern bool transportSendRoute(MyMessage &message);
 extern MyMessage _msg;
 extern MyMessage _msgTmp;
 
-inline void gatewayTransportProcess()
+inline void gatewayTransportProcess(void)
 {
 	if (gatewayTransportAvailable()) {
 		_msg = gatewayTransportReceive();
diff --git a/core/MyGatewayTransport.h b/core/MyGatewayTransport.h
@@ -23,17 +23,19 @@
 #include "MyProtocol.h"
 #include "MySensorsCore.h"
 
+#define MSG_GW_STARTUP_COMPLETE "Gateway startup complete."
+
 // Common gateway functions
 
-void gatewayTransportProcess();
+void gatewayTransportProcess(void);
 
 
 // Gateway "interface" functions
 
 /**
  * initialize the driver
  */
-bool gatewayTransportInit();
+bool gatewayTransportInit(void);
 
 /**
  * Send message to controller
@@ -43,11 +45,11 @@ bool gatewayTransportSend(MyMessage &message);
 /*
  * Check if a new message is available from controller
  */
-bool gatewayTransportAvailable();
+bool gatewayTransportAvailable(void);
 
 /*
  * Pick up last message received from controller
  */
-MyMessage& gatewayTransportReceive();
+MyMessage& gatewayTransportReceive(void);
 
 #endif /* MyGatewayTransportEthernet_h */
diff --git a/core/MyGatewayTransportEthernet.cpp b/core/MyGatewayTransportEthernet.cpp
@@ -97,7 +97,7 @@ void _w5100_spi_en(bool enable)
 #define _w5100_spi_en(x)
 #endif
 
-bool gatewayTransportInit()
+bool gatewayTransportInit(void)
 {
 	_w5100_spi_en(true);
 #if defined(MY_GATEWAY_ESP8266)
@@ -147,7 +147,7 @@ bool gatewayTransportInit()
 #endif
 		debug(PSTR("Eth: connect\n"));
 		_w5100_spi_en(false);
-		gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set("Gateway startup complete."));
+		gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set(MSG_GW_STARTUP_COMPLETE));
 		_w5100_spi_en(true);
 		presentNode();
 	} else {
@@ -194,7 +194,7 @@ bool gatewayTransportSend(MyMessage &message)
 #endif
 			debug(PSTR("Eth: connect\n"));
 			_w5100_spi_en(false);
-			gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set("Gateway startup complete."));
+			gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set(MSG_GW_STARTUP_COMPLETE));
 			_w5100_spi_en(true);
 			presentNode();
 		} else {
@@ -226,7 +226,7 @@ bool gatewayTransportSend(MyMessage &message)
 bool _readFromClient(uint8_t i)
 {
 	while (clients[i].connected() && clients[i].available()) {
-		char inChar = clients[i].read();
+		const char inChar = clients[i].read();
 		if (inputString[i].idx < MY_GATEWAY_MAX_RECEIVE_LENGTH - 1) {
 			// if newline then command is complete
 			if (inChar == '\n' || inChar == '\r') {
@@ -253,10 +253,10 @@ bool _readFromClient(uint8_t i)
 	return false;
 }
 #else
-bool _readFromClient()
+bool _readFromClient(void)
 {
 	while (client.connected() && client.available()) {
-		char inChar = client.read();
+		const char inChar = client.read();
 		if (inputString.idx < MY_GATEWAY_MAX_RECEIVE_LENGTH - 1) {
 			// if newline then command is complete
 			if (inChar == '\n' || inChar == '\r') {
@@ -285,7 +285,7 @@ bool _readFromClient()
 #endif
 
 
-bool gatewayTransportAvailable()
+bool gatewayTransportAvailable(void)
 {
 	_w5100_spi_en(true);
 #if !defined(MY_IP_ADDRESS) && defined(MY_GATEWAY_W5100)
@@ -325,7 +325,7 @@ bool gatewayTransportAvailable()
 #endif
 			debug(PSTR("Eth: connect\n"));
 			_w5100_spi_en(false);
-			gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set("Gateway startup complete."));
+			gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set(MSG_GW_STARTUP_COMPLETE));
 			_w5100_spi_en(true);
 			presentNode();
 		} else {
@@ -355,7 +355,7 @@ bool gatewayTransportAvailable()
 				clients[i] = _ethernetServer.available();
 				inputString[i].idx = 0;
 				debug(PSTR("Client %d connected\n"), i);
-				gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set("Gateway startup complete."));
+				gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set(MSG_GW_STARTUP_COMPLETE));
 				// Send presentation of locally attached sensors (and node if applicable)
 				presentNode();
 			}
@@ -388,7 +388,7 @@ bool gatewayTransportAvailable()
 			client = newclient;
 			debug(PSTR("Eth: connect\n"));
 			_w5100_spi_en(false);
-			gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set("Gateway startup complete."));
+			gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set(MSG_GW_STARTUP_COMPLETE));
 			_w5100_spi_en(true);
 			presentNode();
 		}
@@ -411,14 +411,14 @@ bool gatewayTransportAvailable()
 	return false;
 }
 
-MyMessage& gatewayTransportReceive()
+MyMessage& gatewayTransportReceive(void)
 {
 	// Return the last parsed message
 	return _ethernetMsg;
 }
 
 #if !defined(MY_IP_ADDRESS) && !defined(MY_GATEWAY_ESP8266) && !defined(MY_GATEWAY_LINUX)
-void gatewayTransportRenewIP()
+void gatewayTransportRenewIP(void)
 {
 	/* renew/rebind IP address
 	 0 - nothing happened
diff --git a/core/MyGatewayTransportMQTTClient.cpp b/core/MyGatewayTransportMQTTClient.cpp
@@ -6,7 +6,7 @@
 * network topology allowing messages to be routed to nodes.
 *
 * Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
-* Copyright (C) 2013-2015 Sensnology AB
+* Copyright (C) 2013-2016 Sensnology AB
 * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
 *
 * Documentation: http://www.mysensors.org
@@ -65,7 +65,7 @@ void incomingMQTT(char* topic, uint8_t* payload, unsigned int length)
 	_MQTT_available = protocolMQTTParse(_MQTT_msg, topic, payload, length);
 }
 
-bool reconnectMQTT()
+bool reconnectMQTT(void)
 {
 	debug(PSTR("Attempting MQTT connection...\n"));
 	// Attempt to connect
@@ -88,14 +88,14 @@ bool reconnectMQTT()
 	return false;
 }
 
-bool gatewayTransportConnect()
+bool gatewayTransportConnect(void)
 {
 #if defined(MY_GATEWAY_ESP8266)
 	while (WiFi.status() != WL_CONNECTED) {
 		wait(500);
-		MY_SERIALDEVICE.print(".");
+		MY_SERIALDEVICE.print(F("."));
 	}
-	MY_SERIALDEVICE.print("IP: ");
+	MY_SERIALDEVICE.print(F("IP: "));
 	MY_SERIALDEVICE.println(WiFi.localIP());
 #elif defined(MY_GATEWAY_LINUX)
 #if defined(MY_IP_ADDRESS)
@@ -107,20 +107,20 @@ bool gatewayTransportConnect()
 #else
 	// Get IP address from DHCP
 	if (!Ethernet.begin(_MQTT_clientMAC)) {
-		MY_SERIALDEVICE.print("DHCP FAILURE...");
+		MY_SERIALDEVICE.print(F("DHCP FAILURE..."));
 		_MQTT_connecting = false;
 		return false;
 	}
 #endif
-	MY_SERIALDEVICE.print("IP: ");
+	MY_SERIALDEVICE.print(F("IP: "));
 	MY_SERIALDEVICE.println(Ethernet.localIP());
 	// give the Ethernet interface a second to initialize
 	delay(1000);
 #endif
 	return true;
 }
 
-bool gatewayTransportInit()
+bool gatewayTransportInit(void)
 {
 	_MQTT_connecting = true;
 #if defined(MY_CONTROLLER_IP_ADDRESS)
@@ -149,7 +149,7 @@ bool gatewayTransportInit()
 	return true;
 }
 
-bool gatewayTransportAvailable()
+bool gatewayTransportAvailable(void)
 {
 	if (_MQTT_connecting) {
 		return false;
@@ -167,7 +167,7 @@ bool gatewayTransportAvailable()
 	return _MQTT_available;
 }
 
-MyMessage & gatewayTransportReceive()
+MyMessage & gatewayTransportReceive(void)
 {
 	// Return the last parsed message
 	_MQTT_available = false;
diff --git a/core/MyGatewayTransportSerial.cpp b/core/MyGatewayTransportSerial.cpp
@@ -6,7 +6,7 @@
  * network topology allowing messages to be routed to nodes.
  *
  * Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
- * Copyright (C) 2013-2015 Sensnology AB
+ * Copyright (C) 2013-2016 Sensnology AB
  * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
  *
  * Documentation: http://www.mysensors.org
@@ -38,26 +38,25 @@ bool gatewayTransportSend(MyMessage &message)
 	return true;
 }
 
-bool gatewayTransportInit()
+bool gatewayTransportInit(void)
 {
-	gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set("Gateway startup complete."));
+	(void)gatewayTransportSend(buildGw(_msgTmp, I_GATEWAY_READY).set(MSG_GW_STARTUP_COMPLETE));
 	// Send presentation of locally attached sensors (and node if applicable)
 	presentNode();
-
 	return true;
 }
 
-bool gatewayTransportAvailable()
+bool gatewayTransportAvailable(void)
 {
 	while (MY_SERIALDEVICE.available()) {
 		// get the new byte:
-		char inChar = (char) MY_SERIALDEVICE.read();
+		const char inChar = (char)MY_SERIALDEVICE.read();
 		// if the incoming character is a newline, set a flag
 		// so the main loop can do something about it:
 		if (_serialInputPos < MY_GATEWAY_MAX_RECEIVE_LENGTH - 1) {
 			if (inChar == '\n') {
 				_serialInputString[_serialInputPos] = 0;
-				bool ok = protocolParse(_serialMsg, _serialInputString);
+				const bool ok = protocolParse(_serialMsg, _serialInputString);
 				if (ok) {
 					setIndication(INDICATION_GW_RX);
 				}
@@ -76,7 +75,7 @@ bool gatewayTransportAvailable()
 	return false;
 }
 
-MyMessage & gatewayTransportReceive()
+MyMessage & gatewayTransportReceive(void)
 {
 	// Return the last parsed message
 	return _serialMsg;
diff --git a/core/MyHwATMega328.h b/core/MyHwATMega328.h
@@ -34,7 +34,9 @@
 #include <Arduino.h>
 #endif
 
+#ifndef MY_SERIALDEVICE
 #define MY_SERIALDEVICE Serial
+#endif
 
 #if defined __AVR_ATmega328P__
 #ifndef sleep_bod_disable
diff --git a/core/MyHwESP8266.h b/core/MyHwESP8266.h
@@ -25,7 +25,9 @@
 #include <Arduino.h>
 #endif
 
+#ifndef MY_SERIALDEVICE
 #define MY_SERIALDEVICE Serial
+#endif
 
 #define min(a,b) ((a)<(b)?(a):(b))
 #define max(a,b) ((a)>(b)?(a):(b))
diff --git a/core/MyHwLinuxGeneric.h b/core/MyHwLinuxGeneric.h
@@ -31,7 +31,9 @@ SerialPort Serial = SerialPort(MY_LINUX_SERIAL_PTY, true);
 SerialPort Serial = SerialPort(MY_LINUX_SERIAL_PORT);
 #endif
 
+#ifndef MY_SERIALDEVICE
 #define MY_SERIALDEVICE Serial
+#endif
 
 // Define these as macros (do nothing)
 #define hwWatchdogReset()
diff --git a/core/MyHwSAMD.h b/core/MyHwSAMD.h
@@ -51,7 +51,9 @@ void hwWriteConfigBlock(void* buf, void* adr, size_t length);
 void hwWriteConfig(int adr, uint8_t value);
 uint8_t hwReadConfig(int adr);
 
+#ifndef MY_SERIALDEVICE
 #define MY_SERIALDEVICE SerialUSB
+#endif
 
 /**
  * Disable all interrupts.
diff --git a/core/MySensorsCore.cpp b/core/MySensorsCore.cpp
@@ -39,7 +39,9 @@ char _convBuf[MAX_PAYLOAD*2+1];
 void _callbackTransportReady(void)
 {
 	if (!_coreConfig.presentationSent) {
+#if !defined(MY_GATEWAY_FEATURE)	// GW calls presentNode() when client connected
 		presentNode();
+#endif
 		_registerNode();
 		_coreConfig.presentationSent = true;
 	}
@@ -94,7 +96,7 @@ void _begin(void)
 	// set defaults
 	_coreConfig.presentationSent = false;
 
-	// Call before() in sketch (if it exists)
+	// Call sketch before() (if defined)
 	if (before) {
 		CORE_DEBUG(PSTR("MCO:BGN:BFR\n"));	// before callback
 		before();
@@ -143,7 +145,7 @@ void _begin(void)
 	}
 #endif
 
-	// Call sketch setup
+	// Call sketch setup() (if defined)
 	if (setup) {
 		CORE_DEBUG(PSTR("MCO:BGN:STP\n"));	// setup callback
 		setup();
@@ -223,33 +225,39 @@ void presentNode(void)
 
 uint8_t getNodeId(void)
 {
-	uint8_t result = VALUE_NOT_DEFINED;
+	uint8_t result;
 #if defined(MY_GATEWAY_FEATURE)
 	result = GATEWAY_ADDRESS;
 #elif defined(MY_SENSOR_NETWORK)
 	result = transportGetNodeId();
+#else
+	result = VALUE_NOT_DEFINED;
 #endif
 	return result;
 }
 
 uint8_t getParentNodeId(void)
 {
-	uint8_t result = VALUE_NOT_DEFINED;
+	uint8_t result;
 #if defined(MY_GATEWAY_FEATURE)
 	result = VALUE_NOT_DEFINED;	// GW doesn't have a parent
 #elif defined(MY_SENSOR_NETWORK)
 	result = transportGetParentNodeId();
+#else
+	result = VALUE_NOT_DEFINED;
 #endif
 	return result;
 }
 
 uint8_t getDistanceGW(void)
 {
-	uint8_t result = VALUE_NOT_DEFINED;
+	uint8_t result;
 #if defined(MY_GATEWAY_FEATURE)
 	result = 0;
 #elif defined(MY_SENSOR_NETWORK)
 	result = transportGetDistanceGW();
+#else
+	result = VALUE_NOT_DEFINED;
 #endif
 	return result;
 }
diff --git a/drivers/AVR/DigitalWriteFast/digitalWriteFast.h b/drivers/AVR/DigitalWriteFast/digitalWriteFast.h
diff --git a/drivers/RF24/RF24.cpp b/drivers/RF24/RF24.cpp
diff --git a/drivers/RF24/RF24.h b/drivers/RF24/RF24.h
diff --git a/examples/SoilMoistSensor/SoilMoistSensor.ino b/examples/SoilMoistSensor/SoilMoistSensor.ino

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ extern bool transportSendRoute(MyMessage &message);`
`25`	`25`	`extern MyMessage _msg;`
`26`	`26`	`extern MyMessage _msgTmp;`
`27`	`27`
`28`		`-inline void gatewayTransportProcess()`
	`28`	`+inline void gatewayTransportProcess(void)`
`29`	`29`	`{`
`30`	`30`	`if (gatewayTransportAvailable()) {`
`31`	`31`	`_msg = gatewayTransportReceive();`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`* network topology allowing messages to be routed to nodes.`
`7`	`7`	`*`
`8`	`8`	`* Created by Henrik Ekblad <[email protected]>`
`9`		`-* Copyright (C) 2013-2015 Sensnology AB`
	`9`	`+* Copyright (C) 2013-2016 Sensnology AB`
`10`	`10`	`* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors`
`11`	`11`	`*`
`12`	`12`	`* Documentation: http://www.mysensors.org`
`@@ -65,7 +65,7 @@ void incomingMQTT(char* topic, uint8_t* payload, unsigned int length)`
`65`	`65`	`_MQTT_available = protocolMQTTParse(_MQTT_msg, topic, payload, length);`
`66`	`66`	`}`
`67`	`67`
`68`		`-bool reconnectMQTT()`
	`68`	`+bool reconnectMQTT(void)`
`69`	`69`	`{`
`70`	`70`	`debug(PSTR("Attempting MQTT connection...\n"));`
`71`	`71`	`// Attempt to connect`
`@@ -88,14 +88,14 @@ bool reconnectMQTT()`
`88`	`88`	`return false;`
`89`	`89`	`}`
`90`	`90`
`91`		`-bool gatewayTransportConnect()`
	`91`	`+bool gatewayTransportConnect(void)`
`92`	`92`	`{`
`93`	`93`	`#if defined(MY_GATEWAY_ESP8266)`
`94`	`94`	`while (WiFi.status() != WL_CONNECTED) {`
`95`	`95`	`wait(500);`
`96`		`- MY_SERIALDEVICE.print(".");`
	`96`	`+ MY_SERIALDEVICE.print(F("."));`
`97`	`97`	`}`
`98`		`- MY_SERIALDEVICE.print("IP: ");`
	`98`	`+ MY_SERIALDEVICE.print(F("IP: "));`
`99`	`99`	`MY_SERIALDEVICE.println(WiFi.localIP());`
`100`	`100`	`#elif defined(MY_GATEWAY_LINUX)`
`101`	`101`	`#if defined(MY_IP_ADDRESS)`
`@@ -107,20 +107,20 @@ bool gatewayTransportConnect()`
`107`	`107`	`#else`
`108`	`108`	`// Get IP address from DHCP`
`109`	`109`	`if (!Ethernet.begin(_MQTT_clientMAC)) {`
`110`		`- MY_SERIALDEVICE.print("DHCP FAILURE...");`
	`110`	`+ MY_SERIALDEVICE.print(F("DHCP FAILURE..."));`
`111`	`111`	`_MQTT_connecting = false;`
`112`	`112`	`return false;`
`113`	`113`	`}`
`114`	`114`	`#endif`
`115`		`- MY_SERIALDEVICE.print("IP: ");`
	`115`	`+ MY_SERIALDEVICE.print(F("IP: "));`
`116`	`116`	`MY_SERIALDEVICE.println(Ethernet.localIP());`
`117`	`117`	`// give the Ethernet interface a second to initialize`
`118`	`118`	`delay(1000);`
`119`	`119`	`#endif`
`120`	`120`	`return true;`
`121`	`121`	`}`
`122`	`122`
`123`		`-bool gatewayTransportInit()`
	`123`	`+bool gatewayTransportInit(void)`
`124`	`124`	`{`
`125`	`125`	`_MQTT_connecting = true;`
`126`	`126`	`#if defined(MY_CONTROLLER_IP_ADDRESS)`
`@@ -149,7 +149,7 @@ bool gatewayTransportInit()`
`149`	`149`	`return true;`
`150`	`150`	`}`
`151`	`151`
`152`		`-bool gatewayTransportAvailable()`
	`152`	`+bool gatewayTransportAvailable(void)`
`153`	`153`	`{`
`154`	`154`	`if (_MQTT_connecting) {`
`155`	`155`	`return false;`
`@@ -167,7 +167,7 @@ bool gatewayTransportAvailable()`
`167`	`167`	`return _MQTT_available;`
`168`	`168`	`}`
`169`	`169`
`170`		`-MyMessage & gatewayTransportReceive()`
	`170`	`+MyMessage & gatewayTransportReceive(void)`
`171`	`171`	`{`
`172`	`172`	`// Return the last parsed message`
`173`	`173`	`_MQTT_available = false;`