Go to file
deadprogram 305bee8239 Nicer format 2013-12-01 22:20:39 -08:00
examples Update examples 2013-11-24 16:24:32 -08:00
LICENSE Initial commit 2013-10-21 14:23:24 -07:00
README.md Update examples 2013-11-24 16:24:32 -08:00
adaptor.go Reformat source using gofmt 2013-11-13 20:44:54 -08:00
api.go Rename Gobot struct to Master 2013-11-24 16:17:47 -08:00
connection.go Initial GETs for api 2013-11-23 10:36:08 -08:00
device.go Add api commands 2013-11-24 14:41:36 -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 Rename Gobot struct to Master 2013-11-24 16:17:47 -08:00
port.go Reformat source using gofmt 2013-11-13 20:44:54 -08:00
robot.go Initial GETs for api 2013-11-23 10:36:08 -08:00
robot_test.go Nicer format 2013-12-01 22:20:39 -08:00
utils.go Add api commands 2013-11-24 14:41:36 -08:00

README.md

Gobot

Gobot (http://gobot.io/) 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/)

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.

Examples

package main

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

func main() {

  spheroAdaptor := new(gobotSphero.SpheroAdaptor)
  spheroAdaptor.Name = "Sphero"
  spheroAdaptor.Port = "127.0.0.1:4560"

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

  connections := []interface{}{
    spheroAdaptor,
  }
  devices := []interface{}{
    sphero,
  }

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

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

  robot.Start()
}

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

Hardware Support

Gobot has a extensible system for connecting to hardware devices. The following robotics and physical computing platforms are currently supported:

More platforms and drivers are coming soon...

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.