@airiot/modbus

AIRIOT Modbus 驱动安装程序 - 自动下载、配置和运行 Modbus 驱动

快速开始

$3

``bash


自动安装并运行驱动

npx @airiot/modbus

传递数据配置

npx @airiot/modbus -d '{"id":"设备ID","name":"modbus","groupId":"分组ID","driverType":"modbus","runMode":"one","device":{"settings":{"interval":60,"ip":"设备IP","port":502,"unit":1}},"autoReload":{"disable":true},"autoUpdateConfig":true,"tables":[{"id":"modbus2","device":{"settings":{"autoAddr":true,"interval":5,"ip":"设备IP"},"tags":[{"area":3,"dataType":"Int32BE","id":"p1","name":"p1","offset":1,"policy":"save"}],"commands":[{"name":"cmd1","ops":[{"area":"coil","dataType":"Boolean","offset":1,"param":"cmd1"}]}]},"devices":[{"id":"modbus21","name":"modbus21","settings":{"unit":7}}]}]}'

强制更新到最新版本

npx @airiot/modbus --update
`

$3

`bash


全局安装

npm install -g @airiot/modbus

运行驱动

@airiot/modbus
`

命令参数

| 参数 | 简写 | 说明 |
|------|------|------|
| --data | -d | 传递 data.json 配置数据 |
| --update | -u | 强制重新下载并更新驱动 |

运行方式

驱动会根据平台自动选择运行方式：

- macOS/Windows: 使用 PM2 运行二进制文件
- Linux: 使用 Docker 运行容器

$3

macOS/Windows:
`bash
npm install -g pm2
`

Linux:
`bash


安装 Docker


curl -fsSL https://get.docker.com | sh
`

配置文件

驱动启动时会自动生成 etc/config.yaml 配置文件：

`yaml
http:
host: 0.0.0.0
port: 8080

driverGrpc:

mq:
type: local
local:
logPublish: true
logConsume: true
showPayload: false

driver:
id: modbus
name: Modbus-TCP
timeout: 10
idle: 30
`

目录结构

`
airiot/lib/driver/modbus/
├── .version # 当前安装版本
├── archive/ # 下载缓存
└── extracted/ # 驱动文件
├── etc/
│ └── config.yaml
└── modbus # 二进制文件
`

故障排除

$3

如果 8080 端口被占用，驱动会自动使用下一个可用端口（8081、8082...）。

$3

`bash


查看 PM2 运行状态

pm2 list

查看 PM2 日志

pm2 logs modbus-driver

停止驱动

pm2 stop modbus-driver

重启驱动

pm2 restart modbus-driver

删除驱动

pm2 delete modbus-driver
`

$3

`bash


查看运行中的容器

docker ps

查看容器日志

docker logs modbus-driver

停止容器

docker stop modbus-driver

删除容器

docker rm modbus-driver
`

版本管理

驱动会自动检测版本更新：

- 首次运行：自动下载对应平台版本
- 版本相同：使用已缓存的文件
- 版本不同：提示使用 --update` 参数升级

许可证

MIT

支持

- 问题反馈: GitHub Issues
- 官方文档: https://docs.airiot.link