firmata

README

Firmata

This package provides the adaptor for microcontrollers such as Arduino that support the Firmata protocol

Getting Started

go get github.com/edmontongo/gobot && go install github.com/edmontongo/gobot/platforms/firmata

Example

package main

import (
	"time"

	"github.com/edmontongo/gobot"
	"github.com/edmontongo/gobot/platforms/firmata"
	"github.com/edmontongo/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()
}

Hardware Support

The following firmata devices have been tested and are currently supported:

• Arduino uno r3
• Teensy 3.0

More devices are coming soon...

Documentation

Index

• type FirmataAdaptor
  • func NewFirmataAdaptor(name, port string) *FirmataAdaptor
  • func (f *FirmataAdaptor) AnalogRead(pin string) int
  • func (f *FirmataAdaptor) AnalogWrite(pin string, level byte)
  • func (f *FirmataAdaptor) Connect() bool
  • func (f *FirmataAdaptor) DigitalRead(pin string) int
  • func (f *FirmataAdaptor) DigitalWrite(pin string, level byte)
  • func (f *FirmataAdaptor) Disconnect() bool
  • func (f *FirmataAdaptor) Finalize() bool
  • func (f *FirmataAdaptor) I2cRead(size uint) []byte
  • func (f *FirmataAdaptor) I2cStart(address byte)
  • func (f *FirmataAdaptor) I2cWrite(data []byte)
  • func (f *FirmataAdaptor) InitServo()
  • func (f *FirmataAdaptor) PwmWrite(pin string, level byte)
  • func (f *FirmataAdaptor) ServoWrite(pin string, angle byte)

Types

type FirmataAdaptor

type FirmataAdaptor struct {
	gobot.Adaptor
	// contains filtered or unexported fields
}

func NewFirmataAdaptor

func NewFirmataAdaptor(name, port string) *FirmataAdaptor

func (*FirmataAdaptor) AnalogRead

func (f *FirmataAdaptor) AnalogRead(pin string) int

NOTE pins are numbered A0-A5, which translate to digital pins 14-19

func (*FirmataAdaptor) AnalogWrite

func (f *FirmataAdaptor) AnalogWrite(pin string, level byte)

func (*FirmataAdaptor) Connect

func (f *FirmataAdaptor) Connect() bool

func (*FirmataAdaptor) DigitalRead

func (f *FirmataAdaptor) DigitalRead(pin string) int

func (*FirmataAdaptor) DigitalWrite

func (f *FirmataAdaptor) DigitalWrite(pin string, level byte)

func (*FirmataAdaptor) Disconnect

func (f *FirmataAdaptor) Disconnect() bool

func (*FirmataAdaptor) Finalize

func (f *FirmataAdaptor) Finalize() bool

func (*FirmataAdaptor) I2cRead

func (f *FirmataAdaptor) I2cRead(size uint) []byte

func (*FirmataAdaptor) I2cStart

func (f *FirmataAdaptor) I2cStart(address byte)

func (*FirmataAdaptor) I2cWrite

func (f *FirmataAdaptor) I2cWrite(data []byte)

func (*FirmataAdaptor) InitServo

func (f *FirmataAdaptor) InitServo()

func (*FirmataAdaptor) PwmWrite

func (f *FirmataAdaptor) PwmWrite(pin string, level byte)

func (*FirmataAdaptor) ServoWrite

func (f *FirmataAdaptor) ServoWrite(pin string, angle byte)