Merge branch 'main' into adrian/vt-server-better-connectionless-responses

martonmiklos · web-flow · commit 4911c7073921 · 2025-11-17T12:12:06.000+01:00
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -29,7 +29,7 @@
 	// "forwardPorts": [],
 
 	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "gcc -v"
+	"postCreateCommand": "bash -lc 'set -e; gcc -v; if ! command -v pip3 >/dev/null 2>&1; then apt-get update && apt-get install -y python3-pip; fi; pip3 install --upgrade pip; if [ -f requirements.txt ]; then pip3 install -r requirements.txt; fi'"
 
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 	// "remoteUser": "root"
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -69,6 +69,7 @@ if(BUILD_EXAMPLES)
   add_subdirectory("examples/virtual_terminal/version3_object_pool")
   add_subdirectory("examples/virtual_terminal/aux_functions")
   add_subdirectory("examples/virtual_terminal/aux_inputs")
+  add_subdirectory("examples/virtual_terminal/iop_parser_tester")
   add_subdirectory("examples/task_controller_client")
   add_subdirectory("examples/task_controller_server")
   add_subdirectory("examples/guidance")
diff --git a/examples/virtual_terminal/common/console_logger.cpp b/examples/virtual_terminal/common/console_logger.cpp
diff --git a/examples/virtual_terminal/iop_parser_tester/CMakeLists.txt b/examples/virtual_terminal/iop_parser_tester/CMakeLists.txt
@@ -0,0 +1,16 @@
+cmake_minimum_required(VERSION 3.16)
+project(iop_parser)
+
+if(NOT BUILD_EXAMPLES)
+  find_package(isobus REQUIRED)
+endif()
+find_package(Threads REQUIRED)
+
+add_executable(iop_parser main.cpp ../common/console_logger.cpp)
+
+target_compile_features(iop_parser PUBLIC cxx_std_11)
+set_target_properties(iop_parser PROPERTIES CXX_EXTENSIONS OFF)
+
+target_link_libraries(
+  iop_parser PRIVATE isobus::Isobus Threads::Threads
+                     isobus::HardwareIntegration isobus::Utility)
diff --git a/examples/virtual_terminal/iop_parser_tester/main.cpp b/examples/virtual_terminal/iop_parser_tester/main.cpp
@@ -0,0 +1,43 @@
+#include "isobus/isobus/isobus_virtual_terminal_server_managed_working_set.hpp"
+
+#include <cstdint>
+#include <fstream>
+#include <iostream>
+#include <vector>
+
+#include "../common/console_logger.cpp"
+
+int main(int argc, char *argv[])
+{
+	if (argc != 2)
+	{
+		std::cerr << "Usage: " << argv[0] << " <iop file path>\n";
+		return 1;
+	}
+
+	const char *filename = argv[1];
+	std::ifstream file(filename, std::ios::binary);
+	if (!file)
+	{
+		std::cerr << "Unable to open: " << filename << "\n";
+		return 1;
+	}
+
+	std::vector<std::uint8_t> buffer((std::istreambuf_iterator<char>(file)),
+	                                 std::istreambuf_iterator<char>());
+
+	if (buffer.empty())
+	{
+		std::cerr << "File is empty or not readable.\n";
+		return 1;
+	}
+
+	isobus::CANStackLogger::set_can_stack_logger_sink(&logger);
+
+	isobus::VirtualTerminalServerManagedWorkingSet vt;
+	bool result = vt.parse_iop_into_objects(buffer.data(),
+	                                        static_cast<std::uint32_t>(buffer.size()));
+
+	std::cout << "IOP parse result: " << std::boolalpha << result << "\n";
+	return 0;
+}
diff --git a/examples/virtual_terminal/version3_object_pool/CMakeLists.txt b/examples/virtual_terminal/version3_object_pool/CMakeLists.txt
@@ -6,7 +6,8 @@ if(NOT BUILD_EXAMPLES)
 endif()
 find_package(Threads REQUIRED)
 
-add_executable(VT3ExampleTarget main.cpp console_logger.cpp objectPoolObjects.h)
+add_executable(VT3ExampleTarget main.cpp ../common/console_logger.cpp
+                                objectPoolObjects.h)
 
 target_compile_features(VT3ExampleTarget PUBLIC cxx_std_11)
 set_target_properties(VT3ExampleTarget PROPERTIES CXX_EXTENSIONS OFF)
diff --git a/examples/virtual_terminal/version3_object_pool/main.cpp b/examples/virtual_terminal/version3_object_pool/main.cpp
@@ -7,7 +7,7 @@
 #include "isobus/isobus/isobus_virtual_terminal_client_update_helper.hpp"
 #include "isobus/utility/iop_file_interface.hpp"
 
-#include "console_logger.cpp"
+#include "../common/console_logger.cpp"
 #include "objectPoolObjects.h"
 
 #include <atomic>
@@ -102,7 +102,7 @@ int main()
 	// Automatically load the desired CAN driver based on the available drivers
 	std::shared_ptr<isobus::CANHardwarePlugin> canDriver = nullptr;
 #if defined(ISOBUS_SOCKETCAN_AVAILABLE)
-	canDriver = std::make_shared<isobus::SocketCANInterface>("can0");
+	canDriver = std::make_shared<isobus::SocketCANInterface>("vcan0");
 #elif defined(ISOBUS_WINDOWSPCANBASIC_AVAILABLE)
 	canDriver = std::make_shared<isobus::PCANBasicWindowsPlugin>(PCAN_USBBUS1);
 #elif defined(ISOBUS_WINDOWSINNOMAKERUSB2CAN_AVAILABLE)
diff --git a/hardware_integration/include/isobus/hardware_integration/can_hardware_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/can_hardware_plugin.hpp
@@ -9,6 +9,7 @@
 #ifndef CAN_HARDEWARE_PLUGIN_HPP
 #define CAN_HARDEWARE_PLUGIN_HPP
 
+#include <string>
 #include "isobus/isobus/can_message_frame.hpp"
 
 namespace isobus
@@ -23,6 +24,11 @@ namespace isobus
 	public:
 		virtual ~CANHardwarePlugin() = default;
 
+		/// @brief Returns with the name of the plugin in a format which is suitable to be displayed
+		/// to the user for e.g. on a ComboBox
+		/// @returns the name of the plugin
+		virtual std::string get_name() const = 0;
+
 		/// @brief Returns if the driver is ready and in a good state
 		/// @details This should return `false` until `open` is called, and after `close` is called, or
 		/// if anything happens that causes the driver to be invalid, like the hardware is disconnected.
diff --git a/hardware_integration/include/isobus/hardware_integration/flex_can_t4_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/flex_can_t4_plugin.hpp
@@ -27,6 +27,10 @@ namespace isobus
 		/// @brief The destructor for FlexCANT4Plugin
 		virtual ~FlexCANT4Plugin() = default;
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns FlexCANT4
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/innomaker_usb2can_windows_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/innomaker_usb2can_windows_plugin.hpp
@@ -59,6 +59,10 @@ namespace isobus
 		/// @brief The destructor for InnoMakerUSB2CANWindowsPlugin
 		virtual ~InnoMakerUSB2CANWindowsPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns INNO-Maker USB2CAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/mac_can_pcan_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/mac_can_pcan_plugin.hpp
@@ -34,6 +34,10 @@ namespace isobus
 		/// @brief The destructor for MacCANPCANPlugin
 		virtual ~MacCANPCANPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns MacCAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/mcp2515_can_interface.hpp b/hardware_integration/include/isobus/hardware_integration/mcp2515_can_interface.hpp
@@ -39,6 +39,10 @@ namespace isobus
 		/// @brief The destructor for SocketCANInterface
 		virtual ~MCP2515CANInterface();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns MCP2515
+		std::string get_name() const override;
+
 		/// @brief Returns if the socket connection is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/ntcan_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/ntcan_plugin.hpp
@@ -30,6 +30,10 @@ namespace isobus
 		/// @param[in] baudrate The baudrate to use for the CAN connection.
 		explicit NTCANPlugin(int channel, int baudrate = NTCAN_BAUD_250);
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns ESD NTCAN
+		std::string get_name() const override;
+
 		/// @brief The destructor for NTCANPlugin
 		virtual ~NTCANPlugin() = default;
 
diff --git a/hardware_integration/include/isobus/hardware_integration/pcan_basic_windows_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/pcan_basic_windows_plugin.hpp
@@ -39,6 +39,10 @@ namespace isobus
 		/// @brief The destructor for PCANBasicWindowsPlugin
 		virtual ~PCANBasicWindowsPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns PEAK CAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/socket_can_interface.hpp b/hardware_integration/include/isobus/hardware_integration/socket_can_interface.hpp
@@ -35,6 +35,10 @@ namespace isobus
 		/// @brief The destructor for SocketCANInterface
 		virtual ~SocketCANInterface();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns SocketCAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the socket connection is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/sys_tec_windows_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/sys_tec_windows_plugin.hpp
@@ -41,6 +41,10 @@ namespace isobus
 		/// @brief The destructor for PCANBasicWindowsPlugin
 		virtual ~SysTecWindowsPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns SYS TEC
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/toucan_vscp_canal.hpp b/hardware_integration/include/isobus/hardware_integration/toucan_vscp_canal.hpp
@@ -43,6 +43,10 @@ namespace isobus
 		/// @brief The destructor for TouCANPlugin
 		virtual ~TouCANPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns Rusoku TouCAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the connection with the hardware is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/twai_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/twai_plugin.hpp
@@ -37,6 +37,10 @@ namespace isobus
 		/// @brief The destructor for TWAIPlugin
 		virtual ~TWAIPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns TWAI
+		std::string get_name() const override;
+
 		/// @brief Returns if the socket connection is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/include/isobus/hardware_integration/virtual_can_plugin.hpp b/hardware_integration/include/isobus/hardware_integration/virtual_can_plugin.hpp
@@ -43,6 +43,10 @@ namespace isobus
 		/// @brief Destructor for the virtual CAN driver
 		virtual ~VirtualCANPlugin();
 
+		/// @brief Returns the displayable name of the plugin
+		/// @returns Open-Agriculture Virtual CAN
+		std::string get_name() const override;
+
 		/// @brief Returns if the socket connection is valid
 		/// @returns `true` if connected, `false` if not connected
 		bool get_is_valid() const override;
diff --git a/hardware_integration/src/can_hardware_interface.cpp b/hardware_integration/src/can_hardware_interface.cpp
@@ -280,6 +280,8 @@ namespace isobus
 		stop_threads();
 #endif
 
+		started = false;
+
 		LOCK_GUARD(Mutex, hardwareChannelsMutex);
 		std::for_each(hardwareChannels.begin(), hardwareChannels.end(), [](const std::unique_ptr<CANHardware> &channel) {
 			channel->stop();
diff --git a/hardware_integration/src/flex_can_t4_plugin.cpp b/hardware_integration/src/flex_can_t4_plugin.cpp
@@ -27,6 +27,11 @@ namespace isobus
 	{
 	}
 
+	std::string FlexCANT4Plugin::get_name() const
+	{
+		return "FlexCANT4";
+	}
+
 	bool FlexCANT4Plugin::get_is_valid() const
 	{
 		return isOpen;
diff --git a/hardware_integration/src/innomaker_usb2can_windows_plugin.cpp b/hardware_integration/src/innomaker_usb2can_windows_plugin.cpp
@@ -39,6 +39,11 @@ namespace isobus
 		close();
 	}
 
+	std::string InnoMakerUSB2CANWindowsPlugin::get_name() const
+	{
+		return "INNO-Maker USB2CAN";
+	}
+
 	bool InnoMakerUSB2CANWindowsPlugin::get_is_valid() const
 	{
 		return nullptr != driverInstance->getInnoMakerDevice(channel) && driverInstance->getInnoMakerDevice(channel)->isOpen;
diff --git a/hardware_integration/src/mac_can_pcan_plugin.cpp b/hardware_integration/src/mac_can_pcan_plugin.cpp
@@ -25,6 +25,11 @@ namespace isobus
 	{
 	}
 
+	std::string MacCANPCANPlugin::get_name() const
+	{
+		return "MacCAN";
+	}
+
 	bool MacCANPCANPlugin::get_is_valid() const
 	{
 		return (PCAN_ERROR_OK == openResult);
diff --git a/hardware_integration/src/mcp2515_can_interface.cpp b/hardware_integration/src/mcp2515_can_interface.cpp
@@ -29,6 +29,11 @@ namespace isobus
 		close();
 	}
 
+	std::string MCP2515CANInterface::get_name() const
+	{
+		return "MCP2515";
+	}
+
 	bool MCP2515CANInterface::get_is_valid() const
 	{
 		return (transactionHandler) && (initialized);
diff --git a/hardware_integration/src/ntcan_plugin.cpp b/hardware_integration/src/ntcan_plugin.cpp
@@ -24,6 +24,11 @@ namespace isobus
 	{
 	}
 
+	std::string NTCANPlugin::get_name() const
+	{
+		return "ESD NTCAN";
+	}
+
 	bool NTCANPlugin::get_is_valid() const
 	{
 		return (NTCAN_SUCCESS == openResult) && (NTCAN_NO_HANDLE != handle);
diff --git a/hardware_integration/src/pcan_basic_windows_plugin.cpp b/hardware_integration/src/pcan_basic_windows_plugin.cpp
@@ -26,6 +26,11 @@ namespace isobus
 	{
 	}
 
+	std::string PCANBasicWindowsPlugin::get_name() const
+	{
+		return "PEAK CAN";
+	}
+
 	bool PCANBasicWindowsPlugin::get_is_valid() const
 	{
 		return (PCAN_ERROR_OK == openResult);
diff --git a/hardware_integration/src/socket_can_interface.cpp b/hardware_integration/src/socket_can_interface.cpp
@@ -36,6 +36,11 @@ namespace isobus
 		}
 	}
 
+	std::string SocketCANInterface::get_name() const
+	{
+		return "SocketCAN";
+	}
+
 	SocketCANInterface::~SocketCANInterface()
 	{
 		close();
diff --git a/hardware_integration/src/sys_tec_windows_plugin.cpp b/hardware_integration/src/sys_tec_windows_plugin.cpp
@@ -37,6 +37,11 @@ namespace isobus
 		close();
 	}
 
+	std::string SysTecWindowsPlugin::get_name() const
+	{
+		return "SYS TEC";
+	}
+
 	bool SysTecWindowsPlugin::get_is_valid() const
 	{
 		return (openResult && (USBCAN_INVALID_HANDLE != handle));
diff --git a/hardware_integration/src/toucan_vscp_canal.cpp b/hardware_integration/src/toucan_vscp_canal.cpp
@@ -31,6 +31,11 @@ namespace isobus
 	{
 	}
 
+	std::string TouCANPlugin::get_name() const
+	{
+		return "Rusoku TouCAN";
+	}
+
 	bool TouCANPlugin::get_is_valid() const
 	{
 		return (CANAL_ERROR_SUCCESS == openResult);
diff --git a/hardware_integration/src/twai_plugin.cpp b/hardware_integration/src/twai_plugin.cpp
@@ -33,6 +33,11 @@ namespace isobus
 		close();
 	}
 
+	std::string TWAIPlugin::get_name() const
+	{
+		return "TWAI";
+	}
+
 	bool TWAIPlugin::get_is_valid() const
 	{
 		twai_status_info_t status;
diff --git a/hardware_integration/src/virtual_can_plugin.cpp b/hardware_integration/src/virtual_can_plugin.cpp
@@ -29,6 +29,11 @@ namespace isobus
 		ourDevice->condition.notify_one();
 	}
 
+	std::string VirtualCANPlugin::get_name() const
+	{
+		return "Open-Agriculture Virtual CAN";
+	}
+
 	bool VirtualCANPlugin::get_is_valid() const
 	{
 		return running;
diff --git a/isobus/include/isobus/isobus/isobus_data_dictionary.hpp b/isobus/include/isobus/isobus/isobus_data_dictionary.hpp
diff --git a/isobus/include/isobus/isobus/isobus_virtual_terminal_objects.hpp b/isobus/include/isobus/isobus/isobus_virtual_terminal_objects.hpp
diff --git a/isobus/include/isobus/isobus/isobus_virtual_terminal_server.hpp b/isobus/include/isobus/isobus/isobus_virtual_terminal_server.hpp
diff --git a/isobus/src/isobus_data_dictionary.cpp b/isobus/src/isobus_data_dictionary.cpp
diff --git a/isobus/src/isobus_virtual_terminal_server.cpp b/isobus/src/isobus_virtual_terminal_server.cpp
diff --git a/isobus/src/isobus_virtual_terminal_working_set_base.cpp b/isobus/src/isobus_virtual_terminal_working_set_base.cpp
diff --git a/test/hardware_interface_tests.cpp b/test/hardware_interface_tests.cpp
