feat(vt-client): add data/alarm mask history and prepare for object-a…

…ttribute tracking

isobus/include/isobus/isobus/can_constants.hpp

@@ -19,6 +19,7 @@ namespace isobus
 	constexpr std::uint8_t BROADCAST_CAN_ADDRESS = 0xFF; ///< The global/broadcast CAN address
 	constexpr std::uint8_t CAN_DATA_LENGTH = 8; ///< The length of a classical CAN frame
 	constexpr std::uint32_t CAN_PORT_MAXIMUM = 4; ///< An arbitrary limit for memory consumption
+	constexpr std::uint16_t NULL_OBJECT_ID = 65535; ///< Special ID used to indicate no object
 
 }
 

isobus/include/isobus/isobus/can_message.hpp

@@ -100,6 +100,11 @@ namespace isobus
 		/// @returns True if the message is destined for the control function, false otherwise
 		bool is_destination(std::shared_ptr<ControlFunction> controlFunction) const;
 
+		/// @brief Returns whether the message is originated from the control function.
+		/// @param[in] controlFunction The control function to check
+		/// @returns True if the message is originated from the control function, false otherwise
+		bool is_source(std::shared_ptr<ControlFunction> controlFunction) const;
+
 		/// @brief Returns the identifier of the message
 		/// @returns The identifier of the message
 		CANIdentifier get_identifier() const;

isobus/include/isobus/isobus/isobus_task_controller_client_objects.hpp

@@ -72,9 +72,6 @@ namespace isobus
 			/// @brief The max allowable "valid" object ID
 			static constexpr std::uint16_t MAX_OBJECT_ID = 65534;
 
-			/// @brief Special ID used to indicate no object
-			static constexpr std::uint16_t NULL_OBJECT_ID = 65535;
-
 			/// @brief Defines the max length of a designator (in bytes)
 			static constexpr std::size_t MAX_DESIGNATOR_LENGTH = 128;
 

isobus/include/isobus/isobus/isobus_virtual_terminal_client.hpp

@@ -372,8 +372,6 @@ namespace isobus
 			AuxiliaryTypeTwoFunctionType functionType; ///< The type of function
 		};
 
-		static constexpr std::uint16_t NULL_OBJECT_ID = 0xFFFF; ///< The NULL Object ID, usually drawn as blank space
-
 		/// @brief The constructor for a VirtualTerminalClient
 		/// @param[in] partner The VT server control function
 		/// @param[in] clientSource The internal control function to communicate from

isobus/include/isobus/isobus/isobus_virtual_terminal_client_state_tracker.hpp

@@ -10,9 +10,11 @@
 #ifndef ISOBUS_VIRTUAL_TERMINAL_CLIENT_STATE_TRACKER_HPP
 #define ISOBUS_VIRTUAL_TERMINAL_CLIENT_STATE_TRACKER_HPP
 
+#include "isobus/isobus/can_constants.hpp"
 #include "isobus/isobus/can_control_function.hpp"
 #include "isobus/isobus/can_message.hpp"
 
+#include <deque>
 #include <map>
 #include <vector>
 
@@ -57,6 +59,18 @@ namespace isobus
 		/// @return The data/alarm mask currently active on the server for this client.
 		std::uint16_t get_active_mask() const;
 
+		/// @brief Get the history of data/alarm masks that were active on the server for this client.
+		/// @return The history of data/alarm masks that were active on the server for this client.
+		const std::deque<std::uint16_t> &get_mask_history() const;
+
+		/// @brief Get the maximum size of the data/alarm mask history.
+		/// @return The maximum size of the data/alarm mask history.
+		std::size_t get_max_mask_history_size() const;
+
+		/// @brief Sets the maximum size of the data/alarm mask history (default: 100)
+		/// @param[in] size The maximum size of the data/alarm mask history.
+		void set_max_mask_history_size(std::size_t size);
+
 		/// @brief Adds a data/alarm mask to track the soft key mask for.
 		/// @param[in] dataOrAlarmMaskId The data/alarm mask to track the soft key mask for.
 		/// @param[in] initialSoftKeyMaskId The initial soft key mask to associate with the data/alarm mask.
@@ -81,6 +95,7 @@ namespace isobus
 
 	protected:
 		std::shared_ptr<ControlFunction> client; ///< The control function of the virtual terminal client to track.
+		std::shared_ptr<ControlFunction> server; ///< The control function of the server the client is connected to.
 
 		//! TODO: std::map<std::uint16_t, bool> shownStates; ///< Holds the 'hide/show' state of tracked objects.
 		//! TODO: std::map<std::uint16_t, bool> enabledStates; ///< Holds the 'enable/disable' state of tracked objects.
@@ -96,8 +111,10 @@ namespace isobus
 		//! TODO: add font attribute state
 		//! TODO: add line attribute state
 		//! TODO: add fill attribute state
-		std::uint16_t activeDataOrAlarmMask; ///< Holds the data/alarm mask currently visible on the server for this client.
-		std::uint8_t activeWorkingSetAddress; ///< Holds the address of the control function that currently has it's working set active on the server.
+		std::uint16_t activeDataOrAlarmMask = NULL_OBJECT_ID; ///< Holds the data/alarm mask currently visible on the server for this client.
+		std::deque<std::uint16_t> dataAndAlarmMaskHistory; ///< Holds the history of data/alarm masks that were active on the server for this client.
+		std::size_t maxDataAndAlarmMaskHistorySize = 100; ///< Holds the maximum size of the data/alarm mask history.
+		std::uint8_t activeWorkingSetAddress = NULL_CAN_ADDRESS; ///< Holds the address of the control function that currently has
 		std::map<std::uint16_t, std::uint16_t> softKeyMasks; ///< Holds the data/alarms masks with their associated soft keys masks for tracked objects.
 		//! TODO: std::map<std::uint16_t, std::pair<std::uint8_t, std::uint32_t>> attributeStates; ///< Holds the 'attribute' state of tracked objects.
 		//! TODO: std::map<std::uint16_t, std::uint8_t> alarmMaskPrioritiesStates; ///< Holds the 'alarm mask priority' state of tracked objects.
@@ -110,14 +127,26 @@ namespace isobus
 		//! TODO: std::uint16_t currentColourMap; ///< Holds the current colour map/palette object.
 
 	private:
-		/// @brief Processes a received message.
-		/// @param[in] message The received message.
+		/// @brief Cache a mask as the active mask on the server.
+		/// @param[in] maskId The mask to cache as the active mask on the server.
+		void cache_active_mask(std::uint16_t maskId);
+
+		/// @brief Processes a received or transmitted message.
+		/// @param[in] message The message to process.
 		/// @param[in] parentPointer The pointer to the parent object, which should be the VirtualTerminalClientStateTracker.
-		static void process_rx_message(const CANMessage &message, void *parentPointer);
+		static void process_rx_or_tx_message(const CANMessage &message, void *parentPointer);
+
+		/// @brief Processes a status message from a VT server.
+		/// @param[in] message The message to process.
+		void process_status_message(const CANMessage &message);
+
+		/// @brief Processes a VT->ECU message received by any client, sent from the connected server.
+		/// @param[in] message The message to process.
+		void process_message_from_connected_server(const CANMessage &message);
 
-		/// @brief Processes a received message.
-		/// @param[in] message The received message.
-		void process_rx_message(const CANMessage &message);
+		/// @brief Processes a ECU->VT message received by the connected server, sent from any control function.
+		/// @param[in] message The message to process.
+		void process_message_to_connected_server(const CANMessage &message);
 	};
 } // namespace isobus
 

isobus/include/isobus/isobus/isobus_virtual_terminal_objects.hpp

@@ -178,8 +178,6 @@ namespace isobus
 		std::array<VTColourVector, VT_COLOUR_TABLE_SIZE> colourTable; ///< Colour table data. Associates VT colour index with RGB value.
 	};
 
-	static constexpr std::uint16_t NULL_OBJECT_ID = 0xFFFF; ///< The NULL Object ID, usually drawn as blank space
-
 	/// @brief Generic VT object base class
 	class VTObject
 	{

isobus/src/can_message.cpp

@@ -69,6 +69,11 @@ namespace isobus
 		return has_valid_destination_control_function() && destination == controlFunction;
 	}
 
+	bool CANMessage::is_source(std::shared_ptr<ControlFunction> controlFunction) const
+	{
+		return has_valid_source_control_function() && source == controlFunction;
+	}
+
 	CANIdentifier CANMessage::get_identifier() const
 	{
 		return identifier;

isobus/src/isobus_device_descriptor_object_pool.cpp

@@ -8,6 +8,7 @@
 //================================================================================================
 #include "isobus/isobus/isobus_device_descriptor_object_pool.hpp"
 
+#include "isobus/isobus/can_constants.hpp"
 #include "isobus/isobus/can_stack_logger.hpp"
 #include "isobus/utility/platform_endianness.hpp"
 #include "isobus/utility/to_string.hpp"
@@ -1070,7 +1071,7 @@ namespace isobus
 				{
 					// Process parent object
 					auto currentDeviceElement = reinterpret_cast<task_controller_object::DeviceElementObject *>(currentObject.get());
-					if (task_controller_object::Object::NULL_OBJECT_ID != currentDeviceElement->get_parent_object())
+					if (NULL_OBJECT_ID != currentDeviceElement->get_parent_object())
 					{
 						auto parent = get_object_by_id(currentDeviceElement->get_parent_object());
 						if (nullptr != parent.get())
@@ -1143,7 +1144,7 @@ namespace isobus
 				{
 					auto currentProcessData = reinterpret_cast<task_controller_object::DeviceProcessDataObject *>(currentObject.get());
 
-					if (task_controller_object::Object::NULL_OBJECT_ID != currentProcessData->get_device_value_presentation_object_id())
+					if (NULL_OBJECT_ID != currentProcessData->get_device_value_presentation_object_id())
 					{
 						auto child = get_object_by_id(currentProcessData->get_device_value_presentation_object_id());
 						if (nullptr == child.get())
@@ -1171,7 +1172,7 @@ namespace isobus
 				{
 					auto currentProperty = reinterpret_cast<task_controller_object::DevicePropertyObject *>(currentObject.get());
 
-					if (task_controller_object::Object::NULL_OBJECT_ID != currentProperty->get_device_value_presentation_object_id())
+					if (NULL_OBJECT_ID != currentProperty->get_device_value_presentation_object_id())
 					{
 						auto child = get_object_by_id(currentProperty->get_device_value_presentation_object_id());
 						if (nullptr == child.get())
@@ -1214,7 +1215,7 @@ namespace isobus
 	{
 		bool retVal = true;
 
-		if ((0 != uniqueID) && (task_controller_object::Object::NULL_OBJECT_ID != uniqueID))
+		if ((0 != uniqueID) && (NULL_OBJECT_ID != uniqueID))
 		{
 			for (auto &currentObject : objectList)
 			{

isobus/src/isobus_task_controller_client_objects.cpp

@@ -8,6 +8,7 @@
 //================================================================================================
 #include "isobus/isobus/isobus_task_controller_client_objects.hpp"
 
+#include "isobus/isobus/can_constants.hpp"
 #include "isobus/utility/platform_endianness.hpp"
 
 #include <algorithm>

isobus/src/isobus_virtual_terminal_client.cpp

@@ -4464,7 +4464,7 @@ namespace isobus
 
 		if (!get_is_connected())
 		{
-			CANStackLogger::error("[VT]: Cannot send command, not connected");
+			CANStackLogger::warn("[VT]: Cannot send command, not connected");
 			return false;
 		}
 
@@ -4486,7 +4486,7 @@ namespace isobus
 			return false;
 		}
 
-		if (send_command(data))
+		if (get_is_connected() && send_command(data))
 		{
 			return true;
 		}
@@ -4528,6 +4528,10 @@ namespace isobus
 
 	void VirtualTerminalClient::process_command_queue()
 	{
+		if (!get_is_connected())
+		{
+			return;
+		}
 #if !defined CAN_STACK_DISABLE_THREADS && !defined ARDUINO
 		std::lock_guard<std::mutex> lock(commandQueueMutex);
 #endif