Go to file
deadprogram c9fa6ce995 Robeaux is now based on React.js 2015-06-29 20:14:16 -07:00
api Add SSE test coverage 2015-04-07 16:04:40 -07:00
examples Update mqtt package for latest paho mqtt api compatibility 2015-04-06 15:35:11 -07:00
gobot Add optional package name parameter 2014-12-24 11:58:41 -08:00
platforms platforms/leap: use golang.org/x/net/websocket 2015-04-16 11:08:50 +02:00
scripts Fix goveralls parsing error 2014-12-19 11:26:44 -08:00
sysfs go lint and documentation tweaks for the sysfs package 2014-12-31 06:12:25 -08:00
.gitignore First pass at adding some documentation 2014-08-13 10:22:58 -06:00
.travis.yml Update travis build script 2014-12-16 15:59:06 -08:00
CHANGELOG.md Update CHANGELOG.md 2014-12-28 08:20:16 -08:00
CONTRIBUTING.md Add contrbution guidelines and code of conduct, via io.js and Rust respectively 2015-06-22 18:13:07 -07:00
LICENSE Update to LICENSE year 2015-05-01 11:17:44 -07:00
Makefile update robeaux to 5d46e912ee 2014-12-24 12:27:57 -08:00
README.md Robeaux is now based on React.js 2015-06-29 20:14:16 -07:00
adaptor.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
commander.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
commander_test.go Increase gobot package test coverage 2014-11-30 00:19:53 -08:00
connection.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
device.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
doc.go Update gobot package docs 2014-11-13 11:06:57 -08:00
driver.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
event.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
eventer.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
eventer_test.go Increase gobot package test coverage 2014-11-30 00:19:53 -08:00
examples_test.go Update utils docs 2014-11-12 15:01:06 -08:00
gobot.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
gobot_test.go Increase gobot package test coverage 2014-11-30 00:19:53 -08:00
helpers_test.go Add SSE test coverage 2015-04-07 16:04:40 -07:00
robot.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
utils.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
utils_test.go Increase gobot package test coverage 2014-11-30 00:19:53 -08:00
version.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00

README.md

Gobot

Gobot (http://gobot.io/) is a framework using the Go programming language (http://golang.org/) for robotics, physical computing, and the Internet of Things.

It provides a simple, yet powerful way to create solutions that incorporate multiple, different hardware devices at the same time.

Want to use Javascript robotics? Check out our sister project Cylon.js (http://cylonjs.com/)

Want to use Ruby on robots? Check out our sister project Artoo (http://artoo.io)

GoDoc Build Status Coverage Status

Getting Started

Get the Gobot source with: go get -d -u github.com/hybridgroup/gobot/...

Examples

Gobot with Arduino

package main

import (
	"time"

	"github.com/hybridgroup/gobot"
	"github.com/hybridgroup/gobot/platforms/firmata"
	"github.com/hybridgroup/gobot/platforms/gpio"
)

func main() {
	gbot := gobot.NewGobot()

	firmataAdaptor := firmata.NewFirmataAdaptor("arduino", "/dev/ttyACM0")
	led := gpio.NewLedDriver(firmataAdaptor, "led", "13")

	work := func() {
		gobot.Every(1*time.Second, func() {
			led.Toggle()
		})
	}

	robot := gobot.NewRobot("bot",
		[]gobot.Connection{firmataAdaptor},
		[]gobot.Device{led},
		work,
	)

	gbot.AddRobot(robot)

	gbot.Start()
}

Gobot with Sphero

package main

import (
	"fmt"
	"time"

	"github.com/hybridgroup/gobot"
	"github.com/hybridgroup/gobot/platforms/sphero"
)

func main() {
	gbot := gobot.NewGobot()

	adaptor := sphero.NewSpheroAdaptor("sphero", "/dev/rfcomm0")
	driver := sphero.NewSpheroDriver(adaptor, "sphero")

	work := func() {
		gobot.Every(3*time.Second, func() {
			driver.Roll(30, uint16(gobot.Rand(360)))
		})
	}

	robot := gobot.NewRobot("sphero",
		[]gobot.Connection{adaptor},
		[]gobot.Device{driver},
		work,
	)

	gbot.AddRobot(robot)

	gbot.Start()
}

Hardware Support

Gobot has a extensible system for connecting to hardware devices. The following robotics and physical computing platforms are currently supported:

Support for many devices that use General Purpose Input/Output (GPIO) have a shared set of drivers provided using the cylon-gpio module:

  • GPIO <=> Drivers
    • Analog Sensor
    • Button
    • Direct Pin
    • Digital Sensor
    • Direct Pin
    • LED
    • Makey Button
    • Motor
    • Servo

Support for devices that use Inter-Integrated Circuit (I2C) have a shared set of drivers provided using the gobot-i2c module:

  • I2C <=> Drivers
    • BlinkM
    • HMC6352
    • LIDAR-Lite
    • MPL1150A2
    • MPU6050
    • Wii Nunchuck Controller

More platforms and drivers are coming soon...

API:

Gobot includes a RESTful API to query the status of any robot running within a group, including the connection and device status, and execute device commands.

To activate the API, require the github.com/hybridgroup/gobot/api package and instantiate the API like this:

  gbot := gobot.NewGobot()
  api.NewAPI(gbot).Start()

You can also specify the api host and port, and turn on authentication:

  gbot := gobot.NewGobot()
  server := api.NewAPI(gbot)
  server.Port = "4000"
  server.Username = "Gort"
  server.Password = "klaatu"
  server.Start()

You may access the robeaux React.js interface with Gobot by navigating to http://localhost:3000/index.html.

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!

Need help?

Contributing

For our contribution guidelines, please go to https://github.com/hybridgroup/gobot/blob/master/CONTRIBUTING.md .

License

Copyright (c) 2013-2015 The Hybrid Group. Licensed under the Apache 2.0 license.