Go to file
Adrian Zankich 6f01605d38 DRY up On function 2013-12-18 12:54:08 -08:00
examples Update examples 2013-12-03 16:11:24 -08:00
gobot Clean up files 2013-12-02 17:10:36 -08:00
.travis.yml Install ginkgo and gomega dependencies 2013-12-03 01:23:24 -08:00
LICENSE Initial commit 2013-10-21 14:23:24 -07:00
README.md 15-README-update 2013-12-16 23:20:21 +01:00
adaptor.go Add support for additional parameters 2013-12-06 14:44:58 -08:00
api.go Drop unnecessary api parameters 2013-11-27 20:35:32 -08:00
connection.go Add support for additional parameters 2013-12-06 14:44:58 -08:00
device.go Small refactor 2013-12-15 14:29:01 -08:00
driver.go Add api commands 2013-11-24 14:41:36 -08:00
gobot_suite_test.go A green test, only gets better from here 2013-12-01 21:38:24 -08:00
master.go Expose robot functions via api 2013-11-27 20:05:45 -08:00
robot.go Work is optional 2013-12-03 15:51:17 -08:00
robot_test.go Clean up files 2013-12-02 17:10:36 -08:00
utils.go DRY up On function 2013-12-18 12:54:08 -08:00

README.md

Gobot

http://gobot.io/

Gobot is a set of libraries for robotics and physical computing using the Go programming language (http://golang.org/)

It provides a simple, yet powerful way to create solutions that incorporate multiple, different hardware devices at the same time.

Want to use Ruby or Javascript on robots? Check out our sister projects Artoo (http://artoo.io) and Cylon.js (http://cylonjs.com/)

Build Status

Examples

Basic

Go with a Sphero

package main

import (
  "github.com/hybridgroup/gobot"
  "github.com/hybridgroup/gobot-sphero"
)

func main() {

  spheroAdaptor := new(gobotSphero.SpheroAdaptor)
  spheroAdaptor.Name = "Sphero"
  spheroAdaptor.Port = "/dev/rfcomm0"

  sphero := gobotSphero.NewSphero(spheroAdaptor)
  sphero.Name = "Sphero"

  work := func() {
    gobot.Every("2s", func() {
      sphero.Roll(100, uint16(gobot.Rand(360)))
    })
  }

  robot := gobot.Robot{
    Connections: []interface{} { spheroAdaptor },
    Devices:     []interface{} { sphero },
    Work:        work,
  }

  robot.Start()
}
package main

import (
        "fmt"
        "github.com/hybridgroup/gobot"
        "github.com/hybridgroup/gobot-firmata"
        "github.com/hybridgroup/gobot-gpio"
)

func main() {

        firmata := new(gobotFirmata.FirmataAdaptor)
        firmata.Name = "firmata"
        firmata.Port = "/dev/ttyACM0"

        led := gobotGPIO.NewLed(firmata)
        led.Name = "led"
        led.Pin = "13"

        connections := []interface{}{
                firmata,
        }
        devices := []interface{}{
                led,
        }

        work := func() {
                gobot.Every("1s", func() {
                        led.Toggle()
                        if led.IsOn() {
                                fmt.Println("On")
                        } else {
                                fmt.Println("Off")
                        }
                })
        }

        robot := gobot.Robot{
                Connections: connections,
                Devices:     devices,
                Work:        work,
        }

        robot.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 provded using the cylon-gpio module:

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

More platforms and drivers are coming soon...

Getting Started

Install the library with: go get -u github.com/hybridgroup/gobot

Then install additional libraries for whatever hardware support you want to use from your robot. For example, go get -u github.com/hybridgroup/gobot-sphero to use Gobot with a Sphero.

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, use the Api command like this:

  master := gobot.GobotMaster()
  gobot.Api(master)

To specify the api port run your Gobot program with the PORT environment variable

  $ PORT=8080 go run gobotProgram.go

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!

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality

License

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