Go to file
Ron Evans 9d38858276 release: prepare release v1.14.0
Signed-off-by: Ron Evans <ron@hybridgroup.com>
2019-10-15 19:19:34 +02:00
.github Add Github sponsorship funding URL 2019-05-23 14:37:01 +02:00
api Fix a link in package docs' example code. 2019-10-15 10:47:53 +02:00
ci build: exclude vendor and other previously excluded subpackages 2018-07-06 11:16:36 +02:00
cli 689 update codegangsta to urfave (#690) 2019-10-08 08:12:11 +02:00
drivers Added ability to make a relay driver inverted (#674) 2019-06-25 07:13:17 +02:00
examples Change fps to 60 2019-05-22 11:34:39 +02:00
gobottest Revert "test: increase coverage on test helpers" 2017-05-08 10:46:41 +02:00
platforms fixed broken imports due to changed path causing go get to fail 2019-10-02 01:55:09 +03:30
sysfs pwm_pin - Fix DutyCycle() parse error, need to trim off trailing '\n' before calling strconv.Atoi(), as other functions in this package do 2019-05-22 11:34:39 +02:00
.gitignore dep for building vendor; no vendor in CI tests 2017-11-04 17:26:01 -05:00
.travis.yml core: updating to use go modules in build and completely remove dep 2019-10-15 10:26:40 +02:00
CHANGELOG.md release: prepare release v1.14.0 2019-10-15 19:19:34 +02:00
CODE_OF_CONDUCT.md docs: add contact info to CoC 2017-02-26 19:49:31 +01:00
CONTRIBUTING.md 689 update codegangsta to urfave (#690) 2019-10-08 08:12:11 +02:00
LICENSE.txt docs: update to remove Gitter and replace with Slack, and update copyright dates 2019-05-22 11:34:39 +02:00
Makefile core: updating to use go modules in build and completely remove dep 2019-10-15 10:26:40 +02:00
README.md docs: update to remove Gitter and replace with Slack, and update copyright dates 2019-05-22 11:34:39 +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 core: updating to use go modules in build and completely remove dep 2019-10-15 10:26:40 +02: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
go.mod core: updating to use go modules in build and completely remove dep 2019-10-15 10:26:40 +02:00
go.sum core: updating to use go modules in build and completely remove dep 2019-10-15 10:26:40 +02: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 Tests and related tweaks 2019-05-22 11:34:39 +02:00
robot_test.go core: increase test coverage 2017-05-07 13:47:52 +02:00
robot_work.go Tests and related tweaks 2019-05-22 11:34:39 +02:00
robot_work_test.go Tests and related tweaks 2019-05-22 11:34:39 +02:00
snapcraft.yaml Use go1.7.5 to build the snap 2017-02-15 18:32:24 +00:00
travis_build_opencv.sh core: updating to use go modules in build and completely remove dep 2019-10-15 10:26:40 +02:00
utils.go core: add Rescale utility function for straight linear rescaling 2018-08-15 17:06:52 +02:00
utils_test.go core: add Rescale utility function for straight linear rescaling 2018-08-15 17:06:52 +02:00
version.go release: prepare release v1.14.0 2019-10-15 19:19:34 +02:00

README.md

Gobot

GoDoc Build Status Build status Coverage Status Go Report Card License

Gobot (https://gobot.io/) is a framework using the Go programming language (https://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 run Go directly on microcontrollers? Check out our sister project TinyGo (https://tinygo.org/)

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
    • EasyDriver
    • 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
    • GrovePi Expansion Board
    • 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 https://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-2019 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.