Golang framework for robotics, drones, and the Internet of Things (IoT)
Go C Other
Latest commit 5b337ac Jan 9, 2017 @deadprogram deadprogram Prepare for v1.1.0 release
Signed-off-by: deadprogram <ron@hybridgroup.com>
Permalink
Failed to load latest commit information.
api core: use canonical import domain of gobot.io for all code Dec 8, 2016
ci aio: separate analog drivers from gpio drivers Dec 20, 2016
cli license: update license year to include 2017 Jan 2, 2017
drivers Merge pull request #352 from schmidtw/dev Jan 3, 2017
examples particle: update examples to take key params via command line Jan 4, 2017
gobottest [audio] Run go fmt because we have to Jul 3, 2016
platforms firmata: add mention to README to use 'tty.' serial port on OSX Jan 8, 2017
sysfs sysfs: some additional cleanup suggested by golint Jan 2, 2017
.gitignore First pass at adding some documentation Aug 13, 2014
.travis.yml test: Add Golang 1.8beta2 to Travis builds Dec 27, 2016
CHANGELOG.md Prepare for v1.1.0 release Jan 9, 2017
CONTRIBUTING.md core: use canonical import domain of gobot.io for all code Dec 8, 2016
LICENSE license: update license year to include 2017 Jan 2, 2017
Makefile Add a driver for the sht3x chip. Jan 3, 2017
README.md docs: add version badge using shields.io Jan 4, 2017
adaptor.go core: no longer return slices of errors, instead use multierror Nov 7, 2016
commander.go docs: Add missing godocs for Commander type Dec 3, 2016
commander_test.go core: use canonical import domain of gobot.io for all code Dec 8, 2016
connection.go core: no longer return slices of errors, instead use multierror Nov 7, 2016
device.go core: no longer return slices of errors, instead use multierror Nov 7, 2016
doc.go license: update license year to include 2017 Jan 2, 2017
driver.go core: no longer return slices of errors, instead use multierror Nov 7, 2016
event.go core: Refactor events to use channels all the way down. Allows 'metal… Sep 12, 2016
eventer.go core: eliminate potential race conditions from Events and Every funct… Dec 8, 2016
eventer_test.go core: Add further tests for Eventer Sep 12, 2016
examples_test.go core: use canonical import domain of gobot.io for all code Dec 8, 2016
helpers_test.go core: no longer return slices of errors, instead use multierror Nov 7, 2016
master.go core: no longer return slices of errors, instead use multierror Nov 7, 2016
master_test.go core: use canonical import domain of gobot.io for all code Dec 8, 2016
robot.go core: use multierror when handling Robot Stop Dec 3, 2016
snapcraft.yaml Add new line. Jan 5, 2017
utils.go core: eliminate potential race conditions from Events and Every funct… Dec 8, 2016
utils_test.go core: eliminate potential race conditions from Events and Every funct… Dec 8, 2016
version.go Prepare for v1.1.0 release Jan 9, 2017

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
    • BMP180 Barometric Pressure/Temperature/Altitude Sensor
    • Grove Digital Accelerometer
    • Grove RGB LCD
    • HMC6352 Compass
    • JHD1313M1 LCD Display w/RGB Backlight
    • LIDAR-Lite
    • L3GD20H 3-Axis Gyroscope
    • MCP23017 Port Expander
    • MMA7660 3-Axis Accelerometer
    • MPL115A2 Barometer
    • MPU6050 Accelerometer/Gyroscope
    • SHT3x-D Temperature/Humidity
    • 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 .

License

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