借助网络配置,控制Modbus工具的日志显示,避免卡死界面
智能大石头 authored at 2021-12-11 22:09:19
6.91 KiB
XCoder
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using NewLife;
using NewLife.XCoder.Services;

namespace NewLife.XCoder.Tools.Can;

/// <summary>CAN 帧</summary>
/// <param name="Id">帧标识,标准 11 位或扩展 29 位</param>
/// <param name="Data">数据字节,最多 8 字节(经典 CAN)</param>
/// <param name="Extended">是否扩展帧</param>
/// <param name="Remote">是否远程帧</param>
public sealed record CanFrame(UInt32 Id, Byte[] Data, Boolean Extended = false, Boolean Remote = false)
{
    /// <summary>数据长度</summary>
    public Int32 Length => Data?.Length ?? 0;

    /// <summary>格式化为 "ID [数据]" 文本</summary>
    /// <returns>文本表示</returns>
    public override String ToString()
    {
        var id = Extended ? Id.ToString("X8") : Id.ToString("X3");
        var data = Data == null || Data.Length == 0 ? "" : Convert.ToHexString(Data);

        return Remote ? $"{id} RTR" : $"{id} [{data}]";
    }
}

/// <summary>CAN 通道抽象</summary>
/// <remarks>
/// 各平台提供自己的实现:Windows 走厂商 DLL(ZLG/PCAN/ControlCAN),
/// Linux 走 SocketCAN,macOS 走厂商驱动;无硬件时可用虚拟回环通道联调界面与协议。
/// </remarks>
public interface ICanChannel : IDisposable
{
    /// <summary>通道名称</summary>
    String Name { get; }

    /// <summary>是否已打开</summary>
    Boolean IsOpen { get; }

    /// <summary>收到帧事件,在后台线程触发</summary>
    event EventHandler<CanFrame>? Received;

    /// <summary>打开通道</summary>
    /// <param name="bitrate">波特率</param>
    void Open(Int32 bitrate);

    /// <summary>关闭通道</summary>
    void Close();

    /// <summary>发送一帧</summary>
    /// <param name="frame">CAN 帧</param>
    void Send(CanFrame frame);
}

/// <summary>虚拟回环通道:发出去的帧立即回送给接收端,用于无硬件时验证界面与协议</summary>
public class VirtualCanChannel : ICanChannel
{
    /// <summary>通道名称</summary>
    public String Name => LocalizationService.T("Virtual loopback");

    /// <summary>是否已打开</summary>
    public Boolean IsOpen { get; private set; }

    /// <summary>收到帧事件</summary>
    public event EventHandler<CanFrame>? Received;

    /// <summary>已发送帧数</summary>
    public Int32 SentCount { get; private set; }

    /// <summary>打开通道</summary>
    /// <param name="bitrate">波特率(虚拟通道仅记录)</param>
    public void Open(Int32 bitrate)
    {
        Bitrate = bitrate;
        IsOpen = true;
    }

    /// <summary>当前波特率</summary>
    public Int32 Bitrate { get; private set; }

    /// <summary>关闭通道</summary>
    public void Close() => IsOpen = false;

    /// <summary>发送一帧,并回送给接收端</summary>
    /// <param name="frame">CAN 帧</param>
    public void Send(CanFrame frame)
    {
        if (frame == null) throw new ArgumentNullException(nameof(frame));
        if (!IsOpen) throw new InvalidOperationException(LocalizationService.T("Channel is not open"));

        SentCount++;
        Received?.Invoke(this, frame);
    }

    /// <summary>释放</summary>
    public void Dispose() => Close();
}

/// <summary>CAN 通道描述</summary>
/// <param name="Name">通道名,如 can0 / 虚拟回环</param>
/// <param name="Kind">通道类型:virtual / socketcan / vendor</param>
public sealed record CanChannelInfo(String Name, String Kind);

/// <summary>CAN 通道工厂:按平台枚举可用通道</summary>
public static class CanChannelFactory
{
    /// <summary>是否 Windows</summary>
    public static Boolean IsWindows => RuntimeInformation.IsOSPlatform(OSPlatform.Windows);

    /// <summary>是否 Linux</summary>
    public static Boolean IsLinux => RuntimeInformation.IsOSPlatform(OSPlatform.Linux);

    /// <summary>是否 macOS</summary>
    public static Boolean IsMacOS => RuntimeInformation.IsOSPlatform(OSPlatform.OSX);

    /// <summary>枚举当前平台可用通道;虚拟回环始终可用</summary>
    /// <returns>通道清单,第一项固定为虚拟回环</returns>
    public static IReadOnlyList<CanChannelInfo> Discover()
    {
        var list = new List<CanChannelInfo> { new(LocalizationService.T("Virtual loopback"), "virtual") };

        if (IsLinux) list.AddRange(DiscoverSocketCan());

        return list;
    }

    /// <summary>按名称创建通道</summary>
    /// <param name="info">通道描述</param>
    /// <returns>通道实例</returns>
    public static ICanChannel Create(CanChannelInfo info)
    {
        if (info == null) throw new ArgumentNullException(nameof(info));

        return info.Kind switch
        {
            "virtual" => new VirtualCanChannel(),
            "socketcan" => new SocketCanChannel(info.Name),
            _ => throw new NotSupportedException(LocalizationService.Format("This build does not support channel {0} ({1})", info.Name, info.Kind)),
        };
    }

    /// <summary>探测 Linux SocketCAN 网卡</summary>
    /// <returns>可用的 can 网卡清单</returns>
    public static IReadOnlyList<CanChannelInfo> DiscoverSocketCan()
    {
        var list = new List<CanChannelInfo>();

        try
        {
            var root = "/sys/class/net";
            if (!System.IO.Directory.Exists(root)) return list;

            foreach (var dir in System.IO.Directory.GetDirectories(root))
            {
                var name = System.IO.Path.GetFileName(dir);
                if (!name.StartsWith("can", StringComparison.OrdinalIgnoreCase) && !name.StartsWith("vcan", StringComparison.OrdinalIgnoreCase)) continue;

                list.Add(new CanChannelInfo(name, "socketcan"));
            }
        }
        catch
        {
            // 探测失败只影响可选通道,不影响虚拟回环
        }

        return list;
    }

    /// <summary>解析十六进制数据文本,支持空格/逗号/短横线分隔</summary>
    /// <param name="text">如 "01 02 AB"</param>
    /// <returns>字节数组</returns>
    public static Byte[] ParseData(String? text)
    {
        if (text.IsNullOrEmpty()) return [];

        var hex = text!.Replace(" ", "").Replace(",", "").Replace("-", "").Replace("0x", "", StringComparison.OrdinalIgnoreCase);
        if (hex.Length % 2 != 0) throw new ArgumentException(LocalizationService.T("Data must contain an even number of hexadecimal characters"), nameof(text));

        return Convert.FromHexString(hex);
    }

    /// <summary>解析帧标识文本,支持 0x 前缀</summary>
    /// <param name="text">如 "0x123"</param>
    /// <returns>帧标识</returns>
    public static UInt32 ParseId(String? text)
    {
        if (text.IsNullOrEmpty()) throw new ArgumentException(LocalizationService.T("Frame ID cannot be empty"), nameof(text));

        var value = text!.Trim();
        if (value.StartsWith("0x", StringComparison.OrdinalIgnoreCase)) value = value[2..];

        return Convert.ToUInt32(value, 16);
    }
}