af7dbf8bb1 | ||
---|---|---|
api | ||
examples | ||
gobot | ||
platforms | ||
scripts | ||
.gitignore | ||
.travis.yml | ||
CHANGELOG.md | ||
LICENSE | ||
Makefile | ||
README.md | ||
adaptor.go | ||
adaptor_test.go | ||
connection.go | ||
device.go | ||
doc.go | ||
driver.go | ||
driver_test.go | ||
event.go | ||
gobot.go | ||
gobot_test.go | ||
robot.go | ||
test_helper.go | ||
utils.go | ||
utils_test.go | ||
version.go |
README.md
Gobot 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 Ruby or Javascript on robots? Check out our sister projects Artoo (http://artoo.io) and Cylon.js (http://cylonjs.com/)
Examples
Gobot with Arduino
package main
import (
"time"
"github.com/hybridgroup/gobot"
"github.com/hybridgroup/gobot/platforms/firmata"
"github.com/hybridgroup/gobot/platforms/gpio"
)
func main() {
gbot := gobot.NewGobot()
firmataAdaptor := firmata.NewFirmataAdaptor("arduino", "/dev/ttyACM0")
led := gpio.NewLedDriver(firmataAdaptor, "led", "13")
work := func() {
gobot.Every(1*time.Second, func() {
led.Toggle()
})
}
robot := gobot.NewRobot("bot",
[]gobot.Connection{firmataAdaptor},
[]gobot.Device{led},
work,
)
gbot.AddRobot(robot)
gbot.Start()
}
Gobot with Sphero
package main
import (
"fmt"
"time"
"github.com/hybridgroup/gobot"
"github.com/hybridgroup/gobot/platforms/sphero"
)
func main() {
gbot := gobot.NewGobot()
adaptor := sphero.NewSpheroAdaptor("sphero", "/dev/rfcomm0")
driver := sphero.NewSpheroDriver(adaptor, "sphero")
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,
)
gbot.AddRobot(robot)
gbot.Start()
}
Hardware Support
Gobot has a extensible system for connecting to hardware devices. The following robotics and physical computing platforms are currently supported:
- Ardrone <=> Library
- Arduino <=> Library
- Beaglebone Black <=> Library
- Digispark <=> Library
- Joystick <=> Library
- Leap Motion <=> Library
- Neurosky <=> Library
- OpenCV <=> Library
- Spark <=> Library
- Sphero <=> Library
Support for many devices that use General Purpose Input/Output (GPIO) have a shared set of drivers provided using the cylon-gpio module:
Support for devices that use Inter-Integrated Circuit (I2C) have a shared set of drivers provided using the gobot-i2c module:
More platforms and drivers are coming soon...
Getting Started
Install Gobot with: go get -u github.com/hybridgroup/gobot
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, require the github.com/hybridgroup/gobot/api
package and instantiate the API
like this:
gbot := gobot.NewGobot()
api.NewAPI(gbot).Start()
You can also specify the api host and port, and turn on authentication:
gbot := gobot.NewGobot()
server := api.NewAPI(gbot)
server.Port = "4000"
server.Username = "Gort"
server.Password = "klaatu"
server.Start()
You may access the robeaux AngularJS interface with Gobot by navigating to http://localhost:3000/index.html
.
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
- All active development is in the
dev
branch. New or updated features must be added to thedev
branch. Hotfixes will be considered on themaster
branch in situations where it does not alter behaviour or features, only fixes a bug. - All patches must be provided under the Apache 2.0 License
- Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
- Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
- We will look at the patch, test it out, and give you feedback.
- Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
- Take care to maintain the existing coding style.
golint
andgo fmt
your code.- Add unit tests for any new or changed functionality.
- All pull requests should be "fast forward"
- If there are commits after yours use “git rebase -i <new_head_branch>”
- If you have local changes you may need to use “git stash”
- For git help see progit which is an awesome (and free) book on git
License
Copyright (c) 2013-2014 The Hybrid Group. Licensed under the Apache 2.0 license.