IOTGateway 新增驱动

1、资料

教程：http://iotgateway.net/docs/iotgateway-intermediate/driver/drvier

2、新建项目

在解决方案->Drivers文件夹，右键添加->新建项目->C#类库

项目名DriverSimTcpClient，放在iotgateway\Plugins\Drivers路径下

修改Class1为SimTcpClient

双击项目，修改配置

iotgateway\Plugins\Drivers\DriverSimTcpClient\DriverSimTcpClient.csproj

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>net6.0</TargetFramework>
        <OutputPath>../../../IoTGateway/bin/Debug/net6.0/drivers</OutputPath>
        <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
        <ImplicitUsings>enable</ImplicitUsings>
        <Nullable>enable</Nullable>
    </PropertyGroup>
    <ItemGroup>
        <PackageReference Include="SimpleTCP.Core" Version="1.0.4" />
    </ItemGroup>
    <ItemGroup>
        <ProjectReference Include="..\..\PluginInterface\PluginInterface.csproj" />
    </ItemGroup>
</Project>

3、编写项目代码

基本框架

using Microsoft.Extensions.Logging;
using PluginInterface;

namespace DrivceDemo
{
    /// <summary>
    /// 基本框架
    /// </summary>
    [DriverSupported("DemoDevice")]
    [DriverInfo("demo", "V1.0.0", "Copyright IoTGateway© 2023-07-14")]
    public class demo : IDriver
    {
        #region 配置参数
        [ConfigParameter("设备Id")] public string DeviceId { get; set; }

        [ConfigParameter("IP地址")] public string IpAddress { get; set; } = "127.0.0.1";

        [ConfigParameter("端口号")] public int Port { get; set; } = 6666;

        [ConfigParameter("超时时间ms")] public int Timeout { get; set; } = 300;

        [ConfigParameter("最小通讯周期ms")] public uint MinPeriod { get; set; } = 3000;
        #endregion

        /// <summary>
        /// 判断连接状态
        /// </summary>
        public bool IsConnected
        {
            get
            {
                return true;
            }
        }

        public ILogger _logger { get; set; }
        private readonly string _device;

        public demo(string device, ILogger logger)
        {
            _device = device;
            _logger = logger;
            _logger.LogInformation($"Device:[{_device}],Create()");

            System.Diagnostics.Debug.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss:fff")} 初始化");
        }

        /// <summary>
        /// 连接
        /// </summary>
        /// <returns></returns>
        public bool Connect()
        {
            System.Diagnostics.Debug.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss:fff")} 连接");
            return true;
        }

        /// <summary>
        /// 读取
        /// </summary>
        /// <param name="ioarg"></param>
        /// <returns></returns>
        [Method("方法中文名", description: "方法描述")]
        public DriverReturnValueModel Read(DriverAddressIoArgModel ioarg)
        {
            var ret = new DriverReturnValueModel { StatusType = VaribaleStatusTypeEnum.Good };
            System.Diagnostics.Debug.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss:fff")} 读取");
            return ret;
        }

        /// <summary>
        /// 断开
        /// </summary>
        /// <returns></returns>
        public bool Close()
        {
            System.Diagnostics.Debug.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss:fff")} 断开");
            return true;
        }

        /// <summary>
        /// 释放
        /// </summary>
        public void Dispose()
        {
            System.Diagnostics.Debug.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss:fff")} 释放");
        }

        /// <summary>
        /// 写入
        /// </summary>
        /// <param name="requestId"></param>
        /// <param name="method"></param>
        /// <param name="ioarg"></param>
        /// <returns></returns>
        public async Task<RpcResponse> WriteAsync(string requestId, string method, DriverAddressIoArgModel ioarg)
        {
            RpcResponse rpcResponse = new() { IsSuccess = false, Description = "设备驱动内未实现写入功能" };

            System.Diagnostics.Debug.WriteLine($"{DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss:fff")} 写入");

            return rpcResponse;
        }
    }
}

启动流程：释放->初始化

关闭流程：断开->释放->初始化

官方例子

using PluginInterface;
using SimpleTCP;
using Microsoft.Extensions.Logging;

namespace DriverSimTcpClient
{
    [DriverSupported("SimTcpServerDevice")]
    [DriverInfo("SimTcpClient", "V1.0.0", "Copyright IoTGateway© 2022-06-04")]
    public class SimTcpClient : IDriver
    {
        /// <summary>
        /// tcp客户端
        /// </summary>
        private SimpleTcpClient? _client;

        /// <summary>
        /// 缓存最新的服务器返回的原始数据
        /// </summary>
        private byte[]? _latestRcvData;
        public ILogger _logger { get; set; }
        private readonly string _device;

        #region 配置参数

        [ConfigParameter("设备Id")] public string DeviceId { get; set; }

        [ConfigParameter("IP地址")] public string IpAddress { get; set; } = "127.0.0.1";

        [ConfigParameter("端口号")] public int Port { get; set; } = 6666;

        /// <summary>
        /// 为了演示枚举类型在web端的录入，这里没用到 但是你可以拿到
        /// </summary>
        [ConfigParameter("连接类型")]
        public ConnectionType ConnectionType { get; set; } = ConnectionType.Long;

        [ConfigParameter("超时时间ms")] public int Timeout { get; set; } = 300;

        [ConfigParameter("最小通讯周期ms")] public uint MinPeriod { get; set; } = 3000;

        #endregion

        public SimTcpClient(string device, ILogger logger)
        {
            _device = device;
            _logger = logger;

            _logger.LogInformation($"Device:[{_device}],Create()");
        }

        /// <summary>
        /// 判断连接状态
        /// </summary>
        public bool IsConnected
        {
            get
            {
                //客户端对象不为空并且客户端已连接则返回true
                return _client != null && _client.TcpClient != null && _client.TcpClient.Connected;
            }
        }

        /// <summary>
        /// 进行连接
        /// </summary>
        /// <returns>连接是否成功</returns>
        public bool Connect()
        {
            try
            {
                //进行连接
                _client = new SimpleTcpClient().Connect(IpAddress, Port);
                _client.DataReceived += Client_DataReceived;
            }
            catch (Exception)
            {
                return false;
            }

            return IsConnected;
        }

        /// <summary>
        /// 收到服务端数据
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void Client_DataReceived(object? sender, Message e)
        {
            //如果收到的数据校验正确，则放在内存中
            if (e.Data.Length == 8 && e.Data[0] == 0x08)
                _latestRcvData = e.Data;
        }

        /// <summary>
        /// 断开连接
        /// </summary>
        /// <returns>断开是否成功</returns>
        public bool Close()
        {
            try
            {
                if (_client != null)
                {
                    _client.DataReceived -= Client_DataReceived;
                    //断开连接
                    _client?.Disconnect();
                }

                return !IsConnected;
            }
            catch (Exception)
            {
                return false;
            }
        }

        /// <summary>
        /// 释放
        /// </summary>
        public void Dispose()
        {
            try
            {
                //释放资源
                _client?.Dispose();
            }
            catch (Exception)
            {
            }
        }

        /// <summary>
        /// 发送数据
        /// </summary>
        private readonly byte[] _sendCmd = { 0x01, 0x02, 0x03, 0x04 };

        /// <summary>
        /// 解析并返回
        /// </summary>
        /// <param name="ioarg">ioarg.Address为起始变量字节编号;ioarg.ValueType为类型</param>
        /// <returns></returns>
        [Method("读模拟设备数据", description: "读模拟设备数据,开始字节和长度")]
        public DriverReturnValueModel Read(DriverAddressIoArgModel ioarg)
        {
            var ret = new DriverReturnValueModel { StatusType = VaribaleStatusTypeEnum.Good };
            ushort startIndex;
            //判断地址是否为整数
            if (!ushort.TryParse(ioarg.Address, out startIndex))
            {
                ret.StatusType = VaribaleStatusTypeEnum.Bad;
                ret.Message = "起始字节编号错误";
                return ret;
            }

            //连接正常则进行读取
            if (IsConnected)
            {
                try
                {
                    //发送请求
                    _client?.Write(_sendCmd);
                    //等待恢复，这里可以优化
                    Thread.Sleep(Timeout);
                    if (_latestRcvData == null)
                    {
                        ret.StatusType = VaribaleStatusTypeEnum.Bad;
                        ret.Message = "没有收到数据";
                    }
                    else
                    {
                        //解析数据，并返回
                        switch (ioarg.ValueType)
                        {
                            case DataTypeEnum.UByte:
                            case DataTypeEnum.Byte:
                                ret.Value = _latestRcvData[startIndex];
                                break;
                            case DataTypeEnum.Int16:
                                var buffer16 = _latestRcvData.Skip(startIndex).Take(2).ToArray();
                                ret.Value = BitConverter.ToInt16(new[] { buffer16[0], buffer16[1] }, 0);
                                break;
                            case DataTypeEnum.Float:
                                //拿到有用的数据
                                var buffer32 = _latestRcvData.Skip(startIndex).Take(4).ToArray();
                                //大小端转换一下
                                ret.Value = BitConverter.ToSingle(
                                    new[] { buffer32[3], buffer32[2], buffer32[1], buffer32[0] }, 0);
                                break;
                        }
                    }
                }
                catch (Exception ex)
                {
                    ret.StatusType = VaribaleStatusTypeEnum.Bad;
                    ret.Message = $"读取失败,{ex.Message}";
                }
            }
            else
            {
                ret.StatusType = VaribaleStatusTypeEnum.Bad;
                ret.Message = "连接失败";
            }

            return ret;
        }


        public async Task<RpcResponse> WriteAsync(string requestId, string method, DriverAddressIoArgModel ioarg)
        {
            RpcResponse rpcResponse = new() { IsSuccess = false, Description = "设备驱动内未实现写入功能" };
            return rpcResponse;
        }
    }

    public enum ConnectionType
    {
        Long,
        Short
    }
}

右键Plugins文件夹，然后重新生成，这一步不能少。

4、注册驱动

生成DriverSimTcpClient 项目

iotgateway\IoTGateway\bin\Debug\net6.0\drivers\net6.0路径下可以看到生成了DriverSimTcpClient.dll

运行IoTGateway，访问本地518端口

添加驱动

网关配置->驱动管理->新建

添加结果如下

5、创建设备

采集配置->设备维护->添加设备，在测试组，添加个测试2号

6、添加变量

1、采集配置->变量配置

        手动添加或者通过excel批量导入下面变量

7、开始采集

通讯配置按默认的。

优先启动TcpServer工具

然后在设备维护中，启动设备

发送数据包：08 05 41 48 F5 C3 1A 20

 包头：08

运行状态：05

设备温度：41 48 F5 C3

电机转速：1A 20

注意：

1、每次新增一个驱动时，都必须重启IOTSharp和IoTGateway，并且要先启动IOTSharp，再启动IoTGateway。顺序不能反了。否则设备将无法在IOTSharp中显示出来。

2、设备变量必须开启上传功能，否则，无法订阅到消息。

未开启上传功能，订阅的消息是空的。

成功订阅，消息如下：