Go to file
devfubar bf4b74cb57 Updated the examples to show how to setup the sparkfun edison 2016-10-22 15:13:45 +01:00
api core: refactor/rename internal name of Master type 2016-10-15 20:02:54 +02:00
ci ci: move Travis build script to more informative directory name 2016-10-20 10:03:02 +02:00
cli core: refactor/rename internal name of Master type 2016-10-15 20:02:54 +02:00
drivers i2c: correct signature for Adafruit Motor Hat driver to match latest refactor 2016-10-10 11:04:39 +02:00
examples Updated the examples to show how to setup the sparkfun edison 2016-10-22 15:13:45 +01:00
gobottest [audio] Run go fmt because we have to 2016-05-24 21:05:27 -07:00
platforms Updated the examples to show how to setup the sparkfun edison 2016-10-22 15:13:45 +01:00
sysfs Merge pull request #308 from jfinken/dev 2016-09-17 01:34:05 +02:00
.gitignore First pass at adding some documentation 2014-08-13 10:22:58 -06:00
.travis.yml ci: move Travis build script to more informative directory name 2016-10-20 10:03:02 +02:00
CHANGELOG.md Resolve merge conflicts 2016-07-13 08:30:45 -06:00
CONTRIBUTING.md Make dev branch target more explicit 2016-02-19 18:41:26 -08:00
LICENSE Add C.H.I.P. to supported platforms 2016-02-17 12:25:14 -08:00
Makefile test: Run Travis tests on Intel Joule 2016-10-03 19:07:15 +02:00
README.md examples: better example of using Master Gobot 2016-10-18 19:37:53 +02:00
adaptor.go core: Starting refactor of new adaptor/new driver function signatures with ARDrone 2016-09-25 11:46:55 +02:00
commander.go go lint and documentation tweaks for the gobot package 2014-12-31 05:15:52 -08:00
commander_test.go Refactor to use `gobottest` test helpers 2016-02-24 22:16:05 -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 docs: remove Master unless needed for less code 2016-10-18 21:57:14 +02:00
driver.go core: Starting refactor of new adaptor/new driver function signatures with ARDrone 2016-09-25 11:46:55 +02:00
event.go core: Refactor events to use channels all the way down. Allows 'metal' development using Gobot libs. 2016-09-12 21:33:14 +02:00
eventer.go core: Add Unsubscribe() to eventer, now Once() works as expected 2016-09-12 21:33:14 +02:00
eventer_test.go core: Add further tests for Eventer 2016-09-12 21:33:14 +02:00
examples_test.go core: Refactor events to use channels all the way down. Allows 'metal' development using Gobot libs. 2016-09-12 21:33:14 +02:00
helpers_test.go core: Now both Robot and Master operate using AutoRun as expected 2016-10-18 18:23:59 +02:00
master.go core: Now both Robot and Master operate using AutoRun as expected 2016-10-18 18:23:59 +02:00
master_test.go core: Now both Robot and Master operate using AutoRun as expected 2016-10-18 18:23:59 +02:00
robot.go core: Now both Robot and Master operate using AutoRun as expected 2016-10-18 18:23:59 +02:00
utils.go core: Refactor events to use channels all the way down. Allows 'metal' development using Gobot libs. 2016-09-12 21:33:14 +02:00
utils_test.go test: update tests from linter errors 2016-10-16 11:43:02 +02:00
version.go release: update to version 0.13.0 2016-10-10 19:28:52 +02: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 Go Report Card

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/drivers/gpio"
	"github.com/hybridgroup/gobot/platforms/firmata"
)

func main() {
	firmataAdaptor := firmata.NewAdaptor("/dev/ttyACM0")
	led := gpio.NewLedDriver(firmataAdaptor, "13")

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

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

	robot.Start()
}

Gobot with Sphero

package main

import (
	"fmt"
	"time"

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

func main() {
	adaptor := sphero.NewAdaptor("/dev/rfcomm0")
	driver := sphero.NewSpheroDriver(adaptor)

	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,
	)

	robot.Start()
}

"Metal" Gobot

You can use the entire Gobot framework as shown in the examples above ("Classic" Gobot), or you can pick and choose from the various Gobot packages to control hardware with nothing but pure idiomatic Golang code ("Metal" Gobot). For example:

package main

import (
	"github.com/hybridgroup/gobot/drivers/gpio"
	"github.com/hybridgroup/gobot/platforms/intel-iot/edison"
	"time"
)

func main() {
	e := edison.NewAdaptor()
	e.Connect()

	led := gpio.NewLedDriver(e, "13")
	led.Start()

	for {
		led.Toggle()
		time.Sleep(1000 * time.Millisecond)
	}
}

"Master" Gobot

You can also use the full capabilities of the framework aka "Master Gobot" to control swarms of robots or other features such as the built-in API server. For example:

package main

import (
	"fmt"
	"time"

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

func NewSwarmBot(port string) *gobot.Robot {
	spheroAdaptor := sphero.NewAdaptor(port)
	spheroDriver := sphero.NewSpheroDriver(spheroAdaptor)
	spheroDriver.SetName("Sphero" + port)

	work := func() {
		spheroDriver.Stop()

		spheroDriver.On(sphero.Collision, func(data interface{}) {
			fmt.Println("Collision Detected!")
		})

		gobot.Every(1*time.Second, func() {
			spheroDriver.Roll(100, uint16(gobot.Rand(360)))
		})
		gobot.Every(3*time.Second, func() {
			spheroDriver.SetRGB(uint8(gobot.Rand(255)),
				uint8(gobot.Rand(255)),
				uint8(gobot.Rand(255)),
			)
		})
	}

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

	return robot
}

func main() {
	master := gobot.NewMaster()
	api.NewAPI(master).Start()

	spheros := []string{
		"/dev/rfcomm0",
		"/dev/rfcomm1",
		"/dev/rfcomm2",
		"/dev/rfcomm3",
	}

	for _, port := range spheros {
		master.AddRobot(NewSwarmBot(port))
	}

	master.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 gobot/drivers/gpio package:

  • GPIO <=> Drivers
    • Analog Sensor
    • Button
    • Buzzer
    • Direct Pin
    • Grove Button
    • Grove Buzzer
    • Grove LED
    • Grove Light Sensor
    • Grove Piezo Vibration Sensor
    • Grove Relay
    • Grove Rotary Dial
    • Grove Sound Sensor
    • Grove Temperature Sensor
    • Grove Touch Sensor
    • LED
    • Makey Button
    • Motor
    • Relay
    • RGB LED
    • Servo

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

  • I2C <=> Drivers
    • BlinkM
    • Grove Digital Accelerometer
    • Grove RGB LCD
    • HMC6352 Compass
    • JHD1313M1 RGB LCD Display
    • LIDAR-Lite
    • MCP23017 Port Expander
    • MMA7660 3-Axis Accelerometer
    • MPL115A2 Barometer
    • MPU6050 Accelerometer/Gyroscope
    • 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:

  master := gobot.NewMaster()
  api.NewAPI(master).Start()

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

  master := gobot.NewMaster()
  server := api.NewAPI(master)
  server.Port = "4000"
  server.AddHandler(api.BasicAuth("gort", "klatuu"))
  server.Start()

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

CLI

Gobot uses the Gort http://gort.io Command Line Interface (CLI) so you can access important features right from the command line. We call it "RobotOps", aka "DevOps For Robotics". You can scan, connect, update device firmware, and more!

Gobot also has its own CLI to generate new platforms, adaptors, and drivers. You can check it out at https://github.com/hybridgroup/gobot/cli.

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-2016 The Hybrid Group. Licensed under the Apache 2.0 license.