RModBus 技术文档

1. 安装指南

1.1 使用 gem 安装

要安装 RModBus，您可以使用以下命令：

gem install rmodbus

1.2 使用 Bundler 安装

如果您使用 Bundler 管理依赖项，可以在 Gemfile 中添加以下内容：

gem 'rmodbus'

然后运行 bundle install 来安装依赖。

1.3 安装额外依赖

如果您需要使用 ModBus 的串行通信功能，还需要安装 serialport gem：

gem 'serialport'

如果您使用的是 Ruby 2.2 及以上版本，并且需要使用 ModBus::TCPServer 或 ModBus::RTUViaTCPServer，还需要安装 gserver gem：

gem 'gserver'

请注意，GServer 已被弃用，项目正在寻找更好的解决方案。欢迎贡献代码！

2. 项目的使用说明

2.1 基本功能

RModBus 是一个纯 Ruby 实现的 ModBus 协议库，支持以下功能：

• 支持 Ruby 2.2、2.3 和 JRuby（不支持串行 ModBus RTU）。
• 支持 TCP、RTU、RTU over TCP 协议。
• 支持客户端（主站）和服务器（从站）。
• 支持 16 位、32 位和浮点寄存器。

2.2 支持的 ModBus 功能码

RModBus 支持以下 ModBus 功能码：

• 读线圈 (0x01)
• 读离散输入 (0x02)
• 读保持寄存器 (0x03)
• 读输入寄存器 (0x04)
• 写单个线圈 (0x05)
• 写单个寄存器 (0x06)
• 写多个线圈 (0x0F)
• 写多个寄存器 (0x10)
• 掩码写寄存器 (0x16)

3. 项目 API 使用文档

3.1 创建 TCP 客户端

以下是一个简单的示例，展示如何创建一个 ModBus TCP 客户端并读取保持寄存器：

require 'rmodbus'

ModBus::TCPClient.new('127.0.0.1', 8502) do |cl|
  cl.with_slave(1) do |slave|
    # 读取地址为 16 的保持寄存器
    value = slave.holding_registers[16]
    puts "Register 16: #{value}"

    # 写入地址为 16 的保持寄存器
    slave.holding_registers[16] = 123

    # 读取地址为 16 到 20 的保持寄存器
    values = slave.holding_registers[16..20]
    puts "Registers 16-20: #{values}"

    # 写入地址为 16 到 20 的保持寄存器
    slave.holding_registers[16..20] = [1, 2, 3, 4, 5]
  end
end

3.2 其他 API 方法

• holding_registers[address]：读取或写入单个保持寄存器。
• holding_registers[start_address..end_address]：读取或写入多个保持寄存器。
• coils[address]：读取或写入单个线圈。
• coils[start_address..end_address]：读取或写入多个线圈。

4. 项目安装方式

4.1 通过 gem 安装

gem install rmodbus

4.2 通过 Bundler 安装

在 Gemfile 中添加：

gem 'rmodbus'

然后运行 bundle install。

4.3 安装额外依赖

• 如果需要使用串行通信，安装 serialport gem。
• 如果使用 Ruby 2.2 及以上版本，并且需要使用 ModBus::TCPServer 或 ModBus::RTUViaTCPServer，安装 gserver gem。

5. 版本控制

RModBus 遵循语义化版本控制（Semantic Versioning）规范：

• MAJOR 版本：当有不兼容的 API 更改时。
• MINOR 版本：当以向后兼容的方式添加功能时。
• PATCH 版本：当进行向后兼容的错误修复时。

6. 贡献指南

请参阅 CONTRIBUTING.md 文件了解如何为项目贡献代码。

7. 许可证

RModBus 使用 BSD-3-Clause 许可证。

8. 致谢

• Aleksey Timin：RModBus 的原作者。