ModbusTCPMaster.cs 16.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
using Common.Communication.Protocol.Modbus;
using log4net;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Reflection;
using System.Threading;

namespace Common.Communication.TCP
{
    public class ModbusTCPMaster
    {
        static ILog log = LogManager.GetLogger(MethodBase.GetCurrentMethod()?.DeclaringType);
        List<Register> registers = new List<Register>() {
        new CoilRegister(),new DiscreteInputRegister(),new HoldingRegister(),
        new InputRegister()
        };
        public static List<string> Functions = new List<string>() {
        "01 Read Coils","02 Read Discrete Inputs","03 Read Holding Registers",
        "04 Read Input Registers","05 WriteSingle Coil","06 Write Single Register",
        "0F Write Multiple Coils","10 Write Multiple Registers"
        };
        TcpClient tcpClient = new TcpClient();
        Thread thread;

        public delegate void ConnectionChangedHandler(string ip, int port, bool onOff);
        public delegate void ReceiveDataHandler(string ip, int port, RequestInfo requestInfo, byte[] data);
        public event ConnectionChangedHandler ConnectionChanged;
        public event ReceiveDataHandler ReceiveData;
        public bool IsAutoReconnect = false;
        public int TryTimes = 5;
        public string IP { get; private set; }
        public int Port { get; private set; }
        bool online = false;
        public bool Online
        {
            get { return online; }
            private set
            {
                if (online != value)
                {
                    online = value;
                    ConnectionChanged?.Invoke(IP, Port, value);
                }
            }
        }
        bool start = false;
        public ModbusTCPMaster()
        {
            start = true;
            thread = new Thread(sendQueueRequest);
            thread.IsBackground = true;
            thread.Start();
        }
        ~ModbusTCPMaster()
        {
            start = false;
        }
        object locsend = new object();
        private const int SEND_SLEEP = 50;   //每条命令发送的间隔
        void sendQueueRequest()
        {
            while (start)
            {
                if (Monitor.TryEnter(locsend))
                {
                    try
                    {
                        Online = tcpClient.IsConnected();
                        if (!Online)
                        {
                            if (IsAutoReconnect)
                            {
                                tcpClient.Connect(IP, Port, ReceiveMessage);
                                Thread.Sleep(1000);
                                RequestInfo requestInfo = GetPeek();
                                if (requestInfo != null && requestInfo.Requested)
                                {
                                    requestInfo.SetRequestState(false);
                                    log.Error($"Disconnect 重置请求状态{requestInfo}");
                                    continue;
                                }
                            }
                        }
                        else
                        {
                            SendRequest();
                        }


                    }
                    catch (Exception ex)
                    {
                        log.Error($"sendQueueRequest出错");
                    }
                    finally
                    {
                        Monitor.Exit(locsend);
                    }
                }

            }
        }
        /// <summary>
        /// 请求队列
        /// </summary>
        ConcurrentQueue<RequestInfo> requestInfos = new ConcurrentQueue<RequestInfo>();

        public void Connect(string ip, int port)
        {
            IP = ip;
            Port = port;
            tcpClient.Connect(ip, port, ReceiveMessage);
            Thread.Sleep(1000);
            IsAutoReconnect = true;
        }
        public void Close()
        {
            tcpClient.Close();
        }
        /// <summary>
        /// 添加请求
        /// </summary>
        /// <param name="requestInfo">请求信息</param>
        public void AddRequest(RequestInfo requestInfo)
        {
            EnRequestQueue(requestInfo);
        }
        /// <summary>
        /// 添加请求
        /// </summary>
        /// <param name="funCode"></param>
        /// <param name="startAddr"></param>
        /// <param name="countOrValue"></param>
        /// <param name="equpAddr"></param>
        /// <param name="values"></param>
        public void AddRequest(byte funCode, int startAddr, int countOrValue, byte equpAddr = 1, int[] values = null)
        {
            EnRequestQueue(new RequestInfo()
            {
                FunCode = funCode,
                StartAddr = startAddr,
                CountOrValue = countOrValue,
                EquipAddr = equpAddr,
                Values = values
            });
        }
        /// <summary>
        /// 收到数据
        /// </summary>
        /// <param name="msg"></param>
        void ReceiveMessage(string msg, byte[] data)
        {
            log.Debug($"Receive Data {StringHelper.ToHexString(data)}");
            List<byte[]> recvFun = Register.SplitResponse(data);
            foreach (var item in recvFun)
            {
                log.Debug($"Process Data {StringHelper.ToHexString(item)}");
                RequestInfo requestInfo = GetPeek();
                if (requestInfo != null)
                {
                    byte[] readData;
                    bool rtn = GetResponseResult(requestInfo.FunCode, item, out readData);
                    if (rtn)
                    {
                        RemovePeek(true);
                        if (readData != null)
                        {
                            ReceiveData?.Invoke(IP, Port, requestInfo, readData);
                            log.Debug($"{StringHelper.ToHexString(readData)}{requestInfo}");
                        }
                    }
                    else
                    {
                        rtn = GetResponseResult(requestInfo.FunCode, item, out readData,true);
                        if(rtn)
                        {
                            if (readData != null)
                            {
                                ReceiveData?.Invoke(IP, Port, requestInfo, readData);
                                log.Debug($"{StringHelper.ToHexString(readData)}{requestInfo}");
                            }
                        }
                        else
                        {
                            if (Register.ParseHeader(item, out byte func, out int len))
                            {
                                rtn = GetResponseResult(func, item, out readData, true);
                                if (rtn)
                                {
                                    if (readData != null)
                                    {
                                        ReceiveData?.Invoke(IP, Port, new RequestInfo() { FunCode = func }, readData);
                                        log.Debug($"{StringHelper.ToHexString(readData)}");
                                    }
                                }
                            }
                            else
                            {
                                requestInfo.SetRequestState(false);
                                log.Error($"Request Fail {requestInfo}");
                                requestInfo.TryTimes++;
                                //if (requestInfo.TryTimes > TryTimes)//重试一定次数失败删除
                                //{
                                //    RemovePeek(false);
                                //}
                            }

                        }

                    }
                }
                else//设备主动上传收到的信息
                {
                    log.Debug($"Upload {StringHelper.ToHexString(item)}");
                    if (Register.ParseHeader(item, out byte func, out int len))
                    {
                        bool rtn = GetResponseResult(func, item, out byte[] readData,true);
                        if (rtn)
                        {
                            if (readData != null)
                            {
                                ReceiveData?.Invoke(IP, Port, new RequestInfo() { FunCode = func }, readData);
                                log.Debug($"{StringHelper.ToHexString(readData)}");
                            }
                        }
                        else
                        {
                            log.Error($"Upload GetResponseResult Fail {StringHelper.ToHexString(item)}");
                        }
                    }
                    else
                    {
                        log.Error($"Upload ParseHeader Fail {StringHelper.ToHexString(item)}");
                    }
                }
            }
        }
        RegisterFunction GetFunction(byte funCode)
        {
            Register register = GetRegister(funCode);
            if (register == null)
            {
                log.Error($"不存在的功能码:{StringHelper.ToHexString(funCode)}");
                return RegisterFunction.Read;
            }
            return GetFuncByByte(register, funCode);
        }
        /// <summary>
        /// 获取请求字节数组
        /// </summary>
        /// <param name="funCode"></param>
        /// <param name="startAddr"></param>
        /// <param name="countOrValue"></param>
        /// <param name="values"></param>
        /// <returns></returns>
        byte[] GetRequestBytes(byte funCode, int startAddr, int countOrValue, byte equipAddr, int[] values = null)
        {
            Register register = GetRegister(funCode);
            if (register == null)
            {
                log.Error($"不存在的功能码:{StringHelper.ToHexString(funCode)}");
                return new byte[] { 0x00 };
            }
            RegisterFunction registerFunction = GetFuncByByte(register, funCode);

            if (values != null)
            {
                ushort[] tmpvalues = new ushort[values.Length];
                for (int i = 0; i < values.Length; i++)
                {
                    tmpvalues[i] = (ushort)values[i];
                }
                return register.GetRequestBytes(registerFunction, (ushort)startAddr, (ushort)countOrValue, equipAddr, tmpvalues);
            }
            return register.GetRequestBytes(registerFunction, (ushort)startAddr, (ushort)countOrValue, equipAddr, null);
        }
        /// <summary>
        /// 获取响应结果
        /// </summary>
        /// <param name="funCode">功能码</param>
        /// <param name="response">响应的字节数组</param>
        /// <param name="data">只有读操作可以使用:读取到的数据</param>
        /// <returns>true:操作成功</returns>
        bool GetResponseResult(byte funCode, byte[] response, out byte[] data, bool ignoreSerial = false)
        {
            data = null;
            Register register = GetRegister(funCode);
            if (register == null)
            {
                log.Error($"不存在的功能码:{StringHelper.ToHexString(funCode)}");
                return false;
            }
            RegisterFunction registerFunction = GetFuncByByte(register, funCode);
            if (ignoreSerial)
                return register.GetReadReault(response, out data);
            else
                return register.GetResult(registerFunction, response, out data);
        }
        RegisterFunction GetFuncByByte(Register register, byte funCode)
        {
            RegisterFunction registerFunction = RegisterFunction.Read;
            foreach (RegisterFunction item in register.FunctionCodes.Keys)
            {
                if (register.FunctionCodes[item].Equals(funCode))
                {
                    registerFunction = item;
                    break;
                }
            }
            return registerFunction;
        }
        /// <summary>
        /// 根据功能码定位置指定寄存器
        /// </summary>
        /// <param name="funCode"></param>
        /// <returns></returns>
        Register GetRegister(byte funCode)
        {
            return registers.Find(s => s.FunctionCodes.ContainsValue(funCode));
        }
        /// <summary>
        /// 加入队列
        /// </summary>
        /// <param name="request"></param>
        void EnRequestQueue(RequestInfo request)
        {
            requestInfos.Enqueue(request);
            //if (!GetFunction(request.FunCode).Equals(RegisterFunction.Read))
            //    log.Info($"Enqueue Request {request}");
            //else
                log.Debug($"Enqueue Request {request}");
        }
        /// <summary>
        /// 获取队列第一个请求
        /// </summary>
        /// <returns></returns>
        RequestInfo GetPeek()
        {
            requestInfos.TryPeek(out RequestInfo request);
            return request;
        }
        /// <summary>
        /// 移除队列第一个请求
        /// </summary>
        /// <returns></returns>
        bool RemovePeek(bool success)
        {
            bool rtn = requestInfos.TryDequeue(out RequestInfo request);
            if (success)
            {
                request.Result = true;
                request.FinishTime = DateTime.Now;
                if (!GetFunction(request.FunCode).Equals(RegisterFunction.Read))
                    log.Info($"Request Success {request}");
                else
                    log.Debug($"Request Success {request}");
            }
            else
            {
                log.Error($"Try Request {TryTimes} Times Fail {request}");
            }
            return rtn;
        }
        void SendRequest()
        {
            RequestInfo requestInfo = GetPeek();
            if (requestInfo != null && (!requestInfo.Requested || requestInfo.RequestTimeOut))
            {
                bool rtn = tcpClient.Send(GetRequestBytes(requestInfo.FunCode, requestInfo.StartAddr, requestInfo.CountOrValue, requestInfo.EquipAddr, requestInfo.Values));
                requestInfo.SetRequestState(rtn);
                if (!GetFunction(requestInfo.FunCode).Equals(RegisterFunction.Read))
                    log.Info($"Request {requestInfo}");
                else
                    log.Debug($"Request {requestInfo}");
            }
        }
    }
    /// <summary>
    /// Modbus请求信息
    /// </summary>
    public class RequestInfo
    {
        /// <summary>
        /// 功能码
        /// </summary>
        public byte FunCode { get; set; }
        /// <summary>
        /// 开始地址
        /// </summary>
        public int StartAddr { get; set; }
        /// <summary>
        /// 数量/值
        /// </summary>
        public int CountOrValue { get; set; }
        /// <summary>
        /// 设备地址
        /// </summary>
        public byte EquipAddr { get; set; }
        /// <summary>
        /// 数组值,写多个值用到
        /// </summary>
        public int[] Values { get; set; }
        /// <summary>
        /// 等待一定秒数反转信号。大于0,反转
        /// </summary>
        public int Seconds { get; set; } = 0;
        /// <summary>
        /// 是否请求过
        /// </summary>
        public bool Requested { get; set; } = false;
        public int TryTimes { get; set; } = 0;
        /// <summary>
        /// 请求时间
        /// </summary>
        public DateTime RequestTime { get; set; } = DateTime.Now;
        public DateTime FinishTime { get; set; }
        /// <summary>
        /// 请求超时
        /// </summary>
        public bool RequestTimeOut { get { return (DateTime.Now - RequestTime).TotalSeconds > 5; } }
        /// <summary>
        /// 结果
        /// </summary>
        public bool Result { get; set; } = false;
        /// <summary>
        /// 请求
        /// </summary>
        public void SetRequestState(bool request)
        {
            Requested = request;
            if (request)
                RequestTime = DateTime.Now;
        }
        public override string ToString()
        {
            return $"【{JsonHelper.SerializeObject(this)}】";//{StringHelper.GetPropertiesStr<RequestInfo>(this)}
        }
    }
}