hybridgroup.gobot/platforms/mqtt/README.md

71 lines
1.7 KiB
Markdown

# MQTT
MQTT is an Internet of Things connectivity protocol featuring a lightweight publish/subscribe messaging transport. It is useful for its small code footprint and minimal network bandwidth usage.
This repository contains the Gobot adaptor/driver to connect to MQTT servers. It uses the Paho MQTT Golang client package (https://eclipse.org/paho/) created and maintained by the Eclipse Foundation (https://github.com/eclipse) thank you!
For more info about the MQTT machine to machine messaging standard, go to http://mqtt.org/
## How to Install
Install running:
```
go get -d -u gobot.io/x/gobot/... && go install gobot.io/x/gobot/platforms/mqtt
```
## How to Use
Before running the example, make sure you have an MQTT message broker running somewhere you can connect to
```go
package main
import (
"gobot.io/x/gobot"
"gobot.io/x/gobot/platforms/mqtt"
"fmt"
"time"
)
func main() {
mqttAdaptor := mqtt.NewAdaptor("tcp://0.0.0.0:1883", "pinger")
work := func() {
mqttAdaptor.On("hello", func(msg mqtt.Message) {
fmt.Println(msg)
})
mqttAdaptor.On("hola", func(msg mqtt.Message) {
fmt.Println(msg)
})
data := []byte("o")
gobot.Every(1*time.Second, func() {
mqttAdaptor.Publish("hello", data)
})
gobot.Every(5*time.Second, func() {
mqttAdaptor.Publish("hola", data)
})
}
robot := gobot.NewRobot("mqttBot",
[]gobot.Connection{mqttAdaptor},
work,
)
robot.Start()
}
```
## Supported Features
* Publish messages
* Respond to incoming message events
## Contributing
For our contribution guidelines, please go to https://gobot.io/x/gobot/blob/master/CONTRIBUTING.md
## License
Copyright (c) 2013-2017 The Hybrid Group. Licensed under the Apache 2.0 license.