mqtt

README

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/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/

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

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(data []byte) {
      fmt.Println("hello")
    })
    mqttAdaptor.On("hola", func(data []byte) {
      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,
  )

  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.

Documentation

Overview

Package mqtt provides Gobot adaptor for the mqtt message service.

Installing:

go get gobot.io/x/gobot/platforms/mqtt

For further information refer to mqtt README: https://github.com/hybridgroup/gobot/blob/master/platforms/mqtt/README.md

Index

• type Adaptor
  • func NewAdaptor(host string, clientID string) *Adaptor
  • func NewAdaptorWithAuth(host, clientID, username, password string) *Adaptor
  • func (a *Adaptor) Connect() (err error)
  • func (a *Adaptor) Disconnect() (err error)
  • func (a *Adaptor) Finalize() (err error)
  • func (a *Adaptor) Name() string
  • func (a *Adaptor) On(event string, f func(s []byte)) bool
  • func (a *Adaptor) Publish(topic string, message []byte) bool
  • func (a *Adaptor) SetName(n string)

Types

type Adaptor

type Adaptor struct {
	Host string
	// contains filtered or unexported fields
}

Adaptor is the Gobot Adaptor for MQTT

func NewAdaptor

func NewAdaptor(host string, clientID string) *Adaptor

NewAdaptor creates a new mqtt adaptor with specified host and client id

func NewAdaptorWithAuth

func NewAdaptorWithAuth(host, clientID, username, password string) *Adaptor

NewAdaptorWithAuth creates a new mqtt adaptor with specified host, client id, username, and password.

func (*Adaptor) Connect

func (a *Adaptor) Connect() (err error)

Connect returns true if connection to mqtt is established

func (*Adaptor) Disconnect

func (a *Adaptor) Disconnect() (err error)

Disconnect returns true if connection to mqtt is closed

func (*Adaptor) Finalize

func (a *Adaptor) Finalize() (err error)

Finalize returns true if connection to mqtt is finalized successfully

func (*Adaptor) Name

func (a *Adaptor) Name() string

Name returns the MQTT Adaptor's name

func (*Adaptor) On

func (a *Adaptor) On(event string, f func(s []byte)) bool

On subscribes to a topic, and then calls the message handler function when data is received

func (*Adaptor) Publish

func (a *Adaptor) Publish(topic string, message []byte) bool

Publish a message under a specific topic

func (*Adaptor) SetName

func (a *Adaptor) SetName(n string)

SetName sets the MQTT Adaptor's name