You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Firmata is a protocol for communicating with microcontrollers from software on a host computer. The [protocol](https://github.com/firmata/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](#contributing) section below.
-[Updating Firmata in the Arduino IDE - Arduino 1.6.4 and higher](#updating-firmata-in-the-arduino-ide---arduino-1.6.4-and-higher)
12
+
- [Mac OSX:](#mac-osx:)
13
+
- [Windows](#windows:)
14
+
- [Linux](#linux:)
15
+
-[Using the Source code rather than release archive (only for versions older than Arduino 1.6.3)](#using-the-source-code-rather-than-release-archive-only-for-versions-older-than-arduino-1.6.3)
16
+
17
+
## Usage
8
18
9
19
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.
10
20
11
21
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.
12
22
13
-
##Firmata Client Libraries
23
+
##Firmata Client Libraries
14
24
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:
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.
74
84
75
-
##Updating Firmata in the Arduino IDE - Arduino 1.6.4 and higher
85
+
##Updating Firmata in the Arduino IDE - Arduino 1.6.4 and higher
76
86
77
87
If you want to update to the latest stable version:
78
88
@@ -81,7 +91,7 @@ If you want to update to the latest stable version:
81
91
3. Click the `Select version` dropdown and select the most recent version (note you can also install previous versions)
82
92
4. Click `Install`.
83
93
84
-
###Cloning Firmata
94
+
###Cloning Firmata
85
95
86
96
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:
*Update path above if you're using Windows or Linux or changed the default Arduino directory on OS X*
93
103
94
104
95
-
##Updating Firmata in the Arduino IDE - older versions (<= 1.6.3 or 1.0.x)
105
+
##Updating Firmata in the Arduino IDE - older versions (<= 1.6.3 or 1.0.x)
96
106
97
107
Download the latest [release](https://github.com/firmata/arduino/releases/tag/2.5.6) (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.
98
108
99
109
*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).*
100
110
101
-
###Mac OSX:
111
+
###Mac OSX:
102
112
103
113
The Firmata library is contained within the Arduino package.
104
114
@@ -112,7 +122,7 @@ for Arduino 1.0.x vs 1.6.x)
112
122
*If you are using the Java 7 version of Arduino 1.5.7 or higher, the file path
113
123
will differ slightly: `Contents/Java/libraries/Firmata` (no Resources directory).*
114
124
115
-
###Windows:
125
+
###Windows:
116
126
117
127
1. Navigate to `c:/Program\ Files/arduino-1.x/libraries/` and replace the existing
118
128
`Firmata` folder with the latest [Firmata release](https://github.com/firmata/arduino/releases/tag/2.5.6) (note there is a different download
@@ -121,7 +131,7 @@ for Arduino 1.0.x vs 1.6.x).
121
131
122
132
*Update the path and Arduino version as necessary*
123
133
124
-
###Linux:
134
+
###Linux:
125
135
126
136
1. Navigate to `~/arduino-1.x/libraries/` and replace the existing
127
137
`Firmata` folder with the latest [Firmata release](https://github.com/firmata/arduino/releases/tag/2.5.6) (note there is a different download
@@ -130,7 +140,7 @@ for Arduino 1.0.x vs 1.6.x).
130
140
131
141
*Update the path and Arduino version as necessary*
132
142
133
-
###Using the Source code rather than release archive (only for versions older than Arduino 1.6.3)
143
+
###Using the Source code rather than release archive (only for versions older than Arduino 1.6.3)
134
144
135
145
*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 newer version of the Arduino IDE.*
136
146
@@ -155,8 +165,8 @@ To generate properly formatted versions of Firmata (for Arduino 1.0.x and Arduin
155
165
`release.sh` script.
156
166
157
167
158
-
<aname="contributing" />
159
-
##Contributing
168
+
169
+
##Contributing
160
170
161
171
If you discover a bug or would like to propose a new feature, please open a new [issue](https://github.com/firmata/arduino/issues?sort=created&state=open). Due to the limited memory of standard Arduino boards we cannot add every requested feature to StandardFirmata. Requests to add new features to StandardFirmata will be evaluated by the Firmata developers. However it is still possible to add new features to other Firmata implementations (Firmata is a protocol whereas StandardFirmata is just one of many possible implementations).
0 commit comments