initial commit

Services/ICanService.cs

@@ -0,0 +1,77 @@
+using System;
+using System.Collections.Generic;
+using HC_APTBS.Models;
+using Peak.Can.Basic;
+using TPCANHandle = System.UInt16;
+
+namespace HC_APTBS.Services
+{
+    /// <summary>
+    /// Abstracts CAN bus communication for the test bench.
+    /// The implementation (<see cref="HC_APTBS.Infrastructure.Pcan.PcanAdapter"/>) wraps
+    /// the PEAK PCAN-Basic native API.
+    /// </summary>
+    public interface ICanService
+    {
+        // ── Events ────────────────────────────────────────────────────────────────
+
+        /// <summary>
+        /// Raised on the CAN read background thread whenever the bus status changes.
+        /// <c>message</c> is the short status text; <c>isOk</c> is true when status == PCAN_ERROR_OK.
+        /// </summary>
+        event Action<string, bool>? StatusChanged;
+
+        // ── Properties ────────────────────────────────────────────────────────────
+
+        /// <summary>Most recent PCAN status code.</summary>
+        TPCANStatus CurrentStatus { get; }
+
+        /// <summary>True when the CAN read thread is running and the channel is open.</summary>
+        bool IsConnected { get; }
+
+        // ── Lifecycle ─────────────────────────────────────────────────────────────
+
+        /// <summary>
+        /// Opens the PCAN channel, performs OEM legitimation, and starts the receive thread.
+        /// </summary>
+        /// <returns>True on success; false if the hardware is unavailable or legitimation fails.</returns>
+        bool Connect();
+
+        /// <summary>Stops the receive thread and releases the PCAN channel.</summary>
+        void Disconnect();
+
+        /// <summary>
+        /// Sends a baudrate-change command to the bench firmware, then re-initialises the
+        /// PCAN channel at the new baudrate.
+        /// </summary>
+        /// <param name="newBaudrate">Target baudrate.</param>
+        /// <param name="baudrateMessageId">CAN message ID carrying the baudrate-change command.</param>
+        void SwitchBaudrate(TPCANBaudrate newBaudrate, uint baudrateMessageId);
+
+        // ── Parameter map ─────────────────────────────────────────────────────────
+
+        /// <summary>Replaces the entire parameter map with the supplied dictionary.</summary>
+        void SetParameters(Dictionary<uint, List<CanBusParameter>> parameters);
+
+        /// <summary>Adds entries to the parameter map without removing existing ones.</summary>
+        void AddParameters(Dictionary<uint, List<CanBusParameter>> parameters);
+
+        /// <summary>Removes entries whose keys match the supplied dictionary.</summary>
+        void RemoveParameters(Dictionary<uint, List<CanBusParameter>> parameters);
+
+        // ── Transmit ──────────────────────────────────────────────────────────────
+
+        /// <summary>
+        /// Packs all parameters registered for <paramref name="messageId"/> into a standard
+        /// CAN frame (applying the calibration transfer function) and transmits it.
+        /// </summary>
+        void SendMessageById(uint messageId);
+
+        /// <summary>
+        /// Transmits a raw 8-byte CAN standard frame without any parameter lookup.
+        /// </summary>
+        /// <param name="messageId">CAN message identifier.</param>
+        /// <param name="data">Exactly 8 bytes of payload data.</param>
+        void SendRawMessage(uint messageId, byte[] data);
+    }
+}