firmata

package
v2.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 7, 2024 License: Apache-2.0, Apache-2.0 Imports: 11 Imported by: 1

README

Firmata

Arduino is an open-source electronics prototyping platform based on flexible, easy-to-use hardware and software. It's intended for artists, designers, hobbyists and anyone interested in creating interactive objects or environments.

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

You can connect to the microcontroller using either a serial connection, or a TCP connection to a WiFi-connected microcontroller such as the ESP8266.

For more info about the Arduino platform, go to http://arduino.cc/.

How to Install

Please refer to the main README.md

You must install Firmata on your microcontroller before you can connect to it using Gobot. You can do this in many cases using Gort (http://gort.io).

In order to use a TCP connection with a WiFi-enbaled microcontroller, you must install WifiFirmata on the microcontroller. You can use the Arduino IDE to do this.

How to Use

With a serial connection:

package main

import (
  "time"

  "gobot.io/x/gobot/v2"
  "gobot.io/x/gobot/v2/drivers/gpio"
  "gobot.io/x/gobot/v2/platforms/firmata"
)

func main() {
  firmataAdaptor := firmata.NewAdaptor("/dev/ttyACM0")
  led := gpio.NewLedDriver(firmataAdaptor, "13")

  work := func() {
    gobot.Every(1*time.Second, func() {
      led.Toggle()
    })
  }

  robot := gobot.NewRobot("bot",
    []gobot.Connection{firmataAdaptor},
    []gobot.Device{led},
    work,
  )

  robot.Start()
}

With a TCP connection, use the NewTCPAdaptor:

package main

import (
  "time"

  "gobot.io/x/gobot/v2"
  "gobot.io/x/gobot/v2/drivers/gpio"
  "gobot.io/x/gobot/v2/platforms/firmata"
)

func main() {
  firmataAdaptor := firmata.NewTCPAdaptor("192.168.0.66:3030")
  led := gpio.NewLedDriver(firmataAdaptor, "2")

  work := func() {
    gobot.Every(1*time.Second, func() {
      led.Toggle()
    })
  }

  robot := gobot.NewRobot("bot",
    []gobot.Connection{firmataAdaptor},
    []gobot.Device{led},
    work,
  )

  robot.Start()
}

Important note that analog pins A4 and A5 are normally used by the Firmata I2C interface, so you will not be able to use them as analog inputs without changing the Firmata sketch.

How to Connect

Upload the Firmata Firmware to the Arduino

This section assumes you're using an Arduino Uno or another compatible board. If you already have the Firmata sketch installed, you can skip straight to the examples.

OS X

First plug the Arduino into your computer via the USB/serial port. A dialog box will appear telling you that a new network interface has been detected. Click "Network Preferences...", and when it opens, simply click "Apply".

Once plugged in, use Gort's gort scan serial command to find out your connection info and serial port address:

gort scan serial

Use the gort arduino install command to install avrdude, this will allow you to upload firmata to the arduino:

gort arduino install

Once the avrdude uploader is installed we upload the firmata protocol to the arduino, use the arduino serial port address found when you ran gort scan serial:

gort arduino upload firmata /dev/tty.usbmodem1421

Now you are ready to connect and communicate with the Arduino using serial port connection

Note that Gobot works best with the tty. version of the serial port as shown above, not the cu. version.

Ubuntu

First plug the Arduino into your computer via the USB/serial port.

Once plugged in, use Gort's gort scan serial command to find out your connection info and serial port address:

gort scan serial

Use the gort arduino install command to install avrdude, this will allow you to upload firmata to the arduino:

gort arduino install

Once the avrdude uploader is installed we upload the firmata protocol to the arduino, use the arduino serial port address found when you ran gort scan serial, or leave it blank to use the default address ttyACM0:

gort arduino upload firmata /dev/ttyACM0

Now you are ready to connect and communicate with the Arduino using serial port connection

Windows

First download and install gort for your OS from the gort.io downloads page and install it.

Open a command prompt window by right clicking on the start button and choose Command Prompt (Admin) (on windows 8.1). Then navigate to the folder where you uncompressed gort (uncomress to a folder first if you haven't done this yet).

Once inside the gort folder, first install avrdude which we'll use to upload firmata to the arduino.

gort arduino install

When the installation is complete, close the command prompt window and open a new one. We need to do this for the env variables to reload.

gort scan serial

Take note of your arduinos serialport address (COM1 | COM2 | COM3| etc). You need to already have installed the arduino drivers from arduino.cc/en/Main/Software. Finally upload the firmata protocol sketch to the arduino.

gort arduino upload firmata <COMX>

Make sure to substitute <COMX> with the apropiate serialport address.

Now you are ready to connect and communicate with the Arduino using serial port connection.

Using arduino IDE

Open arduino IDE and go to File > Examples > Firmata > StandardFirmata and open it. Select the appriate port for your arduino and click upload. Wait for the upload to finish and you should be ready to start using Gobot with your arduino.

Hardware Support

The following Firmata devices have been tested and are known to work:

The following WiFi devices have been tested and are known to work:

More devices are coming soon...

Documentation

Overview

Package firmata provides the Gobot adaptor for microcontrollers that support the Firmata protocol.

Installing: 

Please refer to the main [README.md](https://github.com/hybridgroup/gobot/blob/release/README.md)

Example: 

package main

import (
	"time"

	"gobot.io/x/gobot/v2"
	"gobot.io/x/gobot/v2/drivers/gpio"
	"gobot.io/x/gobot/v2/platforms/firmata"
)

func main() {
	firmataAdaptor := firmata.NewAdaptor("/dev/ttyACM0")
	led := gpio.NewLedDriver(firmataAdaptor, "13")

	work := func() {
		gobot.Every(1*time.Second, func() {
			led.Toggle()
		})
	}

	robot := gobot.NewRobot("bot",
		[]gobot.Connection{firmataAdaptor},
		[]gobot.Device{led},
		work,
	)

	robot.Start()
}

For further information refer to firmata readme: https://github.com/hybridgroup/gobot/blob/master/platforms/firmata/README.md

Index

Constants

View Source 
const (
	// ReceiveID is the BLE characteristic ID for receiving serial data
	ReceiveID = "6e400003b5a3f393e0a9e50e24dcca9e"

	// TransmitID is the BLE characteristic ID for transmitting serial data
	TransmitID = "6e400002b5a3f393e0a9e50e24dcca9e"
)

Variables

This section is empty.

Functions

func NewFirmataI2cConnection 

func NewFirmataI2cConnection(adaptor *Adaptor, address int) *firmataI2cConnection

NewFirmataI2cConnection creates an I2C connection to an I2C device at the specified address

Types

type Adaptor 

type Adaptor struct {
	Board firmataBoard

	PortOpener func(port string) (io.ReadWriteCloser, error)
	gobot.Eventer
	// contains filtered or unexported fields
}

Adaptor is the Gobot Adaptor for Firmata based boards

func NewAdaptor 

func NewAdaptor(args ...interface{}) *Adaptor

NewAdaptor returns a new Firmata Adaptor which optionally accepts: 

string: port the Adaptor uses to connect to a serial port with a baude rate of 57600
io.ReadWriteCloser: connection the Adaptor uses to communication with the hardware

If an io.ReadWriteCloser is not supplied, the Adaptor will open a connection to a serial port with a baude rate of 57600. If an io.ReadWriteCloser is supplied, then the Adaptor will use the provided io.ReadWriteCloser and use the string port as a label to be displayed in the log and api.

func (*Adaptor) AnalogRead 

func (f *Adaptor) AnalogRead(pin string) (int, error)

AnalogRead retrieves value from analog pin. Returns -1 if the response from the board has timed out

func (*Adaptor) Connect 

func (f *Adaptor) Connect() error

Connect starts a connection to the board.

func (*Adaptor) DefaultI2cBus 

func (f *Adaptor) DefaultI2cBus() int

DefaultI2cBus returns the default i2c bus for this platform

func (*Adaptor) DigitalRead 

func (f *Adaptor) DigitalRead(pin string) (int, error)

DigitalRead retrieves digital value from specified pin. Returns -1 if the response from the board has timed out

func (*Adaptor) DigitalWrite 

func (f *Adaptor) DigitalWrite(pin string, level byte) error

DigitalWrite writes a value to the pin. Acceptable values are 1 or 0.

func (*Adaptor) Disconnect 

func (f *Adaptor) Disconnect() error

Disconnect closes the io connection to the Board

func (*Adaptor) Finalize 

func (f *Adaptor) Finalize() error

Finalize terminates the firmata connection

func (*Adaptor) GetI2cConnection 

func (f *Adaptor) GetI2cConnection(address int, bus int) (i2c.Connection, error)

GetI2cConnection returns an i2c connection to a device on a specified bus. Only supports bus number 0

func (*Adaptor) Name 

func (f *Adaptor) Name() string

Name returns the Firmata Adaptors name

func (*Adaptor) Port 

func (f *Adaptor) Port() string

Port returns the Firmata Adaptors port

func (*Adaptor) PwmWrite 

func (f *Adaptor) PwmWrite(pin string, level byte) error

PwmWrite writes the 0-254 value to the specified pin

func (*Adaptor) ServoConfig 

func (f *Adaptor) ServoConfig(pin string, min, max int) error

ServoConfig sets the pulse width in microseconds for a pin attached to a servo

func (*Adaptor) ServoWrite 

func (f *Adaptor) ServoWrite(pin string, angle byte) error

ServoWrite writes the 0-180 degree angle to the specified pin.

func (*Adaptor) SetName 

func (f *Adaptor) SetName(n string)

SetName sets the Firmata Adaptors name

func (*Adaptor) WriteSysex 

func (f *Adaptor) WriteSysex(data []byte) error

type BLEAdaptor 

type BLEAdaptor struct {
	*Adaptor
}

BLEAdaptor represents a Bluetooth LE based connection to a microcontroller running FirmataBLE

func NewBLEAdaptor 

func NewBLEAdaptor(args ...interface{}) *BLEAdaptor

NewBLEAdaptor opens and uses a BLE connection to a microcontroller running FirmataBLE

type FirmataAdaptor 

type FirmataAdaptor interface {
	Connect() error
	Finalize() error
	Name() string
	SetName(n string)
	WriteSysex(data []byte) error
	gobot.Eventer
}

type TCPAdaptor 

type TCPAdaptor struct {
	*Adaptor
}

TCPAdaptor represents a TCP based connection to a microcontroller running WiFiFirmata

func NewTCPAdaptor 

func NewTCPAdaptor(args ...interface{}) *TCPAdaptor

NewTCPAdaptor opens and uses a TCP connection to a microcontroller running WiFiFirmata

Source Files

View all Source files

Directories

Path Synopsis
Package client provies a client for interacting with microcontrollers using the Firmata protocol https://github.com/firmata/protocol.
 Package client provies a client for interacting with microcontrollers using the Firmata protocol https://github.com/firmata/protocol.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.