Go to file
deadprogram 1ff1c0dccd core: renaming Spark platform to Particle at long last
Signed-off-by: deadprogram <ron@hybridgroup.com>
2016-10-01 18:11:26 +02:00
api core: Starting refactor of new adaptor/new driver function signatures with ARDrone 2016-09-25 11:46:55 +02:00
drivers core: Refactor I2C drivers for new Driver creation signatures 2016-09-25 14:08:18 +02:00
examples core: Refactor audio platform for new adaptor/driver signatures 2016-09-25 12:17:01 +02:00
gobot Add optional package name parameter 2014-12-24 11:58:41 -08:00
gobottest [audio] Run go fmt because we have to 2016-05-24 21:05:27 -07:00
platforms core: renaming Spark platform to Particle at long last 2016-10-01 18:11:26 +02:00
scripts core: update tests to include new drivers location 2016-10-01 17:25:13 +02:00
sysfs Remove debug message from i2c_device.go 2016-09-03 23:21:03 -05:00
.gitignore First pass at adding some documentation 2014-08-13 10:22:58 -06:00
.travis.yml core: update tests to include new drivers location 2016-10-01 17:25:00 +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 Fix #201 by add 'make examples' command to Makefile 2016-02-19 18:40:30 -08:00
README.md docs: Update README with new Adaptor/Driver creation signatures 2016-09-25 21:22:25 +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-22 00:33:58 -05: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 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
gobot.go Merge pull request #290 from dgryski/gosimple 2016-07-15 09:03:02 -06:00
gobot_test.go Refactor to use `gobottest` test helpers 2016-02-22 00:33:58 -05:00
helpers_test.go core: Starting refactor of new adaptor/new driver function signatures with ARDrone 2016-09-25 11:46:55 +02:00
robot.go Merge pull request #290 from dgryski/gosimple 2016-07-15 09:03:02 -06: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 core: Refactor events to use channels all the way down. Allows 'metal' development using Gobot libs. 2016-09-12 21:33:14 +02:00
version.go Update to 0.12.1 2016-07-13 08:41:14 -06: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/platforms/firmata"
	"github.com/hybridgroup/gobot/drivers/gpio"
)

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

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

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

	gbot.AddRobot(robot)

	gbot.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)
	}
}

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:

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

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.