Adding some comments and README

platforms/mqtt/README.md

@@ -0,0 +1,87 @@
+# Gobot for MQTT
+
+Gobot (http://gobot.io/) is a library for robotics and physical computing using Go
+
+This repository contains the Gobot adaptor for the MQTT machine to machine message broker (http://getpebble.com/).
+
+## Installing
+
+* Install running:
+```
+go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/gobot/platforms/mqtt
+```
+
+## Using
+
+* Before running the example, make sure you have an MQTT message broker running somewhere you can connect to
+
+```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")
+
+  work := func() {
+    mqttAdaptor.On("hello", func(data interface{}) {
+      fmt.Println("hello")
+    })
+    mqttAdaptor.On("hola", func(data interface{}) {
+      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
+
+## Documentation
+
+We're busy adding documentation to our web site at http://gobot.io/ please check there as we continue to work on Gobot
+
+Thank you!
+
+## Contributing
+
+* All patches must be provided under the Apache 2.0 License
+* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
+* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
+* We will look at the patch, test it out, and give you feedback.
+* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
+* Take care to maintain the existing coding style.
+* Add unit tests for any new or changed functionality
+* All pull requests should be "fast forward"
+* If there are commits after yours use “git rebase -i <new_head_branch>”
+* If you have local changes you may need to use “git stash”
+* For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
+
+## License
+
+Copyright (c) 2013-2014 The Hybrid Group. Licensed under the Apache 2.0 license.

platforms/mqtt/mqtt_adaptor.go

@@ -49,6 +49,7 @@ func (a *MqttAdaptor) Finalize() bool {
 	return true
 }
 
+// Publish a message under a specific topic
 func (a *MqttAdaptor) Publish(topic string, message []byte) bool {
 	if a.client == nil {
 		return false
@@ -58,6 +59,7 @@ func (a *MqttAdaptor) Publish(topic string, message []byte) bool {
 	return true
 }
 
+// Subscribe to a topic, and then call the message handler function when data is received
 func (a *MqttAdaptor) On(event string, f func(s interface{})) bool {
 	if a.client == nil {
 		return false