借助网络配置,控制Modbus工具的日志显示,避免卡死界面
智能大石头 authored at 2021-12-11 22:09:19
7.79 KiB
XCoder
using System.ComponentModel;
using System.IO.Ports;
using NewLife;
using NewLife.Log;
using NewLife.Serial.Protocols;
using NewLife.XCoder.ViewModels;
using Xunit;

namespace XCoder.App.Tests;

/// <summary>Modbus RTU 主从回环测试(需要一对互连的虚拟串口)</summary>
/// <remarks>
/// 本机没有串口时测试自动跳过。制造虚拟串口对:
/// WSL/Linux:socat -d -d pty,raw,echo=0,link=/tmp/ttyV0 pty,raw,echo=0,link=/tmp/ttyV1 &amp;
/// 然后设置环境变量:XCODER_RTU_MASTER=/tmp/ttyV0、XCODER_RTU_SLAVE=/tmp/ttyV1 再跑测试。
/// </remarks>
public class ModbusRtuLoopTests
{
    private const Byte Unit = 1;

    /// <summary>主站侧端口(未配置表示跳过)</summary>
    private static String? MasterPort => Environment.GetEnvironmentVariable("XCODER_RTU_MASTER");

    /// <summary>从站侧端口(未配置表示跳过)</summary>
    private static String? SlavePort => Environment.GetEnvironmentVariable("XCODER_RTU_SLAVE");

    [Fact]
    [DisplayName("RTU 主站读取从站保持寄存器(FC03)")]
    public void ReadHoldingRegisters_RoundTrip()
    {
        var master = MasterPort;
        var slave = SlavePort;
        if (master.IsNullOrEmpty() || slave.IsNullOrEmpty()) return;
        if (!File.Exists(master) || !File.Exists(slave)) return;

        var registers = new UInt16[] { 0x1234, 0x5678, 0x9ABC, 0x0001 };

        using var sim = new RtuSlaveSimulator(slave!, Unit, registers);

        var mb = new ModbusRtu { PortName = master!, Baudrate = 9600, DataBits = 8, Parity = Parity.None, StopBits = StopBits.One, Timeout = 2000, Log = Logger.Null };
        mb.Open();
        try
        {
            var data = mb.ReadRegister(Unit, 0, 4);

            Assert.NotNull(data);
            Assert.Equal(registers, data!);
        }
        finally
        {
            mb.Dispose();
        }
    }

    [Fact]
    [DisplayName("RTU 主站写入后从站寄存器被改写(FC06)")]
    public void WriteSingleRegister_ChangesSlave()
    {
        var master = MasterPort;
        var slave = SlavePort;
        if (master.IsNullOrEmpty() || slave.IsNullOrEmpty()) return;
        if (!File.Exists(master) || !File.Exists(slave)) return;

        var registers = new UInt16[] { 0, 0, 0, 0 };

        using var sim = new RtuSlaveSimulator(slave!, Unit, registers);

        var mb = new ModbusRtu { PortName = master!, Baudrate = 9600, DataBits = 8, Parity = Parity.None, StopBits = StopBits.One, Timeout = 2000, Log = Logger.Null };
        mb.Open();
        try
        {
            mb.WriteRegister(Unit, 2, 0x00FF);
            Thread.Sleep(100);

            Assert.Equal(0x00FF, sim.Registers[2]);
        }
        finally
        {
            mb.Dispose();
        }
    }

    [Fact]
    [DisplayName("RTU 工具 ViewModel 连接虚拟串口后可读写")]
    public void ViewModel_ReadsThroughVirtualPort()
    {
        var master = MasterPort;
        var slave = SlavePort;
        if (master.IsNullOrEmpty() || slave.IsNullOrEmpty()) return;
        if (!File.Exists(master) || !File.Exists(slave)) return;

        var registers = new UInt16[] { 7, 8, 9, 10 };

        using var sim = new RtuSlaveSimulator(slave!, Unit, registers);

        var vm = new ModbusRtuViewModel
        {
            PortName = master!,
            BaudRate = 9600,
            SlaveAddress = Unit,
            StartAddress = 1,
            ReadCount = 2,
            FunctionCodeIndex = 2, // 03 读保持寄存器
        };

        vm.ToggleConnectCommand.Execute(null);
        Assert.True(vm.IsConnected, vm.Log);

        try
        {
            vm.ExecuteCommand.Execute(null);
            Assert.Contains("8", vm.ReadResult);
            Assert.Contains("9", vm.ReadResult);
        }
        finally
        {
            vm.ToggleConnectCommand.Execute(null);
        }
    }

    /// <summary>最小 RTU 从站模拟:只支持 FC03/FC06,够回环验证用</summary>
    private sealed class RtuSlaveSimulator : IDisposable
    {
        private readonly SerialPort _port;
        private readonly Byte _unit;
        private readonly Thread _thread;
        private volatile Boolean _running = true;

        public UInt16[] Registers { get; }

        public RtuSlaveSimulator(String portName, Byte unit, UInt16[] registers)
        {
            _unit = unit;
            Registers = registers;
            _port = new SerialPort(portName, 9600, Parity.None, 8, StopBits.One) { ReadTimeout = 500, WriteTimeout = 500 };
            _port.Open();

            _thread = new Thread(Loop) { IsBackground = true };
            _thread.Start();
        }

        private void Loop()
        {
            var buffer = new Byte[256];
            var count = 0;

            while (_running)
            {
                try
                {
                    var n = _port.Read(buffer, count, buffer.Length - count);
                    count += n;
                }
                catch (TimeoutException)
                {
                    continue;
                }
                catch
                {
                    break;
                }

                // 帧长按功能码推断:03/06 均为 8 字节
                while (count >= 8)
                {
                    var frame = new Byte[8];
                    Array.Copy(buffer, frame, 8);
                    Array.Copy(buffer, 8, buffer, 0, count - 8);
                    count -= 8;

                    var reply = Handle(frame);
                    if (reply != null)
                    {
                        try { _port.Write(reply, 0, reply.Length); } catch { }
                    }
                }
            }
        }

        private Byte[]? Handle(Byte[] frame)
        {
            if (frame[0] != _unit) return null;

            var fc = frame[1];
            var address = (UInt16)((frame[2] << 8) | frame[3]);
            var value = (UInt16)((frame[4] << 8) | frame[5]);

            switch (fc)
            {
                case 0x03:
                    {
                        if (address + value > Registers.Length) return Error(fc, 0x02);

                        var body = new List<Byte> { _unit, 0x03, (Byte)(value * 2) };
                        for (var i = 0; i < value; i++)
                        {
                            var v = Registers[address + i];
                            body.Add((Byte)(v >> 8));
                            body.Add((Byte)(v & 0xFF));
                        }
                        return WithCrc(body);
                    }
                case 0x06:
                    {
                        if (address >= Registers.Length) return Error(fc, 0x02);

                        Registers[address] = value;
                        return WithCrc([.. frame[..6]]);
                    }
                default:
                    return Error(fc, 0x01);
            }
        }

        private Byte[] Error(Byte fc, Byte code) => WithCrc([_unit, (Byte)(fc | 0x80), code]);

        private static Byte[] WithCrc(IEnumerable<Byte> body)
        {
            var list = body.ToList();
            var crc = Crc16([.. list]);
            list.Add((Byte)(crc & 0xFF));
            list.Add((Byte)(crc >> 8));
            return [.. list];
        }

        private static UInt16 Crc16(Byte[] data)
        {
            var crc = (UInt16)0xFFFF;
            foreach (var b in data)
            {
                crc ^= b;
                for (var i = 0; i < 8; i++)
                {
                    if ((crc & 1) != 0)
                        crc = (UInt16)((crc >> 1) ^ 0xA001);
                    else
                        crc >>= 1;
                }
            }
            return crc;
        }

        public void Dispose()
        {
            _running = false;
            try { _port.Close(); } catch { }
            try { _port.Dispose(); } catch { }
        }
    }
}