Ruby-MQTT项目技术文档

1. 安装指南

要安装ruby-mqtt库，您可以从Rubygems获取最新稳定版本。在命令行中运行以下命令：

gem install mqtt

如果您想使用GitHub上的开发快照，您需要使用Bundler。在您的Gemfile中添加以下内容：

gem 'mqtt', :github => 'njh/ruby-mqtt'

然后执行bundle install来安装。

2. 项目使用说明

ruby-mqtt是一个纯Ruby实现的MQTT协议的gem库，用于发布/订阅消息传递。它还包括一个用于解析和生成MQTT-SN数据包的类。

以下是一些基本的使用示例：

发布消息

require 'mqtt'

MQTT::Client.connect('test.mosquitto.org') do |c|
  c.publish('test', 'message')
end

订阅主题

require 'mqtt'

MQTT::Client.connect('test.mosquitto.org') do |c|
  c.get('test') do |topic,message|
    puts "#{topic}: #{message}"
  end
end

3. 项目API使用文档

连接到MQTT服务器

创建新的客户端连接可以通过传递MQTT URI、主机和端口，或者通过传递属性哈希来实现。

client = MQTT::Client.connect('mqtt://myserver.example.com')
# 或者使用更详细配置
client = MQTT::Client.connect(:host => 'myserver.example.com', :port => 1883 ...)

要启用TLS/SSL，请传递:ssl => true。

client = MQTT::Client.connect(
  :host => 'test.mosquitto.org',
  :port => 8883,
  :ssl => true
)

发布消息

使用publish方法将消息发送到主题：

client.publish(topic, payload, retain=false)

订阅主题

使用subscribe方法向MQTT服务器发送订阅请求：

client.subscribe( 'topic1' )
# 或者订阅多个主题
client.subscribe( 'topic1', 'topic2' )

接收消息

使用get方法接收消息。该方法将阻塞，直到有消息可用：

topic,message = client.get

或者给get方法提供一个块，该块将为每个接收到的消息执行，并无限循环：

client.get do |topic,message|
  # 对每个接收到的消息执行块
end

解析和序列化数据包

该库提供了一个低级别的API用于解析和序列化MQTT和MQTT-SN数据包，可用于构建自定义的客户端和服务器。

packet_obj = MQTT::Packet.parse(binary_packet)
ios << MQTT::Packet::Puback(:id => 20)

4. 项目安装方式

请参考“安装指南”部分的内容进行项目安装。