mruby-mqtt

KO | EN

gitlite — search

#javascript #ai #llm #android #machine-learning #rust #deep-learning #nodejs #windows #awesome #vue #pytorch #openai #open-source

(★ 8)

MQTT protocol library.

mruby-mqtt 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#mruby-mqtt   [![Build Status](https://travis-ci.org/hiroeorz/mruby-mqtt.svg?branch=master)](https://travis-ci.org/hiroeorz/mruby-mqtt)

MQTT protocol library.

MQTT is a lightweight M2M,IoT protocol publish/subscribe messaging.
The mruby-mqtt is implemented as wrapper of [Paho C library](http://www.eclipse.org/paho/)

##Installing

Write in /mruby/build_config.rb

```ruby
MRuby::Build.new do |conf|

conf.gem :github => 'ksss/mruby-singleton', :branch => 'master'
  conf.gem :github => 'hiroeorz/mruby-mqtt', :branch => 'master'

conf.linker do |linker|
    #linker.link_options = "%{flags} -o %{outfile} %{objs} %{libs}"
    linker.link_options = "%{flags} -o %{outfile} %{objs} %{libs} -lpthread -Wl -lm"
  end

end
```

##Examples

###Setup

```ruby
MQTTClient.connect("tcp://test.mosquitto.org:1883", "mruby") do |c|
  c.clean_session = false   # default: true
  c.reconnect_interval = 10 # default: 5

c.on_connect   = -> { c.subscribe("/temp/shimane")}
  c.on_subscribe = -> { puts "subscribe success"}
  c.on_publish   = -> { puts "publish success"}
end
```

The default QoS of subscribe request is 0.

You can add QoS value as labeled arguments.

```ruby
  c.subscribe("/temp/shimane", qos:1)
```

callbacks

- on_connect = -> { ... }
- on_subscribe = -> { ... }
- on_publish = -> { ... }
- on_disconnect = -> { ... }
- on_connlost = -> { ... }          # default reconnect after @reconnect_interval
- on_connect_failure = -> { ... }   # default reconnect after @reconnect_interval
- on_subscribe_failure = -> { ... }
- on_connlost = -> { ... }
- on_message = -> (message) { ... }

params

- clean_session: true or false
- reconnect_interval: integer

on_message callback receive one argument, that is instance of MQTTMessage.

```ruby
MQTTClient.connect("tcp://test.mosquitto.org:1883", "mruby") do |c|

...

c.on_message = -> (message) {
    puts message.topic
    puts message.payload
  }
end
```

###Publish

```ruby
mqtt = MQTTClient.instance
mqtt.publish("/mytopic", "mydata")
```
- The default value of QoS is 0.
- The default value of Reain is false.

You can add QoS or Retain value as labeled arguments.

```ruby
mqtt = MQTTClient.instance
mqtt.publish("/mytopic", "mydata", qos:1, retain:true)
```

###Disconnect

```ruby
mqtt = MQTTClient.instance
mqtt.on_disconnect = -> { puts "disconnected." }
mqtt.disconnect
```

##Limitations

Only one MQTTClient instance created per one os process. This means that only one connection created to the broker per os process.

```ruby
m1 = MQTTClient.connect("tcp://test.mosquitto.org:1883", "mruby")
 #=> #<MQTTClient:0x7fbbd981c8b0>

m2 = MQTTClient.connect("tcp://test.mosquitto.org:1883", "mruby")
Error: MQTT Already connected (MQTTAlreadyConnectedError)

m1.disconnect #=> true

m2 = MQTTClient.connect("tcp://test.mosquitto.org:1883", "mruby") 
 #=> #<MQTTClient:0x7fbbd981c8b0>
```

##License
See source code files.

mruby-mqtt

mruby-mqtt 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

mruby-mqtt

mruby-mqtt 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README