Add bridge transport feature

Author: virtual-maker

core/MyEepromAddresses.h

@@ -1,4 +1,4 @@
-/*
+/**
  * 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
@@ -35,7 +35,7 @@
 #define SIZE_NODE_ID						(1u)		//!< Size node ID
 #define SIZE_PARENT_NODE_ID					(1u)		//!< Size parent node ID
 #define SIZE_DISTANCE						(1u)		//!< Size GW distance
-#define SIZE_ROUTES							(256u)	//!< Size routing table
+#define SIZE_ROUTES							(256u)	//!< Size routing table and bridged addresses
 #define SIZE_CONTROLLER_CONFIG				(23u)	//!< Size controller config
 #define SIZE_PERSONALIZATION_CHECKSUM	(1u)  //!< Size personalization checksum
 #define SIZE_FIRMWARE_TYPE					(2u)		//!< Size firmware type
@@ -84,8 +84,10 @@
 #define EEPROM_RF_ENCRYPTION_AES_KEY_ADDRESS (EEPROM_SIGNING_SOFT_SERIAL_ADDRESS + SIZE_SIGNING_SOFT_SERIAL)
 /** @brief Address node lock counter. This is set with @ref SecurityPersonalizer.ino */
 #define EEPROM_NODE_LOCK_COUNTER_ADDRESS (EEPROM_RF_ENCRYPTION_AES_KEY_ADDRESS + SIZE_RF_ENCRYPTION_AES_KEY)
+/** @brief Address routing table from and to bridge media */
+#define EEPROM_BRIDGED_ADDRESS (EEPROM_NODE_LOCK_COUNTER_ADDRESS + SIZE_NODE_LOCK_COUNTER)
 /** @brief First free address for sketch static configuration */
-#define EEPROM_LOCAL_CONFIG_ADDRESS (EEPROM_NODE_LOCK_COUNTER_ADDRESS + SIZE_NODE_LOCK_COUNTER)
+#define EEPROM_LOCAL_CONFIG_ADDRESS (EEPROM_BRIDGED_ADDRESS + SIZE_ROUTES)
 
 #endif // MyEepromAddresses_h
 

core/MyTransport.cpp

@@ -98,7 +98,11 @@ void stInitTransition(void)
 void stInitUpdate(void)
 {
 	// initialise radio
-	if (!transportHALInit()) {
+#if defined(MY_BRIDGE_FEATURE)
+	if (!transportInit() || !bridgeTransportHALInit()) {
+#else
+	if (!transportInit()) {
+#endif
 		TRANSPORT_DEBUG(PSTR("!TSM:INIT:TSP FAIL\n"));
 		setIndication(INDICATION_ERR_INIT_TRANSPORT);
 		transportSwitchSM(stFailure);
@@ -438,6 +442,9 @@ void transportReInitialise(void)
 		TRANSPORT_DEBUG(PSTR("TSF:TRI:TPU\n"));		// transport power up
 		transportHALPowerUp();
 		transportHALSetAddress(_transportConfig.nodeId);
+#if defined(MY_BRIDGE_FEATURE)
+		bridgeTransportHALSetAddress(_transportConfig.nodeId);
+#endif
 	} else {
 		TRANSPORT_DEBUG(PSTR("TSF:TRI:TSB\n"));		// transport standby
 		transportHALStandBy();
@@ -499,6 +506,9 @@ bool transportAssignNodeID(const uint8_t newNodeId)
 	if (newNodeId != GATEWAY_ADDRESS && newNodeId != AUTO) {
 		_transportConfig.nodeId = newNodeId;
 		transportHALSetAddress(newNodeId);
+#if defined(MY_BRIDGE_FEATURE)
+		bridgeTransportHALSetAddress(newNodeId);
+#endif
 		// Write ID to EEPROM
 		hwWriteConfig(EEPROM_NODE_ID_ADDRESS, newNodeId);
 		TRANSPORT_DEBUG(PSTR("TSF:SID:OK,ID=%" PRIu8 "\n"),newNodeId);	// Node ID assigned
@@ -513,6 +523,7 @@ bool transportAssignNodeID(const uint8_t newNodeId)
 bool transportRouteMessage(MyMessage &message)
 {
 	const uint8_t destination = message.getDestination();
+	bool routeToBridge = false;
 
 	if (_transportSM.findingParentNode && destination != BROADCAST_ADDRESS) {
 		TRANSPORT_DEBUG(PSTR("!TSF:RTE:FPAR ACTIVE\n")); // find parent active, message not sent
@@ -529,7 +540,7 @@ bool transportRouteMessage(MyMessage &message)
 	} else {
 #if defined(MY_REPEATER_FEATURE)
 		// destination not GW & not BC, get route
-		route = transportGetRoute(destination);
+		route = transportGetRoute(destination, &routeToBridge);
 		if (route == AUTO) {
 			TRANSPORT_DEBUG(PSTR("!TSF:RTE:%" PRIu8 " UNKNOWN\n"), destination);	// route unknown
 #if !defined(MY_GATEWAY_FEATURE)
@@ -562,7 +573,7 @@ bool transportRouteMessage(MyMessage &message)
 #endif
 	}
 	// send message
-	const bool result = transportSendWrite(route, message);
+	const bool result = transportSendWrite(route, message, routeToBridge);
 #if !defined(MY_GATEWAY_FEATURE)
 	// update counter
 	if (route == _transportConfig.parentNodeId) {
@@ -647,16 +658,23 @@ uint32_t transportGetHeartbeat(void)
 	return transportTimeInState();
 }
 
-void transportProcessMessage(void)
+void transportProcessMessage(bool fromBridge)
 {
 	// Manage signing timeout
 	(void)signerCheckTimer();
 	// receive message
 	setIndication(INDICATION_RX);
 	uint8_t payloadLength;
-	// last is the first byte of the payload buffer
-	if (!transportHALReceive(&_msg, &payloadLength)) {
-		return;
+	if (fromBridge) {
+#if defined(MY_BRIDGE_FEATURE)
+		if (!bridgeTransportHALReceive(&_msg, &payloadLength)) {
+			return;
+		}
+#endif
+	} else {
+		if (!transportHALReceive(&_msg, &payloadLength)) {
+			return;
+		}
 	}
 	// get message length and limit size
 	const uint8_t msgLength = _msg.getLength();
@@ -692,7 +710,7 @@ void transportProcessMessage(void)
 		// Message is from one of the child nodes and not sent from this node. Add it to routing table.
 		if (sender != _transportConfig.nodeId)
 		{
-			transportSetRoute(sender, last);
+			transportSetRoute(sender, last, fromBridge);
 		}
 	}
 #endif // MY_REPEATER_FEATURE
@@ -950,7 +968,11 @@ void transportInvokeSanityCheck(void)
 {
 	// Suppress this because the function may return a variable value in some configurations
 	// cppcheck-suppress knownConditionTrueFalse
+#if defined(MY_BRIDGE_FEATURE)
+	if (!transportHALSanityCheck() || !bridgeTransportHALSanityCheck()) {
+#else
 	if (!transportHALSanityCheck()) {
+#endif
 		TRANSPORT_DEBUG(PSTR("!TSF:SAN:FAIL\n"));	// sanity check fail
 		transportSwitchSM(stFailure);
 	} else {
@@ -975,8 +997,15 @@ void transportProcessFIFO(void)
 	uint8_t _processedMessages = MAX_SUBSEQ_MSGS;
 	// process all msgs in FIFO or counter exit
 	while (transportHALDataAvailable() && _processedMessages--) {
-		transportProcessMessage();
+		transportProcessMessage(false);
+	}
+#if defined(MY_BRIDGE_FEATURE)
+	_processedMessages = MAX_SUBSEQ_MSGS;
+	// process all msgs in FIFO or counter exit
+	while (bridgeTransportHALDataAvailable() && _processedMessages--) {
+		transportProcessMessage(true);
 	}
+#endif
 #if defined(MY_OTA_FIRMWARE_FEATURE)
 	if (isTransportReady()) {
 		// only process if transport ok
@@ -985,7 +1014,7 @@ void transportProcessFIFO(void)
 #endif
 }
 
-bool transportSendWrite(const uint8_t to, MyMessage &message)
+bool transportSendWrite(const uint8_t to, MyMessage &message, const bool routeToBridge)
 {
 	message.setLast(_transportConfig.nodeId); // Update last
 
@@ -1002,8 +1031,16 @@ bool transportSendWrite(const uint8_t to, MyMessage &message)
 	const bool noACK = _transportConfig.passiveMode || (to == BROADCAST_ADDRESS);
 	// send
 	setIndication(INDICATION_TX);
-	const bool result = transportHALSend(to, &message, totalMsgLength,
-	                                     noACK);
+	bool result = false;
+	// if to is BC (AUTO) then send to both transport and bridge transport media
+#if defined(MY_BRIDGE_FEATURE)
+	if (routeToBridge || to == AUTO) {
+		result = bridgeTransportHALSend(to, &message, totalMsgLength, noACK);
+	}
+#endif
+	if (!routeToBridge || to == AUTO) {
+		result = transportHALSend(to, &message, totalMsgLength, noACK);
+	}
 
 	TRANSPORT_DEBUG(PSTR("%sTSF:MSG:SEND,%" PRIu8 "-%" PRIu8 "-%" PRIu8 "-%" PRIu8 ",s=%" PRIu8 ",c=%"
 	                     PRIu8 ",t=%" PRIu8 ",pt=%" PRIu8 ",l=%" PRIu8 ",sg=%" PRIu8 ",ft=%" PRIu8 ",st=%s:%s\n"),
@@ -1043,7 +1080,7 @@ uint8_t transportGetDistanceGW(void)
 void transportClearRoutingTable(void)
 {
 	for (uint16_t i = 0; i < SIZE_ROUTES; i++) {
-		transportSetRoute((uint8_t)i, BROADCAST_ADDRESS);
+		transportSetRoute((uint8_t)i, BROADCAST_ADDRESS, false);
 	}
 	transportSaveRoutingTable();	// save cleared routing table to EEPROM (if feature enabled)
 	TRANSPORT_DEBUG(PSTR("TSF:CRT:OK\n"));	// clear routing table
@@ -1053,6 +1090,8 @@ void transportLoadRoutingTable(void)
 {
 #if defined(MY_RAM_ROUTING_TABLE_ENABLED)
 	hwReadConfigBlock((void*)&_transportRoutingTable.route, (void*)EEPROM_ROUTES_ADDRESS, SIZE_ROUTES);
+	hwReadConfigBlock((void*)&_transportRoutingTable.bridged, (void*)EEPROM_BRIDGED_ADDRESS,
+	                  SIZE_ROUTES);
 	TRANSPORT_DEBUG(PSTR("TSF:LRT:OK\n"));	//  load routing table
 #endif
 }
@@ -1061,24 +1100,32 @@ void transportSaveRoutingTable(void)
 {
 #if defined(MY_RAM_ROUTING_TABLE_ENABLED)
 	hwWriteConfigBlock((void*)&_transportRoutingTable.route, (void*)EEPROM_ROUTES_ADDRESS, SIZE_ROUTES);
+	hwWriteConfigBlock((void*)&_transportRoutingTable.bridged, (void*)EEPROM_BRIDGED_ADDRESS,
+	                   SIZE_ROUTES);
 	TRANSPORT_DEBUG(PSTR("TSF:SRT:OK\n"));	//  save routing table
 #endif
 }
 
-void transportSetRoute(const uint8_t node, const uint8_t route)
+void transportSetRoute(const uint8_t node, const uint8_t route, const bool fromBridge)
 {
 #if defined(MY_RAM_ROUTING_TABLE_ENABLED)
 	_transportRoutingTable.route[node] = route;
+	_transportRoutingTable.bridged[node] = fromBridge;
 #else
 	hwWriteConfig(EEPROM_ROUTES_ADDRESS + node, route);
 #endif
 }
 
-uint8_t transportGetRoute(const uint8_t node)
+uint8_t transportGetRoute(const uint8_t node, bool* toBridge)
 {
 	uint8_t result;
 #if defined(MY_RAM_ROUTING_TABLE_ENABLED)
 	result = _transportRoutingTable.route[node];
+#if defined(MY_BRIDGE_FEATURE)
+	*toBridge = _transportRoutingTable.bridged[node];
+#else
+	*toBridge = false;
+#endif
 #else
 	result = hwReadConfig(EEPROM_ROUTES_ADDRESS + node);
 #endif
@@ -1089,7 +1136,8 @@ void transportReportRoutingTable(void)
 {
 #if defined(MY_REPEATER_FEATURE)
 	for (uint16_t cnt = 0; cnt < SIZE_ROUTES; cnt++) {
-		const uint8_t route = transportGetRoute(cnt);
+		bool toBridge;
+		const uint8_t route = transportGetRoute((uint8_t)cnt, &toBridge);
 		if (route != BROADCAST_ADDRESS) {
 			TRANSPORT_DEBUG(PSTR("TSF:RRT:ROUTE N=%" PRIu8 ",R=%" PRIu8 "\n"), cnt, route);
 			uint8_t outBuf[2] = { (uint8_t)cnt,route };

core/MyTransport.h

@@ -317,6 +317,7 @@ typedef struct {
 */
 typedef struct {
 	uint8_t route[SIZE_ROUTES];	//!< route for node
+	bool bridged[SIZE_ROUTES];  //!< route via bridge
 } routingTable_t;
 
 // PRIVATE functions
@@ -394,7 +395,7 @@ void transportProcessFIFO(void);
 /**
 * @brief Receive message from RX FIFO and process
 */
-void transportProcessMessage(void);
+void transportProcessMessage(bool fromBridge = false);
 /**
 * @brief Assign node ID
 * @param newNodeId New node ID
@@ -436,7 +437,7 @@ bool transportSendRoute(MyMessage &message);
 * @param message
 * @return true if message sent successfully
 */
-bool transportSendWrite(const uint8_t to, MyMessage &message);
+bool transportSendWrite(const uint8_t to, MyMessage &message, const bool routeToBridge);
 /**
 * @brief Check uplink to GW, includes flooding control
 * @param force to override flood control timer
@@ -508,13 +509,13 @@ void transportSaveRoutingTable(void);
 * @param node
 * @param route
 */
-void transportSetRoute(const uint8_t node, const uint8_t route);
+void transportSetRoute(const uint8_t node, const uint8_t route, const bool fromBridge);
 /**
 * @brief Load route to node
 * @param node
 * @return route to node
 */
-uint8_t transportGetRoute(const uint8_t node);
+uint8_t transportGetRoute(const uint8_t node, bool* toBridge);
 /**
 * @brief Reports content of routing table
 */