Extend hardware for target WIN32 with VC++ for Visual Studio

Align Win32 HAL for VirtualBoard

Support VM_USE_HARDWARE to access IOWarrior hardware

Support VB_FIRMATA_PORT to access Firmata hardware

Author: virtual-maker

MyConfig.h

@@ -305,14 +305,52 @@
 //#define MY_RS485_DE_INVERSE
 
 /**
- * @def MY_RS485_HWSERIAL
- * @brief Define this if RS485 is connected to a hardware serial port.
- *
- * Example: @code #define MY_RS485_HWSERIAL Serial1 @endcode
- */
+* @def MY_RS485_HWSERIAL
+* @brief Define this if RS485 is connected to a hardware serial port.
+*
+* Example: @code #define MY_RS485_HWSERIAL Serial1 @endcode
+*/
 //#define MY_RS485_HWSERIAL (Serial1)
 /** @}*/ // End of RS485SettingGrpPub group
 
+/**
+* @defgroup EtherTcpSettingGrpPub ETHER_TCP
+* @ingroup RadioSettingGrpPub
+* @brief These options are specific to the Ethernet via TCP transport.
+* @{
+*/
+
+/**
+* @def MY_ETHER_TCP
+* @brief Define this to use the Ethernet via TCP transport or WiFi with ESP8266 for sensor network communication.
+*/
+//#define MY_ETHER_TCP
+
+/**
+* @def MY_ETHER_TCP_SERVER
+* @brief The ETHER_TCP server name or server IP.
+*/
+#ifndef MY_ETHER_TCP_SERVER
+#define MY_ETHER_TCP_SERVER "localhost"
+#endif
+
+/**
+* @def MY_ETHER_TCP_PORT
+* @brief The ETHER_TCP server IP port.
+*/
+#ifndef MY_ETHER_TCP_PORT
+#define MY_ETHER_TCP_PORT (5445)
+#endif
+
+/**
+* @def MY_ETHER_TCP_MAX_MESSAGE_LENGTH
+* @brief The maximum message length used for Ethernet TCP transport.
+*/
+#ifndef MY_ETHER_TCP_MAX_MESSAGE_LENGTH
+#define MY_ETHER_TCP_MAX_MESSAGE_LENGTH (40)
+#endif
+/** @}*/ // End of EtherTcpSettingGrpPub group
+
 /**
  * @defgroup RF24SettingGrpPub RF24
  * @ingroup TransportSettingGrpPub
@@ -1250,6 +1288,17 @@
  *        Incompatible libraries are unable to send sensor data.
  */
 #define MY_CORE_COMPATIBILITY_CHECK
+
+/**
+* @def MY_PROCESS_SYNCHRONIZATION
+* @brief This applies only to MyVirtualSensor WIN32 applications.
+*        If defined, _coreprocess() will acquire a named mutex and stop
+*        all other running virtual MySensors applications until _process ends.
+*        This is useful for debug of this application in Visual Studio
+*        while other MyVirtualSensor WIN32 applications are running at the same time.
+*        When you reach a breakpoint in this app then all ather applications also will stop.
+*/
+//#define MY_PROCESS_SYNCHRONIZATION
 /** @}*/ // End of CoreSettingGrpPub group
 
 /**
@@ -1445,6 +1494,8 @@
  * @brief Define this for Ethernet GW based on the ESP32.
  * @def MY_GATEWAY_LINUX
  * @brief Define this for Ethernet GW based on Linux.
+ * @def MY_GATEWAY_WIN32
+ * @brief Define this for Ethernet GW based on Windows.
  * @def MY_GATEWAY_TINYGSM
  * @brief Define this for Ethernet GW based on GSM modems supported by TinyGSM library.
  * @def MY_GATEWAY_MQTT_CLIENT
@@ -1459,6 +1510,7 @@
 //#define MY_GATEWAY_ESP8266_SECURE
 //#define MY_GATEWAY_ESP32
 //#define MY_GATEWAY_LINUX
+//#define MY_GATEWAY_WIN32
 //#define MY_GATEWAY_TINYGSM
 //#define MY_GATEWAY_MQTT_CLIENT
 //#define MY_GATEWAY_SERIAL
@@ -2271,6 +2323,24 @@
 #define MY_LINUX_CONFIG_FILE "/etc/mysensors.conf"
 #endif
 /** @}*/ // End of LinuxSettingGrpPub group
+
+/**
+ * @defgroup Win32SettingGrpPub Win32
+ * @ingroup PlatformSettingGrpPub
+ * @brief These options control Win32 specific configurations.
+ * @{
+ */
+
+/**
+* @def MY_WIN32_CONFIG_FILE
+* @brief Sets the filepath for the gateway config file.
+*
+* @note For now the configuration file is only used to store the emulated eeprom state.
+*/
+#ifndef MY_WIN32_CONFIG_FILE
+#define MY_WIN32_CONFIG_FILE "mysensors-eeprom.dat"
+#endif
+/** @}*/ // End of Win32SettingGrpPub group
 /** @}*/ // End of PlatformSettingGrpPub group
 
 /*
@@ -2283,7 +2353,7 @@
  * MY_IS_GATEWAY is true when @ref MY_GATEWAY_FEATURE is set.
  * MY_NODE_TYPE contain a string describing the class of sketch/node (gateway/repeater/node).
  */
-#if defined(MY_GATEWAY_SERIAL) || defined(MY_GATEWAY_W5100) || defined(MY_GATEWAY_ENC28J60) || defined(MY_GATEWAY_ESP8266) || defined(MY_GATEWAY_ESP32)|| defined(MY_GATEWAY_LINUX) || defined(MY_GATEWAY_MQTT_CLIENT) || defined(MY_GATEWAY_TINYGSM)
+#if defined(MY_GATEWAY_SERIAL) || defined(MY_GATEWAY_W5100) || defined(MY_GATEWAY_ENC28J60) || defined(MY_GATEWAY_ESP8266) || defined(MY_GATEWAY_ESP32)|| defined(MY_GATEWAY_LINUX) || defined(MY_GATEWAY_MQTT_CLIENT) || defined(MY_GATEWAY_TINYGSM) || defined(MY_GATEWAY_WIN32)
 #define MY_GATEWAY_FEATURE
 #define MY_IS_GATEWAY (true)
 #define MY_NODE_TYPE "GW"
@@ -2313,16 +2383,28 @@
 #if defined(MY_DEBUG) || defined(MY_DEBUG_VERBOSE_CORE) || defined(MY_DEBUG_VERBOSE_TRANSPORT) || defined(MY_DEBUG_VERBOSE_GATEWAY) || defined(MY_DEBUG_VERBOSE_SIGNING) || defined(MY_DEBUG_VERBOSE_OTA_UPDATE) || defined(MY_DEBUG_VERBOSE_RF24) || defined(MY_DEBUG_VERBOSE_NRF5_ESB) || defined(MY_DEBUG_VERBOSE_RFM69) || defined(MY_DEBUG_VERBOSE_RFM95) || defined(MY_DEBUG_VERBOSE_TRANSPORT_HAL)
 #define DEBUG_OUTPUT_ENABLED	//!< DEBUG_OUTPUT_ENABLED
 #ifndef MY_DEBUG_OTA
+#if defined(WIN32)
+#define DEBUG_OUTPUT(x,...)		hwDebugPrint(x, __VA_ARGS__)	//!< debug
+#else
 #define DEBUG_OUTPUT(x,...)		hwDebugPrint(x, ##__VA_ARGS__)	//!< debug
+#endif
 #else
 #ifndef MY_OTA_LOG_SENDER_FEATURE
 #define MY_OTA_LOG_SENDER_FEATURE
 #endif
 #ifndef MY_DEBUG_OTA_DISABLE_ECHO
+#if defined(WIN32)
+#define DEBUG_OUTPUT(x,...)		OTALog((MY_DEBUG_OTA), true, x, __VA_ARGS__)	//!< debug
+#else
 #define DEBUG_OUTPUT(x,...)		OTALog((MY_DEBUG_OTA), true, x, ##__VA_ARGS__)	//!< debug
+#endif
+#else
+#if defined(WIN32)
+#define DEBUG_OUTPUT(x,...)		OTALog((MY_DEBUG_OTA), false, x, __VA_ARGS__)	//!< debug
 #else
 #define DEBUG_OUTPUT(x,...)		OTALog((MY_DEBUG_OTA), false, x, ##__VA_ARGS__)	//!< debug
 #endif
+#endif
 // disable radio related debugging messages
 #undef MY_DEBUG_VERBOSE_RF24
 #undef MY_DEBUG_VERBOSE_NRF5_ESB
@@ -2469,6 +2551,7 @@
 #define MY_WIFI_BSSID
 #define MY_WIFI_PASSWORD
 #define MY_GATEWAY_LINUX
+#define MY_GATEWAY_WIN32
 #define MY_GATEWAY_TINYGSM
 #define MY_GATEWAY_MQTT_CLIENT
 #define MY_GATEWAY_SERIAL

MySensors.h

@@ -54,7 +54,10 @@
 // HARDWARE
 #include "hal/architecture/MyHwHAL.h"
 #include "hal/crypto/MyCryptoHAL.h"
-#if defined(ARDUINO_ARCH_ESP8266)
+#if defined(WIN32)
+#include "hal/architecture/Win32/MyHwWin32Generic.cpp"
+#include "hal/crypto/generic/MyCryptoGeneric.cpp"
+#elif defined(ARDUINO_ARCH_ESP8266)
 #if defined(MY_EXT_EEPROM)
 #include "drivers/extEEPROM/extEEPROM.cpp"
 #endif
@@ -142,7 +145,7 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 #if defined(MY_SIGNING_ATSHA204) && defined(MY_SIGNING_SOFT)
 #error Only one signing engine can be activated
 #endif
-#if defined(MY_SIGNING_ATSHA204) && defined(__linux__)
+#if defined(MY_SIGNING_ATSHA204) && (defined(__linux__) || defined(WIN32))
 #error No support for ATSHA204 on this platform
 #endif
 
@@ -245,6 +248,12 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 #include "hal/architecture/Linux/drivers/core/EthernetServer.h"
 #include "hal/architecture/Linux/drivers/core/IPAddress.h"
 #include "core/MyGatewayTransportEthernet.cpp"
+#elif defined(MY_GATEWAY_WIN32)
+// GATEWAY - Generic Windows
+#if defined(MY_USE_UDP)
+#error UDP mode is not available for Windows
+#endif
+#include "core/MyGatewayTransportEthernetWin32.cpp"
 #elif defined(MY_GATEWAY_W5100)
 // GATEWAY - W5100
 #include "core/MyGatewayTransportEthernet.cpp"
@@ -306,6 +315,13 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 
 // TRANSPORT INCLUDES
 #if defined(MY_RADIO_RF24) || defined(MY_RADIO_NRF5_ESB) || defined(MY_RADIO_RFM69) || defined(MY_RADIO_RFM95) || defined(MY_RS485) || defined (MY_PJON)
+
+// BRIDGE TRANSPORT INCLUDES
+#if defined(MY_REPEATER_FEATURE) && (defined(MY_BRIDGE_XY_TRANSPORT) || defined(MY_BRIDGE_ZZ_TRANSPORT))
+#define MY_BRIDGE_FEATURE
+#include "hal/bridgeTransport/MyBridgeTransportHAL.h"
+#endif
+
 #include "hal/transport/MyTransportHAL.h"
 #include "core/MyTransport.h"
 
@@ -329,7 +345,7 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 #define MY_RAM_ROUTING_TABLE_ENABLED
 #elif defined(MY_RAM_ROUTING_TABLE_FEATURE) && defined(MY_REPEATER_FEATURE)
 // activate feature based on architecture
-#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_NRF5) || defined(ARDUINO_ARCH_STM32F1) || defined(TEENSYDUINO) || defined(__linux__)
+#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_SAMD) || defined(ARDUINO_ARCH_NRF5) || defined(ARDUINO_ARCH_STM32F1) || defined(TEENSYDUINO) || defined(__linux__) || defined(WIN32)
 #define MY_RAM_ROUTING_TABLE_ENABLED
 #elif defined(ARDUINO_ARCH_AVR)
 #if defined(__avr_atmega1280__) || defined(__avr_atmega1284__) || defined(__avr_atmega2560__)
@@ -373,7 +389,7 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 #include "hal/transport/NRF5_ESB/MyTransportNRF5_ESB.cpp"
 #elif defined(MY_RS485)
 #if !defined(MY_RS485_HWSERIAL)
-#if defined(__linux__)
+#if defined(__linux__) || defined(WIN32)
 #error You must specify MY_RS485_HWSERIAL for RS485 transport
 #endif
 #include "drivers/AltSoftSerial/AltSoftSerial.cpp"
@@ -398,11 +414,18 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 #include "hal/transport/PJON/MyTransportPJON.cpp"
 #endif
 
+#if defined(MY_BRIDGE_FEATURE)
+// Include bridge transport libraries
+#endif
+
 #if (defined(MY_RF24_ENABLE_ENCRYPTION) && defined(MY_RADIO_RF24)) || (defined(MY_NRF5_ESB_ENABLE_ENCRYPTION) && defined(MY_RADIO_NRF5_ESB)) || (defined(MY_RFM69_ENABLE_ENCRYPTION) && defined(MY_RADIO_RFM69)) || (defined(MY_RFM95_ENABLE_ENCRYPTION) && defined(MY_RADIO_RFM95))
 #define MY_TRANSPORT_ENCRYPTION //!< ïnternal flag
 #endif
 
 #include "hal/transport/MyTransportHAL.cpp"
+#if defined(MY_BRIDGE_FEATURE)
+#include "hal/bridgeTransport/MyBridgeTransportHAL.cpp"
+#endif
 
 // PASSIVE MODE
 #if defined(MY_PASSIVE_NODE) && !defined(DOXYGEN)
@@ -448,7 +471,9 @@ MY_DEFAULT_RX_LED_PIN in your sketch instead to enable LEDs
 #include "core/MySensorsCore.cpp"
 
 // HW mains
-#if defined(ARDUINO_ARCH_AVR)
+#if defined(WIN32)
+#include "hal/architecture/Win32/MyMainWin32Generic.cpp"
+#elif defined(ARDUINO_ARCH_AVR)
 #include "hal/architecture/AVR/MyMainAVR.cpp"
 #elif defined(ARDUINO_ARCH_SAMD)
 #include "hal/architecture/SAMD/MyMainSAMD.cpp"

core/MyCapabilities.h

@@ -153,6 +153,7 @@
  * | STM32F1      | M
  * | TEENSY       | T
  * | Linux        | L
+ * | Win32        | W
  * | Unknown      | -
  */
 #if defined(ARDUINO_ARCH_SAMD)
@@ -171,6 +172,8 @@
 #define MY_CAP_ARCH "T"
 #elif defined(__linux__)
 #define MY_CAP_ARCH "L"
+#elif defined(WIN32)
+#define MY_CAP_ARCH "W"
 #else
 #define MY_CAP_ARCH "-"
 #endif

core/MyGatewayTransport.cpp

@@ -56,9 +56,14 @@ inline void gatewayTransportProcess(void)
 				}
 			} else {
 				// Call incoming message callback if available
+#if defined(WIN32)
+				// Visual C++ has no weak function support
+				receive(_msg);
+#else
 				if (receive) {
 					receive(_msg);
 				}
+#endif
 			}
 		} else {
 #if defined(MY_SENSOR_NETWORK)

core/MyGatewayTransport.h

@@ -80,7 +80,11 @@
 #define MSG_GW_STARTUP_COMPLETE "Gateway startup complete."		//!< Gateway startup message
 
 #if defined(MY_DEBUG_VERBOSE_GATEWAY)
+#if defined(WIN32)
+#define GATEWAY_DEBUG(x,...)	DEBUG_OUTPUT(x, __VA_ARGS__)	//!< debug output
+#else
 #define GATEWAY_DEBUG(x,...)	DEBUG_OUTPUT(x, ##__VA_ARGS__)	//!< debug output
+#endif
 #else
 #define GATEWAY_DEBUG(x,...)									//!< debug NULL
 #endif