node-red-contrib-symi-modbus 1.3.0 → 1.5.4

package/README.md

@@ -14,7 +14,10 @@ Node-RED的Modbus继电器控制节点，支持TCP/串口通信和MQTT集成。
 
 ## 安装
 
-### 通过npm安装
+[![npm version](https://badge.fury.io/js/node-red-contrib-symi-modbus.svg)](https://www.npmjs.com/package/node-red-contrib-symi-modbus)
+[![npm downloads](https://img.shields.io/npm/dm/node-red-contrib-symi-modbus.svg)](https://www.npmjs.com/package/node-red-contrib-symi-modbus)
+
+### 通过npm安装（推荐）
 
 在Node-RED用户目录中运行：
 
@@ -29,6 +32,8 @@ npm install node-red-contrib-symi-modbus
 2. 搜索 `node-red-contrib-symi-modbus`
 3. 点击安装
 
+**已发布到npm：** https://www.npmjs.com/package/node-red-contrib-symi-modbus
+
 ### 本地开发安装
 
 ```bash
@@ -293,8 +298,11 @@ msg.payload = {
 - **MQTT服务器**：选择或添加MQTT服务器配置节点（需与主站节点使用相同配置）
 
 **物理开关面板配置**
+- **面板品牌**：选择开关面板品牌
+  - **亖米（Symi）**：默认品牌，完整实现轻量级协议V0.13
+  - **其他品牌**：预留扩展接口，后续支持更多1-8键开关品牌
 - **开关ID**：物理开关面板的设备地址（0-255，RS-485总线地址）
-- **按钮编号**：物理面板上的按键编号（1-8）
+- **按钮编号**：物理面板上的按键编号（1-8键开关）
 
 **映射到继电器设备**
 - **目标从站地址**：要控制的Modbus继电器设备地址（10-247）
@@ -363,28 +371,30 @@ msg.payload = 0;      // 关
 
 #### 配置映射示例
 
-**示例1：开关ID=0，按钮1 → 继电器10-线圈0**
+**示例1：亖米开关ID=0，按钮1 → 继电器10-线圈0**
 ```
 物理面板配置：
+├─ 面板品牌：亖米（Symi）
 ├─ 开关ID：0（物理面板地址）
 ├─ 按钮编号：1（面板按钮1）
 映射到继电器：
-├─ 目标从站地址：10（Modbus继电器设备10）
-└─ 目标线圈编号：0（继电器通道0）
+├─ 从站地址：10（Modbus继电器设备10）
+└─ 线圈编号：0（继电器通道0）
 
 MQTT主题：
 ├─ 订阅状态：modbus/relay/10/0/state
 └─ 发布命令：modbus/relay/10/0/set
 ```
 
-**示例2：开关ID=5，按钮3 → 继电器11-线圈15**
+**示例2：亖米开关ID=5，按钮3 → 继电器11-线圈15**
 ```
 物理面板配置：
+├─ 面板品牌：亖米（Symi）
 ├─ 开关ID：5（物理面板地址）
 ├─ 按钮编号：3（面板按钮3）
 映射到继电器：
-├─ 目标从站地址：11（Modbus继电器设备11）
-└─ 目标线圈编号：15（继电器通道15）
+├─ 从站地址：11（Modbus继电器设备11）
+└─ 线圈编号：15（继电器通道15）
 
 MQTT主题：
 ├─ 订阅状态：modbus/relay/11/15/state
@@ -444,7 +454,20 @@ MQTT主题：
 #### 配置主站节点
 
 1. 拖拽 **Modbus主站** 节点到流程画布
-2. 双击节点，配置连接参数（TCP或串口）
+2. 双击节点，配置连接参数：
+   
+   **TCP连接：**
+   - 连接类型：TCP/IP
+   - TCP主机：192.168.1.100
+   - TCP端口：502
+   
+   **串口连接：**
+   - 连接类型：串口
+   - 点击"搜索串口"按钮查找可用串口
+   - 从下拉列表中选择串口（自动填入）
+   - 或手动输入：COM1 / /dev/ttyUSB0 / /dev/ttyS1
+   - 波特率：9600（或根据设备要求，8-N-1已固定）
+   
 3. 配置从站设备：
    - 默认已有1个从站（地址10）
    - 点击"添加从站"按钮可添加更多（最多10个）
@@ -460,21 +483,28 @@ MQTT主题：
 
    **RS-485总线连接：**
    - **连接类型**：TCP/IP 或 串口
+   
+   TCP模式：
    - **TCP主机**：192.168.1.200（RS-485转TCP网关地址）
    - **TCP端口**：8888
-   - 或**串口**：/dev/ttyUSB0（直连串口）
-   - **波特率**：9600（协议固定）
+   
+   串口模式：
+   - 点击"搜索串口"按钮查找可用串口
+   - 从下拉列表中选择串口（自动填入）
+   - 或手动输入：COM1 / /dev/ttyUSB0 / /dev/ttyS1
+   - **波特率**：9600（亖米协议固定，8-N-1已自动配置）
    
    **MQTT服务器：**
    - 选择与主站相同的MQTT配置
    
    **开关面板：**
+   - **面板品牌**：亖米（Symi）- 默认，支持1-8键开关
    - **开关ID**：0（物理面板地址，0-255）
    - **按钮编号**：1（面板按钮，1-8）
    
    **映射到继电器：**
-   - **目标从站地址**：10（Modbus继电器）
-   - **目标线圈编号**：0（继电器通道，0-31）
+   - **从站地址**：10（Modbus继电器设备地址）
+   - **线圈编号**：0（继电器通道，0-31）
 
 3. 连接输入节点（可选，用于手动控制）
 4. 连接输出节点（如：debug节点）查看状态
@@ -485,6 +515,7 @@ MQTT主题：
 【完整配置】
 RS-485连接：TCP网关192.168.1.200:8888（或串口/dev/ttyUSB0 9600）
 MQTT服务器：本地MQTT服务器（192.168.1.100:1883）
+面板品牌：亖米（Symi）- 支持1-8键开关
 物理面板：开关ID=0，按钮1
 映射到：继电器10，线圈0
 
@@ -535,16 +566,24 @@ MQTT服务器：本地MQTT服务器（192.168.1.100:1883）
 - 轮询间隔：200ms
 ```
 
-### 串口连接示例
+### 串口连接示例（支持自动搜索）
 
 ```
-配置：
+配置方式1：自动搜索（推荐）
+1. 连接类型：串口
+2. 点击"搜索串口"按钮
+3. 等待系统检测串口（1-2秒）
+4. 从下拉列表中选择串口
+   - 支持：COM1, COM2, COM3... (Windows)
+   - 支持：/dev/ttyUSB0, /dev/ttyS1, /dev/ttyS2... (Linux/macOS)
+   - 显示厂商信息，便于识别设备
+5. 波特率：9600（默认，已自动配置8-N-1）
+
+配置方式2：手动输入
 - 连接类型：串口
-- 串口：COM3（Windows）或 /dev/ttyUSB0（Linux）
+- 串口：COM3（Windows）或 /dev/ttyUSB0 或 /dev/ttyS1（Linux/macOS）
 - 波特率：9600
-- 数据位：8
-- 停止位：1
-- 校验位：无
+- 其他参数：8-N-1（已固定，无需配置）
 ```
 
 ### MQTT集成示例
@@ -679,6 +718,34 @@ Home Assistant结果：
 ✅ **HA重启**：不影响，通过retain消息自动重新发现  
 ✅ **Node-RED重启**：不影响，配置自动加载，连接自动建立
 
+## 智能日志系统
+
+### 日志限流机制
+
+为避免日志过多导致内存占用过大，本节点实现了智能日志限流系统：
+
+**工作原理**：
+- **首次错误**：立即显示完整错误信息
+- **重复错误**：10分钟内不再重复显示相同错误
+- **10分钟后**：再次显示错误，确保持续监控
+- **重新部署**：清除日志记录，允许立即显示错误
+
+**日志提示**：
+```
+[warn] 轮询从站10失败（不影响其他从站）: Timed out [此错误将在10分钟后再次显示]
+```
+
+**好处**：
+- ✅ 避免日志文件快速增长
+- ✅ 防止内存占用过大
+- ✅ 保持错误监控能力
+- ✅ 不影响正常功能
+
+**适用场景**：
+- Modbus设备未连接时的超时错误
+- MQTT服务器未配置时的连接错误
+- 其他周期性重复的错误
+
 ## 可靠性保证
 
 ### 消息队列和并发处理
@@ -762,6 +829,19 @@ Home Assistant结果：
 
 ### 轻量级协议（从站节点，V0.13）
 
+#### 品牌支持
+
+- **亖米（Symi）**：默认品牌，完整实现轻量级协议V0.13
+  - 支持1-8键开关面板
+  - RS-485总线通信（TCP网关或串口）
+  - 完整的按键监听和指示灯控制
+  - CRC8校验保证数据完整性
+- **其他品牌**：预留扩展接口
+  - 可通过修改协议适配其他品牌1-8键开关
+  - 后续版本将陆续增加更多品牌支持
+
+#### 亖米协议规格
+
 - **物理层**：RS-485总线
 - **串口参数**：波特率9600，1起始位，8数据位，1停止位，无校验位
 - **帧格式**：`[0x7E][数据][CRC8][0x7D]`
@@ -854,10 +934,18 @@ node-red
 - 确认设备已启动Modbus TCP服务
 
 **串口连接失败**：
+- **使用串口搜索功能**：点击"搜索串口"按钮自动检测可用串口
 - 确认串口名称正确（Windows设备管理器或Linux `ls /dev/tty*`）
-- 检查串口权限（Linux需要：`sudo usermod -a -G dialout $USER`）
+- 检查串口权限（Linux需要：`sudo usermod -a -G dialout $USER`，然后重新登录）
 - 确认波特率等参数与设备匹配
 - 确保串口没有被其他程序占用
+- 重新拔插USB串口适配器
+
+**串口列表为空**：
+- 确认系统已正确安装USB驱动
+- Windows：检查设备管理器中的"端口(COM和LPT)"
+- Linux/macOS：运行 `ls /dev/tty*` 查看串口设备（/dev/ttyUSB0、/dev/ttyS1等）
+- 可以手动输入串口路径，无需依赖自动搜索
 
 ### 轮询错误
 
@@ -867,6 +955,12 @@ node-red
 4. 适当增加轮询间隔（快速轮询可能导致超时）
 5. 查看Node-RED日志获取详细错误信息
 
+**关于日志输出**：
+- 本节点使用智能日志限流机制，相同的错误每10分钟只显示一次
+- 重新部署流程时会清除日志记录，允许再次显示错误
+- 这样可以避免日志过多导致内存占用过大
+- 如果看到"[此错误将在10分钟后再次显示]"提示，说明日志限流正在工作
+
 ### MQTT问题
 
 1. 确认MQTT Broker地址正确且可访问
@@ -909,12 +1003,80 @@ python -m pymodbus.server tcp --port 502
 
 ## 更新日志
 
-### v1.3.0 (2025-10-17) - 轻量级协议完整实现
+### v1.5.4 (2025-10-18) - MQTT错误日志优化 ✅最新版本
+- ✅ **MQTT错误日志限流**：
+  - MQTT连接错误也采用10分钟限流机制
+  - 避免MQTT未配置时频繁输出错误日志（每几秒一次）
+  - 与Modbus错误日志统一管理，保持日志整洁
+  - 重新部署时清除MQTT错误日志记录，允许再次显示
+- ✅ **日志系统完善**：
+  - 所有错误日志都采用10分钟限流机制
+  - 提示信息统一："[此错误将在10分钟后再次显示]"
+  - 不影响功能正常运行，只是减少重复日志输出
+- ✅ **默认配置确认**：
+  - RS-485串口参数默认9600-8-N-1（符合亖米协议）
+  - 面板品牌默认SYMI，支持1-8键开关
+  - 所有默认参数都已正确配置并持久化
+- ✅ **完整测试验证**：
+  - 日志限流机制测试通过
+  - Node-RED持久稳定运行
+  - 配置持久化保存正常
+
+### v1.5.3 (2025-10-18) - 界面优化和智能日志系统
+- ✅ **串口选择界面优化**：
+  - 输入框和下拉框一体化，不再单独占用一行
+  - 点击搜索后，下拉框替换输入框显示检测到的串口
+  - 选择串口后自动填充并恢复输入框显示
+  - 完美支持所有类型串口（COM1、/dev/ttyUSB0、/dev/ttyS1等）
+- ✅ **智能日志限流系统**：
+  - Modbus超时错误每10分钟只提示一次，避免日志过多
+  - 重新部署时清除日志记录，允许再次显示错误
+  - 减少日志输出，防止内存占用过大
+  - 保持功能正常，不影响错误监控
+- ✅ **界面布局完善**：
+  - 主站节点：Grid布局，从站地址/线圈范围/轮询间隔完美对齐
+  - 标签在输入框上方，清晰的垂直布局
+  - 移除所有emoji图标，保持专业简洁
+  - 渐变配色和阴影效果，现代化视觉
+- ✅ **错误处理优化**：
+  - RS-485连接添加配置验证，防止无效配置重试
+  - 串口未配置时提供明确提示
+  - 配置错误时不重试，避免无用日志
+- ✅ **完整测试验证**：
+  - Node-RED v4.0.8 / Node.js v23.1.0测试通过
+  - 日志输出优化，10分钟内不重复显示相同错误
+  - 界面布局完美，串口选择流畅
+  
+### v1.5.0 (2025-10-18) - 串口搜索和完整测试
+- ✅ **串口自动搜索**：主站和从站节点支持一键搜索本机可用串口
+  - 点击"搜索串口"按钮自动检测系统串口
+  - 双击列表项自动填入串口名称
+  - 显示串口厂商信息，便于识别
+  - 兼容serialport v9和v10+
+- ✅ **串口连接修复**：优化串口列表API，使用modbus-serial自带的serialport模块
+- ✅ **代码规范检查**：符合Node-RED开发标准
+- ✅ **完整测试验证**：Node-RED启动正常，节点加载成功
+- ✅ **文档完善**：更新所有配置说明和使用指南
+
+### v1.4.0 (2025-10-18) - 界面优化和品牌扩展
+- ✅ **品牌选择功能**：从站开关节点增加品牌选择（默认亖米，预留其他品牌扩展）
+- ✅ **界面布局优化**：
+  - 主站节点：从站地址/线圈标签紧贴输入框，更清晰的布局
+  - 从站节点：所有标签优化对齐，提升配置体验
+- ✅ **全面美化**：
+  - 统一间距和对齐方式
+  - 优化配置区域分组（颜色、边框、圆角）
+  - 改进提示信息样式（蓝色、黄色、绿色主题）
+  - 增强按钮视觉效果（悬停、禁用状态）
+- ✅ **代码规范检查**：确保符合Node-RED开发标准
+- ✅ **本地测试验证**：安装测试通过，节点加载正常
+
+### v1.3.0 (2025-10-17) - 轻量级协议完整实现 ✅已发布到npm
 - ✅ **完整协议实现**：实现轻量级智能家居通信协议（V0.13）
 - ✅ **协议解析**：完整的帧解析、CRC8校验、按键事件检测
 - ✅ **协议构建**：单灯控制、多灯控制、查询指令完整实现
 - ✅ **按键监听**：实时监听RS-485总线上的按键按下事件
-- ✅ **指示灯控制**：通过轻量级协议同步控制物理面板指示灯
+- ✅ **指示灯控制**：通过协议同步控制物理面板指示灯
 - ✅ **完整三向同步**：
   - 物理按键 → RS-485协议 → MQTT命令 → 继电器动作
   - 继电器状态 → MQTT状态 → RS-485协议 → 指示灯同步
@@ -924,6 +1086,8 @@ python -m pymodbus.server tcp --port 502
 - ✅ **CRC8校验**：完整的CRC8算法实现，确保数据完整性
 - ✅ **自动应答**：接收到按键事件后自动发送MQTT命令
 - ✅ **状态同步**：MQTT状态变化自动发送RS-485控制指令
+- ✅ **已发布npm**：https://www.npmjs.com/package/node-red-contrib-symi-modbus
+- ✅ **npm安装验证**：从npm安装测试通过
 
 ### v1.2.0 (2025-10-17) - 完整RS-485总线支持
 - ✅ **新增RS-485总线连接**：从站节点支持连接物理开关面板的RS-485总线
@@ -991,9 +1155,10 @@ MIT License - 详见 [LICENSE](LICENSE) 文件
 ## 支持
 
 如有问题或建议：
-- 📧 提交Issue：[GitHub Issues]
+- 📧 提交Issue：https://github.com/symi-daguo/node-red-contrib-symi-modbus/issues
 - 📦 NPM包：https://www.npmjs.com/package/node-red-contrib-symi-modbus
-- 🌐 Node-RED Flow Library：[待提交]
+- 👤 NPM作者：https://www.npmjs.com/~symi-daguo
+- 🌐 Node-RED Flow Library：即将提交
 
 ## 致谢