接口文档汇总 - 2.设备状态管理

C# WPF 设备状态管理标准化接口设计文档

1. 引言

本文档定义了一套用于WPF应用程序的设备状态管理标准化接口。该设计旨在提供统一的方式监控和管理多种设备(如相机、PLC、工控机、磁盘空间)的连接状态及健康状态。通过标准化接口,开发人员可以方便地集成不同设备,实现状态变化通知、统一查询和扩展。

2. 设备状态枚举

定义设备可能的状态,用于统一表示各监控项的状态。

csharp 复制代码
/// <summary>
/// 表示设备的运行状态。
/// </summary>
public enum DeviceStatus
{
    /// <summary>未知状态,通常表示尚未开始监控或无法确定。</summary>
    Unknown,

    /// <summary>设备正在连接中(例如正在建立连接)。</summary>
    Connecting,

    /// <summary>设备已成功连接且工作正常。</summary>
    Connected,

    /// <summary>设备处于断开状态(正常断开)。</summary>
    Disconnected,

    /// <summary>设备发生错误或异常,无法正常工作。</summary>
    Error,

    /// <summary>设备处于警告状态(例如磁盘空间不足)。</summary>
    Warning
}

3. 核心监控接口 IDeviceMonitor

csharp 复制代码
/// <summary>
/// 定义设备监控器的通用接口。
/// </summary>
public interface IDeviceMonitor : IDisposable
{
    /// <summary>
    /// 获取设备的唯一标识符(如名称或ID)。
    /// </summary>
    string DeviceId { get; }

    /// <summary>
    /// 获取设备的显示名称。
    /// </summary>
    string DeviceName { get; }

    /// <summary>
    /// 获取当前设备状态。
    /// </summary>
    DeviceStatus Status { get; }

    /// <summary>
    /// 获取上次状态更新的时间。
    /// </summary>
    DateTime LastUpdateTime { get; }

    /// <summary>
    /// 获取附加的状态消息(例如错误信息或警告详情)。
    /// </summary>
    string StatusMessage { get; }

    /// <summary>
    /// 当设备状态发生变化时触发。
    /// </summary>
    event EventHandler<DeviceStatusChangedEventArgs> StatusChanged;

    /// <summary>
    /// 启动监控(例如开始轮询或监听)。
    /// </summary>
    void Start();

    /// <summary>
    /// 停止监控。
    /// </summary>
    void Stop();

    /// <summary>
    /// 手动刷新状态(立即执行一次状态检查)。
    /// </summary>
    void Refresh();
}

4. 状态变化事件参数

用于传递状态变化信息。

csharp 复制代码
/// <summary>
/// 提供设备状态变化的事件数据。
/// </summary>
public class DeviceStatusChangedEventArgs : EventArgs
{
    /// <summary>
    /// 初始化事件参数。
    /// </summary>
    public DeviceStatusChangedEventArgs(string deviceId, DeviceStatus oldStatus, DeviceStatus newStatus, string message)
    {
        DeviceId = deviceId;
        OldStatus = oldStatus;
        NewStatus = newStatus;
        Message = message;
    }

    /// <summary>设备标识符。</summary>
    public string DeviceId { get; }

    /// <summary>变化前的状态。</summary>
    public DeviceStatus OldStatus { get; }

    /// <summary>变化后的状态。</summary>
    public DeviceStatus NewStatus { get; }

    /// <summary>附加消息。</summary>
    public string Message { get; }
}

5. 具体设备监控接口

根据设备类型扩展专用接口,可添加特定属性和方法。

5.1 相机监控接口 ICameraMonitor

csharp 复制代码
/// <summary>
/// 相机设备监控接口。
/// </summary>
public interface ICameraMonitor : IDeviceMonitor
{
    /// <summary>
    /// 获取相机分辨率(宽度)。
    /// </summary>
    int Width { get; }

    /// <summary>
    /// 获取相机分辨率(高度)。
    /// </summary>
    int Height { get; }

    /// <summary>
    /// 获取当前帧率(如果支持)。
    /// </summary>
    double FrameRate { get; }

    /// <summary>
    /// 尝试触发一次拍照并返回图像数据(演示功能,实际可扩展)。
    /// </summary>
    Task<byte[]> CaptureImageAsync();
}

5.2 PLC监控接口 IPlcMonitor

csharp 复制代码
/// <summary>
/// PLC设备监控接口。
/// </summary>
public interface IPlcMonitor : IDeviceMonitor
{
    /// <summary>
    /// 获取PLC型号。
    /// </summary>
    string Model { get; }

    /// <summary>
    /// 获取当前CPU负载(如果支持)。
    /// </summary>
    double CpuLoad { get; }

    /// <summary>
    /// 读取指定地址的值(泛型示例)。
    /// </summary>
    Task<T> ReadAsync<T>(string address);

    /// <summary>
    /// 写入指定地址的值。
    /// </summary>
    Task WriteAsync<T>(string address, T value);
}

5.3 工控机监控接口 IIpcMonitor

csharp 复制代码
/// <summary>
/// 工控机(IPC)监控接口,通常监控系统资源。
/// </summary>
public interface IIpcMonitor : IDeviceMonitor
{
    /// <summary>
    /// 获取CPU使用率(百分比)。
    /// </summary>
    double CpuUsage { get; }

    /// <summary>
    /// 获取内存使用率(百分比)。
    /// </summary>
    double MemoryUsage { get; }

    /// <summary>
    /// 获取总内存大小(字节)。
    /// </summary>
    long TotalMemory { get; }

    /// <summary>
    /// 获取可用内存大小(字节)。
    /// </summary>
    long AvailableMemory { get; }

    /// <summary>
    /// 获取系统运行时间。
    /// </summary>
    TimeSpan UpTime { get; }
}

5.4 磁盘空间监控接口 IDiskMonitor

csharp 复制代码
/// <summary>
/// 磁盘空间监控接口。
/// </summary>
public interface IDiskMonitor : IDeviceMonitor
{
    /// <summary>
    /// 获取驱动器名称(如 "C:")。
    /// </summary>
    string DriveName { get; }

    /// <summary>
    /// 获取总容量(字节)。
    /// </summary>
    long TotalSize { get; }

    /// <summary>
    /// 获取可用空间(字节)。
    /// </summary>
    long AvailableFreeSpace { get; }

    /// <summary>
    /// 获取已用空间百分比。
    /// </summary>
    double UsedPercentage { get; }

    /// <summary>
    /// 获取或设置磁盘空间警告阈值(百分比)。
    /// </summary>
    double WarningThreshold { get; set; }
}

6. 设备状态管理器接口 IDeviceStatusManager

负责管理所有设备监控器,提供统一的状态聚合和事件转发。

csharp 复制代码
/// <summary>
/// 设备状态管理器,用于集中管理多个设备监控器。
/// </summary>
public interface IDeviceStatusManager : IDisposable
{
    /// <summary>
    /// 获取所有已注册的设备监控器。
    /// </summary>
    IReadOnlyList<IDeviceMonitor> Devices { get; }

    /// <summary>
    /// 根据设备ID获取监控器。
    /// </summary>
    IDeviceMonitor GetDevice(string deviceId);

    /// <summary>
    /// 根据类型获取特定类型的监控器集合。
    /// </summary>
    IEnumerable<T> GetDevices<T>() where T : IDeviceMonitor;

    /// <summary>
    /// 注册一个设备监控器。
    /// </summary>
    void RegisterMonitor(IDeviceMonitor monitor);

    /// <summary>
    /// 注销设备监控器。
    /// </summary>
    void UnregisterMonitor(string deviceId);

    /// <summary>
    /// 启动所有已注册的监控器。
    /// </summary>
    void StartAll();

    /// <summary>
    /// 停止所有已注册的监控器。
    /// </summary>
    void StopAll();

    /// <summary>
    /// 刷新所有监控器状态。
    /// </summary>
    void RefreshAll();

    /// <summary>
    /// 当任意设备状态发生变化时触发(聚合事件)。
    /// </summary>
    event EventHandler<DeviceStatusChangedEventArgs> DeviceStatusChanged;
}

7. 默认实现示例(非接口部分,仅演示用法)

以下展示如何在WPF应用程序中使用上述接口。假设已有实现类(如 CameraMonitorPlcMonitor 等)实现了对应接口。

7.1 在App.xaml.cs中初始化管理器

csharp 复制代码
public partial class App : Application
{
    public static IDeviceStatusManager DeviceManager { get; private set; }

    protected override void OnStartup(StartupEventArgs e)
    {
        base.OnStartup(e);
        DeviceManager = new DeviceStatusManager(); // 假设有一个默认实现

        // 创建并注册具体监控器
        var cameraMonitor = new CameraMonitor("Camera1", "Basler acA1300");
        var plcMonitor = new PlcMonitor("PLC1", "Siemens S7-1200", "192.168.1.100");
        var ipcMonitor = new IpcMonitor("IPC1", "Main IPC");
        var diskMonitor = new DiskMonitor("DiskC", "C:\\");

        DeviceManager.RegisterMonitor(cameraMonitor);
        DeviceManager.RegisterMonitor(plcMonitor);
        DeviceManager.RegisterMonitor(ipcMonitor);
        DeviceManager.RegisterMonitor(diskMonitor);

        // 启动所有监控
        DeviceManager.StartAll();

        // 订阅全局状态变化事件(可用于UI更新)
        DeviceManager.DeviceStatusChanged += (s, args) =>
        {
            // 可在UI线程上更新状态显示
            Debug.WriteLine($"设备 {args.DeviceId} 状态从 {args.OldStatus} 变为 {args.NewStatus}: {args.Message}");
        };
    }

    protected override void OnExit(ExitEventArgs e)
    {
        DeviceManager?.Dispose();
        base.OnExit(e);
    }
}

7.2 在ViewModel中绑定设备状态

csharp 复制代码
public class MainViewModel : INotifyPropertyChanged
{
    private readonly IDeviceStatusManager _deviceManager;

    public MainViewModel()
    {
        _deviceManager = App.DeviceManager;
        // 可订阅单个设备变化或通过全局事件更新
        _deviceManager.DeviceStatusChanged += OnDeviceStatusChanged;
        LoadDevices();
    }

    private void OnDeviceStatusChanged(object sender, DeviceStatusChangedEventArgs e)
    {
        // 更新UI绑定属性
        var device = Devices.FirstOrDefault(d => d.DeviceId == e.DeviceId);
        if (device != null)
        {
            // 假设Devices集合中的项包装了IDeviceMonitor并实现了INotifyPropertyChanged
            // 这里触发属性变化通知
        }
    }

    public ObservableCollection<DeviceViewModel> Devices { get; } = new();

    private void LoadDevices()
    {
        foreach (var device in _deviceManager.Devices)
        {
            Devices.Add(new DeviceViewModel(device));
        }
    }

    // 其他代码...
}

public class DeviceViewModel : INotifyPropertyChanged
{
    private readonly IDeviceMonitor _monitor;

    public DeviceViewModel(IDeviceMonitor monitor)
    {
        _monitor = monitor;
        _monitor.StatusChanged += (s, e) =>
        {
            OnPropertyChanged(nameof(Status));
            OnPropertyChanged(nameof(StatusMessage));
        };
    }

    public string DeviceName => _monitor.DeviceName;
    public DeviceStatus Status => _monitor.Status;
    public string StatusMessage => _monitor.StatusMessage;
    public DateTime LastUpdate => _monitor.LastUpdateTime;

    // 实现INotifyPropertyChanged...
}

7.3 XAML绑定示例

xml 复制代码
<ListBox ItemsSource="{Binding Devices}">
    <ListBox.ItemTemplate>
        <DataTemplate>
            <StackPanel Orientation="Horizontal" Margin="5">
                <TextBlock Text="{Binding DeviceName}" Width="120"/>
                <TextBlock Text="{Binding Status}" Width="80" Foreground="{Binding Status, Converter={StaticResource StatusToColorConverter}}"/>
                <TextBlock Text="{Binding StatusMessage}" Margin="5,0"/>
            </StackPanel>
        </DataTemplate>
    </ListBox.ItemTemplate>
</ListBox>

8. 总结

本文档定义了一套标准化的设备状态管理接口,涵盖了相机、PLC、工控机和磁盘空间的监控需求。该设计通过通用接口 IDeviceMonitor 和具体类型接口,实现了设备无关的状态查询和事件通知,并通过 IDeviceStatusManager 统一管理多个设备。在WPF应用程序中,可以轻松地将这些接口与MVVM模式结合,实现响应式的设备状态UI。

相关推荐
用户36674625267416 小时前
接口文档汇总 - 3.PLC通信管理
c#
Ray Liang1 天前
用六边形架构与整洁架构对比是伪命题?
java·python·c#·架构设计
Scout-leaf4 天前
WPF新手村教程(三)—— 路由事件
c#·wpf
用户298698530145 天前
程序员效率工具:Spire.Doc如何助你一键搞定Word表格排版
后端·c#·.net
mudtools6 天前
搭建一套.net下能落地的飞书考勤系统
后端·c#·.net
玩泥巴的6 天前
搭建一套.net下能落地的飞书考勤系统
c#·.net·二次开发·飞书
唐宋元明清21886 天前
.NET 本地Db数据库-技术方案选型
windows·c#
lindexi6 天前
dotnet DirectX 通过可等待交换链降低输入渲染延迟
c#·directx·d2d·direct2d·vortice
qq_454245036 天前
基于组件与行为的树状节点系统
数据结构·c#