Go to file
Ron Evans 4cf6299986 build: further refactor ci test script for covercov groups for go 1.9.x compat
Signed-off-by: Ron Evans <ron@hybridgroup.com>
2018-05-30 19:53:10 +02:00
api fixed typo 2017-09-23 14:16:19 +05:30
ci build: further refactor ci test script for covercov groups for go 1.9.x compat 2018-05-30 19:53:10 +02:00
cli cli: remove extra newline 2018-04-12 12:25:39 +02:00
drivers Improve Stepper Driver 2018-05-28 23:14:09 +05:30
examples joystick: full corrected ds3 and ds4 mappings plus examples to match for latest sdl 2.0.8 2018-05-25 12:19:22 +02:00
gobottest Revert "test: increase coverage on test helpers" 2017-05-08 10:46:41 +02:00
platforms joystick: update scanner to match go-sdl 0.3 API changes 2018-05-30 13:58:27 +02:00
sysfs sysfs: pause briefly to allow udev rules to apply when exporting PWMPin 2017-12-20 07:05:10 +01:00
.gitignore dep for building vendor; no vendor in CI tests 2017-11-04 17:26:01 -05:00
.travis.yml build: further refactor ci test script for covercov groups for go 1.9.x compat 2018-05-30 19:53:10 +02:00
CHANGELOG.md release: update version to 1.10.2 2018-04-24 13:03:49 +02:00
CODE_OF_CONDUCT.md docs: add contact info to CoC 2017-02-26 19:49:31 +01:00
CONTRIBUTING.md contribution: add step to call dep ensure before contributing #524 2018-05-08 18:50:56 +02:00
Gopkg.lock build: update deps to latest versions for Paho MQTT, go-sdl, and gocv 2018-05-30 13:51:37 +02:00
Gopkg.toml build: update deps to latest versions for Paho MQTT, go-sdl, and gocv 2018-05-30 13:51:37 +02:00
LICENSE.txt docs: update copyright date to 2018 2018-02-14 08:24:39 +01:00
Makefile fmt check in script; fail build on gofmt problems 2017-11-09 13:35:02 -06:00
README.md docs: add recently contributed GPIO devices to README 2018-04-19 18:27:25 +02:00
ROADMAP.md Prepare for v1.9.0 release 2018-02-14 20:02:45 +01:00
adaptor.go core: no longer return slices of errors, instead use multierror 2016-11-07 21:29:51 +01:00
appveyor.yml build: remove API tests from Windows build for now 2017-07-12 13:55:27 -06: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 docs: update copyright date to 2018 2018-02-14 08:24:39 +01:00
driver.go core: correct small typo 2017-04-24 18:18:01 +02:00
event.go fixed typo 2017-09-23 14:16:19 +05:30
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: add Running() methods for Master and Robot and increase test coverage accordingly 2017-05-07 13:28:29 +02:00
master_test.go core: add Running() methods for Master and Robot and increase test coverage accordingly 2017-05-07 13:28:29 +02:00
robot.go core: log failure errors on Robot Start() 2017-06-15 14:04:08 +02:00
robot_test.go core: increase test coverage 2017-05-07 13:47:52 +02:00
snapcraft.yaml Use go1.7.5 to build the snap 2017-02-15 18:32:24 +00:00
travis_build_opencv.sh build: update build settings needed to build OpenCV/GoCV as part of test suite 2018-02-14 13:54:41 +01:00
utils.go mqtt: use new improved default namer to avoid API conflicts 2017-02-02 15:29:56 +01:00
utils_test.go test: avoid possibility of collide value in tests. I mean, what were the odds of that? 2017-10-19 12:54:54 +02:00
version.go release: update version to 1.10.2 2018-04-24 13:03:49 +02:00

README.md

Gobot

GitHub release Build Status Build status Coverage Status Go Report Card License GoDoc Gitter chat

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
    • AIP1640 LED
    • 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
    • Stepper Motor
    • TM1638 LED Controller

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
    • ADS1015 Analog to Digital Converter
    • ADS1115 Analog to Digital Converter
    • ADXL345 Digital Accelerometer
    • BH1750 Digital Luminosity/Lux/Light Sensor
    • 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
    • INA3221 Voltage Monitor
    • JHD1313M1 LCD Display w/RGB Backlight
    • L3GD20H 3-Axis Gyroscope
    • LIDAR-Lite
    • MCP23017 Port Expander
    • MMA7660 3-Axis Accelerometer
    • MPL115A2 Barometer
    • MPU6050 Accelerometer/Gyroscope
    • PCA9685 16-channel 12-bit PWM/Servo Driver
    • SHT3x-D Temperature/Humidity
    • SSD1306 OLED Display Controller
    • TSL2561 Digital Luminosity/Lux/Light Sensor
    • Wii Nunchuck Controller

Support for devices that use Serial Peripheral Interface (SPI) have a shared set of drivers provided using the gobot/drivers/spi package:

  • SPI <=> Drivers
    • APA102 Programmable LEDs
    • MCP3002 Analog/Digital Converter
    • MCP3004 Analog/Digital Converter
    • MCP3008 Analog/Digital Converter
    • MCP3202 Analog/Digital Converter
    • MCP3204 Analog/Digital Converter
    • MCP3208 Analog/Digital Converter
    • MCP3304 Analog/Digital Converter
    • SSD1306 OLED Display 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 always 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-2018 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.