Go to file
Adrian Zankich d8be3d11d2 WIP firmata refactor 2014-07-15 09:35:18 -07:00
api Move robeaux into it's own package 2014-07-10 11:35:00 -07:00
examples Fix error in example 2014-07-10 19:28:00 -07:00
gobot remove broken parentheses 2014-07-15 00:32:33 +09:00
platforms WIP firmata refactor 2014-07-15 09:35:18 -07:00
.gitignore Move robeaux into it's own package 2014-07-10 11:35:00 -07:00
.travis.yml Update .travis.yml 2014-06-14 18:53:21 -07:00
CHANGELOG.md Update CHANGELOG.md 2014-07-12 09:53:05 -07:00
LICENSE Initial commit 2013-10-21 14:23:24 -07:00
Makefile Move robeaux into it's own package 2014-07-10 11:35:00 -07:00
README.md Update READMEs 2014-07-10 17:02:00 -07:00
adaptor.go Update firmata platform and adaptor interface 2014-07-03 19:52:31 -07:00
connection.go Clean up devices and connections type 2014-07-09 09:38:43 -07:00
device.go Clean up devices and connections type 2014-07-09 09:38:43 -07:00
doc.go started cleaning up the code API 2014-04-29 05:36:25 -07:00
driver.go Fix neurosky runtime error 2014-07-13 20:44:28 -07:00
event.go Use new Event type for events 2014-06-11 11:37:20 -07:00
gobot.go Clean up devices and connections type 2014-07-09 09:38:43 -07:00
gobot_test.go Update gobot tests 2014-07-10 11:14:08 -07:00
robot.go Clean up devices and connections type 2014-07-09 09:38:43 -07:00
test_helper.go Update gobot tests 2014-07-10 11:14:08 -07:00
utils.go Remove unused util functions 2014-06-15 17:32:19 -07:00
utils_test.go Remove unused util functions 2014-06-15 17:32:19 -07:00
version.go Bump version to 0.6.1 2014-07-12 09:50:06 -07:00

README.md

Gobot

http://gobot.io/

Gobot 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 Ruby or Javascript on robots? Check out our sister projects Artoo (http://artoo.io) and Cylon.js (http://cylonjs.com/)

Build Status Coverage Status

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
    • Digital Sensor
    • LED
    • 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
    • Wii Nunchuck Controller

More platforms and drivers are coming soon...

Getting Started

Install Gobot with: go get -u github.com/hybridgroup/gobot

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 AngularJS 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!

Contributing

  • All active development is in the dev branch. New or updated features must be added to the dev branch. Hotfixes will be considered on the master branch in situations where it does not alter behaviour or features, only fixes a bug.
  • 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.
  • golint and go fmt your code.
  • 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 which is an awesome (and free) book on git

License

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