Project

arduino_firmata

0.06
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
arduino_firmatashokai/arduino_firmataHomepageDocumentationSource CodeBug TrackerWiki
Arduino Firmata protocol (http://firmata.org) implementation on Ruby.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
143,599
Stars
104
Forks
22
Watchers
12
 Releases
Current version
0.3.7
Total releases
36
First release
2012-10-23
Latest release
2014-02-01
 Issues
Open Issues
11
Closed Issues
29
Total Issues
40
Issue Closure Rate
72%
 Pull Requests
Open Pull Requests
2
Closed Pull Requests
2
Merged Pull Requests
2
Pull Request Acceptance Rate
33%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2013-08-09
Reverse Dependencies
7

 Dependencies

Development

backports
>= 0
bundler
~> 1.3
minitest
>= 0
rake
>= 0

Runtime

args_parser
>= 0.1.4
event_emitter
>= 0.2.4
serialport
>= 1.1.0
 Project Readme

arduino_firmata

Arduino Firmata protocol (http://firmata.org) implementation on Ruby.

  • Firmata is a protocol to controll Arduino from software on PC.
  • You can embed Arduino code into Ruby application.
  • Support sharing an Arduino between multiple processes.
  • http://shokai.github.io/arduino_firmata

Install

% gem install arduino_firmata

Requirements

  • Ruby 1.8.7 or 1.9.2 or 1.9.3 or 2.0.0
  • Arduino (http://arduino.cc)
    • testing with Arduino Diecimila, Duemillanove, UNO, Leonardo, Micro and Seeduino v2.
  • Arduino Standard Firmata v2.2
    • Arduino IDE -> [File] -> [Examples] -> [Firmata] -> [StandardFirmata]

ArduinoFirmata Command

% arduino_firmata --help
% arduino_firmata --list
% arduino_firmata digital_write 13, true
% arduino_firmata analog_read 0
% arduino_firmata servo_write 9, 145

Synopsis

Setup

Connect

require 'arduino_firmata'

arduino = ArduinoFirmata.connect  # use default arduino
arduino = ArduinoFirmata.connect '/dev/tty.usb-device-name'
arduino = ArduinoFirmata.connect '/dev/tty.usb-device-name', :bps => 57600
arduino = ArduinoFirmata.connect '/dev/tty.usb-device-name', :nonblock_io => true
arduino = ArduinoFirmata.connect '/dev/tty.usb-device-name', :eventmachine => true

Board Version

puts "firmata version #{arduino.version}"

Close

arduino.close

I/O

Digital Write

arduino.digital_write 13, true
arduino.digital_write 13, false

Digital Read

arduino.pin_mode 7, ArduinoFirmata::INPUT
puts arduino.digital_read 7  # => true/false

## regist event
arduino.on :digital_read do |pin, status|
  if pin == 7
    puts "digital pin #{pin} changed : #{status}"
  end
end

Analog Write (PWM)

0.upto(255) do |i|
  arduino.analog_write 11, i
  sleep 0.01
end

Analog Read

puts arduino.analog_read 0  # => 0 ~ 1023

## regist event
arduino.on :analog_read do |pin, value|
  if pin == 0
    puts "analog pin #{pin} changed : #{value}"
  end
end

Servo Motor

loop do
  angle = rand(180)
  arduino.servo_write 11, angle
  sleep 1
end

Sysex

Send

arduino.sysex 0x01, [13, 5, 2]  # command, data_array

Regist Receive Event

arduino.on :sysex do |command, data|
  puts "command : #{command}"
  puts "data    : #{data.inspect}"
end

Block Style

ArduinoFirmata.connect do
  puts "firmata version #{version}"

  30.times do
    an = analog_read 0
    analog_write 11, an
    sleep 0.01
  end
end

Test

Install SysexLedBlinkFirmata into Arduino

Run Test

% gem install bundler
% bundle install
% export ARDUINO=/dev/tty.usb-device-name
% rake test

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request