Firmata

Firmata is a protocol for communicating with microcontrollers from software on a host computer. The protocol can be implemented in firmware on any microcontroller architecture as well as software on any host computer software package. The Arduino repository described here is a Firmata library for Arduino and Arduino-compatible devices. If you would like to contribute to Firmata, please see the Contributing section below.

Contents

• Usage
• Firmata Client Libraries
• Updating Firmata in the Arduino IDE - Arduino 1.6.4 and higher
• Cloning Firmata
• Updating Firmata in the Arduino IDE - older versions (<= 1.6.3 or 1.0.x)
  • Mac OSX:
  • Windows
  • Linux
• Using the Source code rather than release archive (only for versions older than Arduino 1.6.3)
• Contributing

Usage

There are two main models of usage of Firmata. In one model, the author of the Arduino sketch uses the various methods provided by the Firmata library to selectively send and receive data between the Arduino device and the software running on the host computer. For example, a user can send analog data to the host using Firmata.sendAnalog(analogPin, analogRead(analogPin)) or send data packed in a string using Firmata.sendString(stringToSend). See File -> Examples -> Firmata -> AnalogFirmata & EchoString respectively for examples. Browse the API documentation here.

The second and more common model is to load a general purpose sketch called StandardFirmata (or one of the variants such as StandardFirmataPlus or StandardFirmataEthernet depending on your needs) on the Arduino board and then use the host computer exclusively to interact with the Arduino board. StandardFirmata is located in the Arduino IDE in File -> Examples -> Firmata.

Firmata Client Libraries

Most of the time you will be interacting with Arduino with a client library on the host computers. Several Firmata client libraries have been implemented in a variety of popular programming languages:

• processing
  • https://github.com/firmata/processing
• python
  • https://github.com/MrYsLab/pymata4
  • https://github.com/MrYsLab/pymata-express
  • https://github.com/tino/pyFirmata
  • https://github.com/lupeke/python-firmata
  • https://github.com/firmata/pyduino
• perl
  • https://github.com/ntruchsess/perl-firmata
  • https://github.com/rcaputo/rx-firmata
• ruby
  • https://github.com/hardbap/firmata
  • https://github.com/PlasticLizard/rufinol
  • http://funnel.cc
• clojure
  • https://github.com/nakkaya/clodiuno
  • https://github.com/peterschwarz/clj-firmata
• javascript
  • https://github.com/firmata/firmata.js
  • https://github.com/rwldrn/johnny-five
  • http://breakoutjs.com
  • https://nodered.org/docs/faq/interacting-with-arduino#firmata
• java
  • https://github.com/kurbatov/firmata4j
  • https://github.com/4ntoine/Firmata
  • https://github.com/reapzor/FiloFirmata
• .NET
  • https://github.com/SolidSoils/Arduino
  • http://www.acraigie.com/programming/firmatavb/default.html
• Flash/AS3
  • http://funnel.cc
  • http://code.google.com/p/as3glue/
• Pharo
  • https://github.com/pharo-iot/Firmata
• PHP
  • https://github.com/ThomasWeinert/carica-firmata
  • https://github.com/oasynnoum/phpmake_firmata
• Haskell
  • http://hackage.haskell.org/package/hArduino
• iOS
  • https://github.com/jacobrosenthal/iosfirmata
• Dart
  • https://github.com/nfrancois/firmata
• Max/MSP
  • http://www.maxuino.org/
  • https://github.com/NullMember/MaxFirmata
• Elixir
  • https://github.com/kfatehi/firmata
• Modelica
  • https://www.wolfram.com/system-modeler/libraries/model-plug/
• Go
  • https://github.com/kraman/go-firmata
• vvvv/VL
  • https://github.com/vvvv/VL.IO.Firmata
• openFrameworks
  • http://openframeworks.cc/documentation/communication/ofArduino/
• Rust
  • https://github.com/zankich/rust-firmata
• Pure Data
  • https://github.com/NullMember/PDFirmata
• Common Lisp
  • https://github.com/cjfuller/cl-firmata
• Linux Kernel Module
  • [https://github.com/logicog/firmata_mod]

Note: The above libraries may support various versions of the Firmata protocol and therefore may not support all features of the latest Firmata spec nor all Arduino and Arduino-compatible boards. Refer to the respective projects for details.

Updating Firmata in the Arduino IDE - Arduino 1.6.4 and higher

If you want to update to the latest stable version:

1. Open the Arduino IDE and navigate to: Sketch > Include Library > Manage Libraries
2. Filter by "Firmata" and click on the "Firmata by Firmata Developers" item in the list of results.
3. Click the Select version dropdown and select the most recent version (note you can also install previous versions)
4. Click Install.

Cloning Firmata

If you are contributing to Firmata or otherwise need a version newer than the latest tagged release, you can clone Firmata directly to your Arduino/libraries/ directory (where 3rd party libraries are installed). This only works for Arduino 1.6.4 and higher, for older versions you need to clone into the Arduino application directory (see section below titled "Using the Source code rather than release archive"). Be sure to change the name to Firmata as follows:

$ git clone git@github.com:firmata/arduino.git ~/Documents/Arduino/libraries/Firmata

Update path above if you're using Windows or Linux or changed the default Arduino directory on OS X

Updating Firmata in the Arduino IDE - older versions (<= 1.6.3 or 1.0.x)

Download the latest release (for Arduino 1.0.x or Arduino 1.5.6 or higher) and replace the existing Firmata folder in your Arduino application. See the instructions below for your platform.

Note that Arduino 1.5.0 - 1.5.5 are not supported. Please use Arduino 1.5.6 or higher (or Arduino 1.0.5 or 1.0.6).

Mac OSX:

The Firmata library is contained within the Arduino package.

1. Navigate to the Arduino application
2. Right click on the application icon and select Show Package Contents
3. Navigate to: /Contents/Resources/Java/libraries/ and replace the existing Firmata folder with latest Firmata release (note there is a different download for Arduino 1.0.x vs 1.6.x)
4. Restart the Arduino application and the latest version of Firmata will be available.

If you are using the Java 7 version of Arduino 1.5.7 or higher, the file path will differ slightly: Contents/Java/libraries/Firmata (no Resources directory).

Windows:

1. Navigate to c:/Program\ Files/arduino-1.x/libraries/ and replace the existing Firmata folder with the latest Firmata release (note there is a different download for Arduino 1.0.x vs 1.6.x).
2. Restart the Arduino application and the latest version of Firmata will be available.

Update the path and Arduino version as necessary

Linux:

1. Navigate to ~/arduino-1.x/libraries/ and replace the existing Firmata folder with the latest Firmata release (note there is a different download for Arduino 1.0.x vs 1.6.x).
2. Restart the Arduino application and the latest version of Firmata will be available.

Update the path and Arduino version as necessary

Using the Source code rather than release archive (only for versions older than Arduino 1.6.3)

*It is recommended you update to Arduino 1.6.4 or higher if possible, that way you can clone directly into the external Arduino/libraries/ directory which persists between Arduino application updates. Otherwise you will need to move your clone each time you update to a newe