hybridgroup.gobot/i2c/README.md

2.8 KiB

Gobot Drivers For I2C Devices

Gobot (http://gobot.io/) is a framework and set of libraries for robotics, physical computing, and the Internet of Things written in the Go programming language (http://golang.org/).

This library provides drivers for i2c devices (https://en.wikipedia.org/wiki/I%C2%B2C). You would not normally use this library directly, instead it is used by Gobot adaptors that have i2c support.

Build Status

Getting Started

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

Examples

package main

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

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

	wiichuck := gobotI2C.NewWiichuck(firmata)
	wiichuck.Name = "wiichuck"

	work := func() {
		go func() {
			for {
				fmt.Println("joystick", gobot.On(wiichuck.Events["joystick"]))
			}
		}()
		go func() {
			for {
				fmt.Println("c", gobot.On(wiichuck.Events["c_button"]))
			}
		}()
		go func() {
			for {
				fmt.Println("z", gobot.On(wiichuck.Events["z_button"]))
			}
		}()
	}

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

	robot.Start()
}

Hardware Support

Gobot has a extensible system for connecting to hardware devices. The following i2c devices are currently supported:

  • BlinkM
  • HMC6352 Digital Compass
  • Wii Nunchuck Controller

More 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

  • 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 #gobotio on Freenode.
  • 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.
  • 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.