Iot物联网-插件版

本系统为iot物联网的插件版,功能和文档与独立应用版有些地方不一致，以本文档内容为准

详细介绍

本系统是基于webman开发的一套物联网平台，可以实现物联网设备的联网上线、数据采集、命令下发、被动回复、实时通讯等功能，支持TCP协议、Websocket协议（ws和wss）和MQTT协议，本系统提供的是TCP协议透传，用户需根据实际情况将设备协议转为TCP协议后接入本系统，一般可使用DTU设备或IO设备，这些设备可以将硬件的各种协议统一转为TCP协议，如电表、仪表、传感器、地磅、IO设备、开关量、模拟量、扫码枪、语音播报、身份证读卡器、各类灯具、门禁开关等都支持，真正实现万物互联。

安装步骤

1、安装数据库组件：(参考webman文档)

composer require -W illuminate/database

2、安装redis组件：(需安装redis扩展，参考webman文档)

composer require -W illuminate/redis illuminate/events

3、安装gateway-worker插件(安装完成后,需将config/plugin/gateway-worker/app.php中的enable改为false)

composer require webman/gateway-worker

4、安装http客户端插件

composer require -W workerman/http-client

5、安装redis队列

composer require webman/redis-queue

6、安装workerman/mqtt

composer require workerman/mqtt ^1.7

以上步骤完成之后，再去webman-admin的插件管理里面安装本插件，如果已经安装过本插件，那么直接进行下述升级步骤。
注意:php版本要求7.X
插件安装完成之后，进行以下升级步骤，升级文档和所需文件在“/app/plugin/iotplug/升级步骤和相关文件”目录下。
升级步骤：

升级前注意备份

1、将plugin\iotplug\升级步骤和相关文件\redis-queue目录下的3个文件复制到app\queue\redis目录下。
2、新建wa_device_logs表：

CREATE TABLE `wa_device_logs` (
  `id` bigint(20) NOT NULL COMMENT 'id',
  `device_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '设备id',
  `type` int(11) NOT NULL DEFAULT '0' COMMENT '设备类型',
  `topic` varchar(255) DEFAULT NULL COMMENT '主题',
  `vtype` int(11) NOT NULL DEFAULT '0' COMMENT '0:ASCII类型1:HEX类型',
  `val` longtext NOT NULL COMMENT '值',
  `year` varchar(10) NOT NULL COMMENT '年',
  `month` varchar(10) NOT NULL COMMENT '月',
  `day` varchar(10) NOT NULL COMMENT '日',
  `date` date NOT NULL COMMENT '日期',
  `addtime` datetime NOT NULL COMMENT '时间',
  `del` int(11) NOT NULL DEFAULT '0' COMMENT '0未删除1已删除',
  `del_id` bigint(20) NOT NULL DEFAULT '0' COMMENT '删除人id',
  `del_time` datetime DEFAULT NULL COMMENT '删除时间'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='设备数据日志表';
--
-- 表的索引 `wa_device_logs`
--
ALTER TABLE `wa_device_logs`
  ADD PRIMARY KEY (`id`),
  ADD KEY `member_id_device_id_del` (`device_id`,`del`),
  ADD KEY `idx_device_time` (`device_id`,`year`,`month`,`day`,`del`);

3、新建wa_webhook_logs表：

CREATE TABLE `wa_webhook_logs` (
      `id` bigint(20) NOT NULL COMMENT 'id',
      `device_id` bigint(20) NOT NULL COMMENT '设备id',
      `url` text NOT NULL COMMENT 'url',
      `param` text NOT NULL COMMENT '设备数据',
      `status` int(11) NOT NULL COMMENT '0执行成功,1执行失败',
      `msg` text COMMENT '执行结果',
      `exception` text COMMENT '异常结果',
      `year` varchar(20) NOT NULL COMMENT '年份',
      `month` varchar(20) NOT NULL COMMENT '月份',
      `day` varchar(20) NOT NULL COMMENT '日期',
      `date` date NOT NULL COMMENT '日期',
      `addtime` datetime NOT NULL COMMENT '时间',
      `del` int(11) NOT NULL COMMENT '0未删除1已删除',
      `del_id` bigint(20) NOT NULL COMMENT '删除人id',
      `del_time` datetime DEFAULT NULL COMMENT '删除时间'
     ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='设备webhook日志';

--
-- 表的索引 `wa_webhook_logs`
--
ALTER TABLE `wa_webhook_logs`
  ADD PRIMARY KEY (`id`),
  ADD KEY `member_id_device_id_del` (`device_id`,`del`),
  ADD KEY `idx_device_year_month_day` (`device_id`,`year`,`month`,`day`,`del`);

4、wa_iot表增加字段,已经存在就不需要执行了

ALTER TABLE `wa_iot` ADD `log` INT(1) NOT NULL DEFAULT '1' COMMENT '是否启用设备数据日志0不启用1启用 ' AFTER `directive`;

5、MQTT协议，如果用不到mqtt可以忽略。
（1）安装emqx1.0，建议用宝塔进行安装。
（2）登录emqx网页管理后台，左侧菜单里找到访问控制-客户端认证，创建mysql认证方式，填写mysql权限信息，密码加密方式：plain，加盐方式：disable
SQL代码：

（3）左侧菜单里：集成-webhook，创建webhook回调，触发器：所有消息和事件，请求方法：post，
URL：http://XXXX/api/mqtt（本URL可以随意更改，但是必须是不需要登录就可以被访问的，安全校验请自行设计）
（4）在http://XXXX/api/mqtt里的代码如下(文件路径：plugin\iotplug\升级步骤和相关文件\ApiController.php)：

<?php

        namespace app\controller;

        class ApiController
        {
            public function mqtt()
            {
                //安全校验请自行设计

                //获取请求参数
                $param = [];
                if (!empty(request())) {
                    $param = request()->all();
                    $body = request()->rawBody();
                    if (!empty($body)) {
                        $body = jsonDecode($body, true);
                        if (!empty($body)) {
                            $param = array_merge($param, $body);
                        }
                    }
                }
                //success,normal
                //not_authorized bad_username_or_password
                if (isset($param['reason_code']) && in_array($param['reason_code'], ['not_authorized', 'bad_username_or_password'])) {
                    return $param['reason_code'];
                }
                //发送mqtt消息
                $param['index'] = genreId('mqtt');
                \Webman\RedisQueue\Redis::send('iots_redis_queue_mqtt_api', $param);
            }
        }

6、重启项目 php start.php restart -d 完成升级

功能特性

1、数据采集：支持利用TCP协议从设备实时采集数据，数据可以直接存入redis里，支持string类型和list类型，支持数据过滤，支持数据转发给指定url。
2、命令下发：支持服务端秒级给设备下发指令，支持以队列的方式下发。
3、被动回复：根据设备发送的特定指令，针对性的回复命令。
4、实时通讯：可以跟设备实时进行通讯，方便验证命令和调试设备。
5、数据转发：可以实现两个或多个设备之间的相互转发，如：想让设备采集的数据直接发送到网页websocket，用转发即可简单实现。

安装使用

1、下载代码部署到服务器上
2、修改配置参数：文件路径：plugin/iotplug/config/iot.php,其中ip:为所在服务器的公网IP,tcp_port:TCP协议监听端口,ws_port:WebSocket协议监听端口(ws),wss_port:WebSocket协议监听端口(wss),ssl_cert:SSL证书(.crt),ssl_key:SSL证书密钥(.key),super_code:超级权限注册包(注意修改),默认所有的设备收到的消息都会转发消息到这个注册包.
(1)设置的端口要注意开启放行，如果是用的宝塔，在安全栏目添加，如果是阿里云ECS，注意在ECS控制台里添加安全组放行。
(2)wss_port是https的websocket端口，如果需要使用,请配置ssl证书，阿里云腾讯云都可以申请免费的证书。注意：如果是链接wss的话，websocket不能用ip地址，需要用域名，跟证书保持一致。如WebSocket("wss://iot.xxx.com:6363"),其中iot.xxx.com的证书要跟配置的wss.key和wss.crt一致
3、如果需要mqtt，那么需要安装mqtt服务端。百度安装emqx软件的步骤或者宝塔面板-软件管理-搜索emqx安装。安装完成后进入emqx的后台管理系统，默认的路径是http://xx.xx.xx.xx:18083 首次登录需要设置账号密码。登录进去之后找到客户端认证设置菜单。
3.1配置客户端认证：

SELECT password FROM wa_iot where username = ${username} and code = ${clientid} and del = 0 LIMIT 1

具体配置页面如下图,注意密码加密方式为:plain,加盐:disable

3.2配置webhook：http://xx.xx.xx.xx:6767/api/mqtt 勾选所有消息与事件

如果需要限制客户端只能使用其设置的主题，那么可以启用客户端授权（默认不启用），并且后台要设置当授权未通过时断开连接。
3.3配置客户端

SELECT action, permission, topic FROM wa_iot where username = ${username} and code = ${clientid} and del = 0

设备操作

一、添加设备

1、自定义注册包：
（1）必填。自定义注册包是设备与服务端建立连接的唯一凭证，设备在连接服务端时，必须使用自定义注册包，否则服务端会拒绝连接。
（2）自定义注册包可以是任意字符串，但是不能包含英文逗号，否则会导致解析错误。
（3）注册包是设备的唯一ID且不能跟其他设备重复，相当于设备的身份证，用于向服务端验证身份。一般是在使用DTU的时候配置在DTU里，第一次连接服务端的时候，DTU会发送自定义注册包进行身份注册。服务端验证通过后建立连接。
（4）自定义注册包只需在第一次连接服务端时发送，后续连接服务端时，不需要再发送。

2、自定义回复包：非必填，自定义回复包是设备在第一次注册成功时，服务端回复给设备的数据，如果不填写，那么服务端不回复。

3、名称：必填，设备名称。

4、协议类型：
（1）TCP透传：创建一个TCP客户端，设备发送的数据会直接转发给服务端，服务端发送的数据会直接转发给设备。用户可以通过DTU设备，将设备的数据转发给服务端，服务端再转发给设备，这样就实现了设备与服务端的通讯。
（2）WebSocket：创建一个websocket客户端。
（3）Mqtt：创建一个Mqtt设备

5、登录类型：
（1）单点登录：该自定义注册包只允许一个设备登录，当多个设备使用同一个注册包登录时，会将已登录设备踢下去。通常设备与服务端建立的TCP协议都使用单点登录。
（2）多点登录，该自定义注册包只允许多个设备同时登录，通常websocket协议都是多点登录。

6、数据字段：
（1）此字段为配置redis字段，设备返回的数据会存入到这个redis字段里，支持string类型和list类型，如果是list类型，那么设备返回的数据会存入到list的头部，如果是string类型，那么设备返回的数据会覆盖之前的数据。如果想设置list类型，那么请在字段前面加上：list，如：list:valList。如果不设置，默认为string类型，如：val，即表示字段为val的string类型数据。
（2）ASCII：设备返回的数据以ASCII格式存入redis，HEX：以16进制格式存入redis
（3）请注意：即使不设置redis字段，这里的数据类型也要设置，系统是根据这个字段进行数据转化，如一般的设备都是HEX，系统默认

7、数据转发：
（1）此字段为配置转发设备的注册包，多个注册包用英文逗号分隔。

上图含义：路灯M9NRilOsYETL2接收到的数据会同步转发到vW5FqKGW6G28,B2PeiPfwejdu两个设备里。
（2）转发的数据会进行简单的打包，以json字符串进行转发。格式为：

{"k":"M9NRilOsYETL2","v":"values","t":"xxxx-xx-xx xx:xx:xx"} 

解释：k:数据来源的注册包,v:转发的数据,t:转发时间.

8、Http-Client：
（1）此字段为配置数据转发的url，多个url用英文逗号分隔。

上图含义：自来水供水tK8i2JvLJGrf3接收到的数据会同步转发到http://xxx.com,http://yyy.com 这两个域名，
(2)转发会以post请求进行转发，有以下参数：vtype：数据类型：0表示ASCII，1表示HEX16进制，msg：转发的数据，from：转发来源注册包

9、数据过滤
（1）如果启用的话，系统会对设备发来的数据进行简单的过滤，不符合过滤条件的数据会被丢弃。
（2）字节长度：会根据数据的字节长度进行过滤。
（3）前N位字符：会根据数据的前N位字符进行过滤。
（4）忽略心跳包：会根据特定字符串进行过滤。

二、定时下发

1、设备默认不启用定时下发，如果启用的话，需要设备重新连接后生效。
2、系统默认支持频率：1秒1次、1秒2次、30秒1次、1分钟1次、3秒1次、10秒1次。
3、自定义内容：ASCII类型，HEX类型。物联网设备一般以HEX16进制类型下发。
4、支持填写多个指令，用英文逗号,分隔。若设置多个指令，则会按照设置的频率，按照指令从前到后依次发送。
如上图所示，代表第一个30秒的时候，发送010300010001D5CA，第二个30秒发送010300040001C5CB，第三个30秒发送010300010001D5CA，依次类推。这样设计的目的是有些设备会限制请求帧的频率，频率太高或一次性发多条，设备就不会回复。

三、被动回复

1、系统支持设置两套命令回复。
2、触发指令：设备回复的指令如果与触发指令匹配即触发，服务端会进行回复。
3、回复指令：当触发被动回复后服务端回复的指令。
4、ASCII类型，HEX类型（16进制）

四、数据流

设备发送的数据都会在这个数据流上显示。系统设置了一个超级权限注册包，即config/plugin/webman/gateway-worker/app.php文件中的super_code字段，所有的iot设备发送的数据，都会默认给这个超级权限转发，即实现了数据流的实时数据监控，super_code也可以通过数据流下发指令给设备，即实现与设备的实时通讯。

五、队列下发指令

1、每一个设备在连接服务端成功之后，都会默认创建一个定时器，这个定时器是按照1秒1次进行下发指令，该定时器使用队列进行依次下发，队列为HFiots-注册包名-Default-Crontab，如果注册包名为xxxx，即：HFiots-xxxx-Default-Crontab。
2、队列的数据格式为：

$data = json_encode(['vtype' => 1, 'val' => 'xxxxxx'], JSON_UNESCAPED_UNICODE);

vtype:数据类型 0ASCII,1HEX16进制
val:下发指令
3、使用方法：

Redis::rpush('HFiots-xxxx-Default-Crontab', $data);

4、服务端会按照下面代码的顺序1秒钟给设备下发一次指令

Redis::lindex('HFiots-xxxx-Default-Crontab', 0)

六、心跳包

1、系统默认要求设备每隔30秒发送一次心跳包，如果设备超过55秒没有发送心跳包，系统会自动断开设备连接。
2、如果想关闭心跳包，可以在config/plugin/webman/gateway-worker/process.php文件中的对应协议的pingNotResponseLimit字段设置为0，即关闭心跳包。

七、指令发送

1、websocket端可以主动给其他客户端发送消息，代码如下：

var obj = {
    to: th.deviceCode, //目标客户端自定义注册包
    type: 1, //0：ASCII，1：HEX
    eol: 0, //0：指令末尾不加换行，1：指令末尾加换行（有些设备的协议需要换行来区分）
    val: '010600020001e9ca' //指令内容
};
ws.send(JSON.stringify(obj));

2、php端也可以主动给其他客户端发送消息，代码如下：

$my = [
    'from' => 'fromCode', //发送方的自定义注册包
    'to' => 'toCode', //接收方的自定义注册包
    'type' => '1', //0:ASCII,1:HEX,2:GB2312
    'eol' => '0', //不加换行
    'val' => $code //发送的内容
];
fwrite($client, json_encode($my, JSON_UNESCAPED_UNICODE) . "\n");

八、视频教程（陆续更新）

1、语音播报设备：https://www.bilibili.com/video/BV13h411V7FK
2、扫码枪：https://www.bilibili.com/video/BV1f24y1L7fd/
3、纸币识别器：https://www.bilibili.com/video/BV1Vs4y1U7Et/
4、电子秤：https://www.bilibili.com/video/BV1xo4y1H7Ro/

九、更新日志

版本v2.2.0 2025.07.02

安装workermann/mqtt
composer require workerman/mqtt ^1.7
1、wa_iot表添加索引 ALTER TABLE `wa_iot` ADD INDEX( `type`, `del`);
2、将mqtt客户端部分改为workerman/mqtt重写，不再使用emqx的webhook（请登录emqx后台关闭webhook）。
涉及到客户端在线状态、订阅、发布、记录上报数据、转发ws设备、Http-Client转发。
3、config/plugin/webman/gateway-worker/app.php增加配置项
    'mqtt_client_port' => 5103, // MQTT客户端所在进程的监听端口,用于管理mqtt设备的订阅、发布和销毁
    'mqtt_client_username' => 'admin', // MQTT客户端的管理员用户名,需跟emqx的配置保持一致:访问控制-客户端认证
    'mqtt_client_password' => '123456', // MQTT客户端的管理员密码,需跟emqx的配置保持一致:访问控制-客户端认证
    'mqtt_client_id' => 'HiWADmy42NB4', //MQTT客户端的管理员client_id(不能跟其他client_id重复),需跟emqx的配置保持一致:访问控制-客户端认证
    'mqtt_client_api_url' => 'http://127.0.0.1:18083/', //MQTT客户端的管理员api_url,带/结尾.EMQX的api端口默认18083,
    如果修改了端口,需要修改这里.如果不是本机,需要修改为实际的公网ip地址
    'mqtt_client_api_key' => 'c7ad44cbad762a5d', //MQTT客户端的管理员api_key,在emqx中创建:系统设置-API密钥
    'mqtt_client_api_secret' => 'j7SGdQpKIO3sUnTFJDJjhgVl5eyv2PpWoS2HFSYEdBP', //MQTT客户端的管理员api_secret,在emqx中创建:系统设置-API密钥
    //管理员的设置是为了接收所有mqtt设备的上报,为了安全上线前最好进行修改，如果更改(mqtt_client_username、mqtt_client_password、mqtt_client_id)的话,
    //需要同步修改emqx的配置的sql语句,路径在访问控制-客户端认证-mysql里,否则无法连接
    //mysql的sql语句如下:
    // SELECT 
    //     CASE 
    //         WHEN ${username} = "admin" AND ${clientid} = "HiWADmy42NB4" THEN "123456"
    //         ELSE password
    //     END as password
    // FROM wa_iot
    // WHERE 
    //     (username = ${username} AND code = ${clientid} AND del = 0)
    //     OR (${username} = "admin" AND ${clientid} = "HiWADmy42NB4")
    // LIMIT 1
    //更改后需restart重启项目
4、设备添加的时候增加code重复校验
5、日志配置文件log.php里增加MqttClient
6、MQTT设备增加定时下发功能，可以设置发布的主题。增加下线设备功能。
7、TCP设备定时下发功能完善：定时器销毁时清理变量