102 lines
5.4 KiB
C#
102 lines
5.4 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
|
|
namespace HC_APTBS.Services
|
|
{
|
|
/// <summary>
|
|
/// Provides KWP2000 / KW1281 diagnostics operations over the ISO K-Line
|
|
/// via an FTDI USB-to-K-Line adapter.
|
|
/// </summary>
|
|
public interface IKwpService
|
|
{
|
|
// ── Progress reporting ────────────────────────────────────────────────────
|
|
|
|
/// <summary>
|
|
/// Raised during long operations to report completion percentage and a status message.
|
|
/// Always marshalled to the UI thread by the implementation.
|
|
/// </summary>
|
|
event Action<int, string>? ProgressChanged;
|
|
|
|
// ── Full ECU read ─────────────────────────────────────────────────────────
|
|
|
|
/// <summary>
|
|
/// Connects to the pump ECU over K-Line and reads all available identification data,
|
|
/// fault codes, DFI value, serial number, and software versions.
|
|
/// </summary>
|
|
/// <param name="port">FTDI serial number or COM port identifier.</param>
|
|
/// <param name="pumpVersion">KWP protocol variant (0=V1, 1=V2, 2=V3/V4).</param>
|
|
/// <param name="ct">Cancellation token.</param>
|
|
/// <returns>
|
|
/// Dictionary with keys from <see cref="HC_APTBS.Models.KlineKeys"/>.
|
|
/// The <c>result</c> key is "1" on success, "0" on failure.
|
|
/// </returns>
|
|
Task<Dictionary<string, string>> ReadAllInfoAsync(
|
|
string port, int pumpVersion, CancellationToken ct = default);
|
|
|
|
// ── DTC operations ────────────────────────────────────────────────────────
|
|
|
|
/// <summary>Reads all current diagnostic trouble codes from the ECU.</summary>
|
|
/// <param name="port">FTDI serial number or COM port identifier.</param>
|
|
/// <param name="ct">Cancellation token.</param>
|
|
/// <returns>Formatted fault code string, or "No fault codes".</returns>
|
|
Task<string> ReadFaultCodesAsync(string port, CancellationToken ct = default);
|
|
|
|
/// <summary>Clears all diagnostic trouble codes and returns the post-clear state.</summary>
|
|
/// <param name="port">FTDI serial number or COM port identifier.</param>
|
|
/// <param name="ct">Cancellation token.</param>
|
|
/// <returns>Post-clear fault code string.</returns>
|
|
Task<string> ClearFaultCodesAsync(string port, CancellationToken ct = default);
|
|
|
|
// ── DFI calibration ───────────────────────────────────────────────────────
|
|
|
|
/// <summary>Reads the current DFI calibration angle from EEPROM address 0x0044.</summary>
|
|
/// <param name="port">FTDI serial number or COM port identifier.</param>
|
|
/// <param name="ct">Cancellation token.</param>
|
|
/// <returns>DFI value in degrees as a formatted string.</returns>
|
|
Task<string> ReadDfiAsync(string port, CancellationToken ct = default);
|
|
|
|
/// <summary>
|
|
/// Writes a new DFI calibration angle to EEPROM address 0x0044.
|
|
/// </summary>
|
|
/// <param name="port">FTDI serial number or COM port identifier.</param>
|
|
/// <param name="dfi">Target DFI angle (degrees, range ±1.45°).</param>
|
|
/// <param name="version">KWP protocol variant (selects the authentication password).</param>
|
|
/// <param name="ct">Cancellation token.</param>
|
|
/// <returns>Verified DFI value read back from EEPROM after the write.</returns>
|
|
Task<string> WriteDfiAsync(
|
|
string port, float dfi, int version, CancellationToken ct = default);
|
|
|
|
/// <summary>
|
|
/// Writes DFI to EEPROM, then triggers a pump power cycle via
|
|
/// <see cref="PumpDisconnectRequested"/> / <see cref="PumpReconnectRequested"/>
|
|
/// to activate the new calibration.
|
|
/// </summary>
|
|
Task<string> WriteDfiAndRestartAsync(
|
|
string port, float dfi, int version, CancellationToken ct = default);
|
|
|
|
// ── Device detection ──────────────────────────────────────────────────────
|
|
|
|
/// <summary>
|
|
/// Enumerates connected FTDI USB devices and returns the serial number of the
|
|
/// first one found, or <see langword="null"/> if none are connected.
|
|
/// </summary>
|
|
string? DetectKLinePort();
|
|
|
|
// ── Power cycle callbacks ─────────────────────────────────────────────────
|
|
|
|
/// <summary>
|
|
/// Raised when the service needs the bench to cut power to the pump
|
|
/// (e.g. after a DFI write) before reconnecting.
|
|
/// </summary>
|
|
event Action? PumpDisconnectRequested;
|
|
|
|
/// <summary>
|
|
/// Raised after <see cref="PumpDisconnectRequested"/> when the service needs
|
|
/// the bench to restore power and re-establish the K-Line session.
|
|
/// </summary>
|
|
event Action? PumpReconnectRequested;
|
|
}
|
|
}
|