Go to file
Michael Hope fa0b82d84c Merge branch 'dev' into nats 2017-04-21 20:30:46 +02:00
api api: gofmt and update Robeaux 2017-04-12 21:25:10 +02:00
cli license: update license year to include 2017 2017-01-02 22:25:17 +01:00
drivers gpio: adjust test timeouts 2017-04-21 11:13:56 +02:00
examples mqtt: update examples that use mqtt for updated notification signature 2017-04-19 09:21:34 +02:00
gobottest gobottest: increase test coverage 2017-04-09 11:30:15 +02:00
platforms Merge branch 'dev' into nats 2017-04-21 20:30:46 +02:00
sysfs sysfs: changes needed to allow use of PWMPin from Adaptors 2017-04-21 19:50:17 +02:00
.gitignore snapcraft: exclude snapcraft build artifacts from git 2017-02-16 19:36:59 +01:00
.travis.yml test: update Travis to run tests using Golang 1.8.1 2017-04-08 17:36:25 +02:00
CHANGELOG.md Prep for v1.4.0 2017-04-12 19:42:44 +02:00
CODE_OF_CONDUCT.md docs: add contact info to CoC 2017-02-26 19:49:31 +01:00
CONTRIBUTING.md docs: update CoC based on Contributor Covenant 2017-02-26 19:43:06 +01:00
LICENSE.txt docs: include entire Apache 2.0 license in the license text 2017-04-05 13:30:44 +02:00
Makefile Significantly speed up travis and make runs 2017-03-25 07:31:26 -04:00
README.md i2c: add BME280, BMP280 and update SSD1306 in README 2017-03-31 23:12:38 +02:00
adaptor.go core: no longer return slices of errors, instead use multierror 2016-11-07 21:29:51 +01:00
commander.go docs: Add missing godocs for Commander type 2016-12-01 20:40:58 +01:00
commander_test.go core: use canonical import domain of gobot.io for all code 2016-12-08 13:24:03 +01:00
connection.go core: no longer return slices of errors, instead use multierror 2016-11-07 21:29:51 +01:00
device.go core: no longer return slices of errors, instead use multierror 2016-11-07 21:29:51 +01:00
doc.go license: update license year to include 2017 2017-01-02 22:25:17 +01:00
driver.go core: no longer return slices of errors, instead use multierror 2016-11-07 21:29:51 +01: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: use 10-buffered chans for events, see #374 2017-04-07 13:50:09 +02:00
eventer_test.go test: complete test coverage for Eventer 2017-02-25 13:55:41 +01:00
examples_test.go core: use canonical import domain of gobot.io for all code 2016-12-08 13:24:03 +01:00
helpers_test.go core: no longer return slices of errors, instead use multierror 2016-11-07 21:29:51 +01:00
master.go core: remove unneeded error handling code that cannot be reached due to previous error handling. 2017-03-21 11:21:00 +01:00
master_test.go test: begin splitting tests into separate files for better separation of testing concerns 2017-02-25 12:00:32 +01:00
robot.go core: remove unneeded error handling code that cannot be reached due to previous error handling. 2017-03-21 11:21:00 +01:00
robot_test.go test: add test coverage for JSONDevices 2017-02-25 12:31:41 +01:00
snapcraft.yaml Use go1.7.5 to build the snap 2017-02-15 18:32:24 +00:00
utils.go mqtt: use new improved default namer to avoid API conflicts 2017-02-02 15:29:56 +01:00
utils_test.go core: increase test coverage for utils 2017-04-19 11:24:09 +02:00
version.go Prep for v1.4.0 2017-04-12 19:42:44 +02:00

README.md

Gobot

GitHub release Build Status Coverage Status Go Report Card License GoDoc

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)

Getting Started

Get the Gobot source with: go get -d -u gobot.io/x/gobot/...

Examples

Gobot with Arduino

package main

import (
	"time"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/drivers/gpio"
	"gobot.io/x/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"

	"gobot.io/x/gobot"
	"gobot.io/x/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 (
	"gobot.io/x/gobot/drivers/gpio"
	"gobot.io/x/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"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/api"
	"gobot.io/x/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
    • Button
    • Buzzer
    • Direct Pin
    • Grove Button
    • Grove Buzzer
    • Grove LED
    • Grove Magnetic Switch
    • Grove Relay
    • Grove Touch Sensor
    • LED
    • Makey Button
    • Motor
    • Proximity Infra Red (PIR) Motion Sensor
    • Relay
    • RGB LED
    • Servo

Support for many devices that use Analog Input/Output (AIO) have a shared set of drivers provided using the gobot/drivers/aio package:

  • AIO <=> Drivers
    • Analog Sensor
    • Grove Light Sensor
    • Grove Piezo Vibration Sensor
    • Grove Rotary Dial
    • Grove Sound Sensor
    • Grove Temperature Sensor

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

  • I2C <=> Drivers
    • Adafruit Motor Hat
    • BlinkM LED
    • BME280 Barometric Pressure/Temperature/Altitude/Humidity Sensor
    • BMP180 Barometric Pressure/Temperature/Altitude Sensor
    • BMP280 Barometric Pressure/Temperature/Altitude Sensor
    • DRV2605L Haptic Controller
    • Grove Digital Accelerometer
    • Grove RGB LCD
    • HMC6352 Compass
    • JHD1313M1 LCD Display w/RGB Backlight
    • L3GD20H 3-Axis Gyroscope
    • LIDAR-Lite
    • MCP23017 Port Expander
    • MMA7660 3-Axis Accelerometer
    • MPL115A2 Barometer
    • MPU6050 Accelerometer/Gyroscope
    • SHT3x-D Temperature/Humidity
    • SSD1306 OLED Display Controller
    • TSL2561 Digital Luminosity/Lux/Light Sensor
    • 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, import the gobot.io/x/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 in the /cli directory.

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 .

Gobot is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. You can read about it here.

License

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

The Contributor Covenant is released under the Creative Commons Attribution 4.0 International Public License, which requires that attribution be included.