hybridgroup.gobot/platforms/mqtt/README.md

75 lines
1.8 KiB
Markdown
Raw Normal View History

2014-11-29 07:34:42 +08:00
# MQTT
2014-11-05 00:41:56 +08:00
2016-02-10 06:52:59 +08:00
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.
2014-11-05 00:41:56 +08:00
2016-02-10 06:52:59 +08:00
This repository contains the Gobot adaptor/drivers 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/
2014-11-05 00:41:56 +08:00
2014-11-29 07:34:42 +08:00
## How to Install
Install running:
2014-11-05 00:41:56 +08:00
```
go get -d -u github.com/hybridgroup/gobot/... && go install github.com/hybridgroup/gobot/platforms/mqtt
2014-11-05 00:41:56 +08:00
```
2014-11-29 07:34:42 +08:00
## How to Use
2014-11-05 00:41:56 +08:00
2014-11-29 07:34:42 +08:00
Before running the example, make sure you have an MQTT message broker running somewhere you can connect to
2014-11-05 00:41:56 +08:00
```go
package main
import (
"github.com/hybridgroup/gobot"
"github.com/hybridgroup/gobot/platforms/mqtt"
"fmt"
"time"
)
func main() {
gbot := gobot.NewGobot()
mqttAdaptor := mqtt.NewMqttAdaptor("server", "tcp://0.0.0.0:1883", "pinger")
2014-11-05 00:41:56 +08:00
work := func() {
mqttAdaptor.On("hello", func(data []byte) {
2014-11-05 00:41:56 +08:00
fmt.Println("hello")
})
mqttAdaptor.On("hola", func(data []byte) {
2014-11-05 00:41:56 +08:00
fmt.Println("hola")
})
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,
)
gbot.AddRobot(robot)
gbot.Start()
}
```
## Supported Features
* Publish messages
* Respond to incoming message events
## Contributing
2016-02-10 06:52:59 +08:00
For our contribution guidelines, please go to https://github.com/hybridgroup/gobot/blob/master/CONTRIBUTING.md
2014-11-05 00:41:56 +08:00
## License
2016-02-10 06:52:59 +08:00
Copyright (c) 2013-2016 The Hybrid Group. Licensed under the Apache 2.0 license.