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
Copy file name to clipboardExpand all lines: readme.md
+48-28Lines changed: 48 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,18 +24,18 @@ Most of the time you will be interacting with arduino with a client library on t
24
24
* perl
25
25
*[https://github.com/ntruchsess/perl-firmata]
26
26
*[https://github.com/rcaputo/rx-firmata]
27
-
* ruby
27
+
* ruby
28
28
*[https://github.com/hardbap/firmata]
29
29
*[https://github.com/PlasticLizard/rufinol]
30
30
*[http://funnel.cc]
31
31
* clojure
32
32
*[https://github.com/nakkaya/clodiuno]
33
33
*[https://github.com/peterschwarz/clj-firmata]
34
-
* javascript
34
+
* javascript
35
35
*[https://github.com/jgautier/firmata]
36
36
*[http://breakoutjs.com]
37
37
*[https://github.com/rwldrn/johnny-five]
38
-
* java
38
+
* java
39
39
*[https://github.com/4ntoine/Firmata]
40
40
*[https://github.com/shigeodayo/Javarduino]
41
41
*[https://github.com/kurbatov/firmata4j]
@@ -58,55 +58,75 @@ Most of the time you will be interacting with arduino with a client library on t
58
58
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.
59
59
60
60
##Updating Firmata in the Arduino IDE
61
-
The version of firmata in the Arduino IDE contains an outdated version of Firmata. To update Firmata, clone the repo into the location of firmata in the arduino IDE or download the latest [tagged version](https://github.com/firmata/arduino/tags) (stable), rename the folder to "Firmata" and replace the existing Firmata folder in your Arduino application.
61
+
The version of firmata in the Arduino IDE contains an outdated version of Firmata. To update Firmata, download the latest [release](https://github.com/firmata/arduino/releases) (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.
62
62
63
-
**Mac OSX**:
63
+
*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).*
The Firmata library is contained within the Arduino package.
68
+
1. Navigate to the Arduino application
69
+
2. Right click on the application icon and select `Show Package Contents`
70
+
3. Navigate to: `/Contents/Resources/Java/libraries/` and replace the existing
71
+
`Firmata` folder with latest Firmata release (note there is a different download
72
+
for Arduino 1.0.x vs 1.5.x)
73
+
4. Restart the Arduino application and the latest version of Firmata will be available.
74
74
75
-
If you are downloading the latest tagged version of Firmata, rename it to "Firmata" and copy to /Applications/Arduino.app/Contents/Resources/Java/libraries/ (note the special case for the Java 7 version of Arduino 1.5.7 above) overwriting the existing Firmata directory. Right-click (or conrol + click) on the Arduino application and choose "Show Package Contents" and navigate to the libraries directory.
75
+
If you are using the Java 7 version of Arduino 1.5.7 or higher, the file path
76
+
will differ slightly: `Contents/Java/libraries/Firmata` (no Resources directory).
76
77
77
-
**Windows**:
78
+
###Windows:
78
79
79
-
Using the Git Shell application installed with [GitHub for Windows](http://windows.github.com/) (set default shell in options to Git Bash) or other command line based git tool:
80
+
Update the path and arduino version as necessary
81
+
1. Navigate to `c:/Program\ Files/arduino-1.x/libraries/` and replace the existing
82
+
`Firmata` folder with the latest Firmata release (note there is a different download
83
+
for Arduino 1.0.x vs 1.5.x).
84
+
2. Restart the Arduino application and the latest version of Firmata will be available.
1. Navigate to `~/arduino-1.x/libraries/` and replace the existing
90
+
`Firmata` folder with the latest Firmata release (note there is a different download
91
+
for Arduino 1.0.x vs 1.5.x).
92
+
2. Restart the Arduino application and the latest version of Firmata will be available.
86
93
87
-
Note: If you use GitHub for Windows, you must clone the firmata/arduino repository using the Git Shell application as described above. You can use the Github for Windows GUI only after you have cloned the repository. Drag the Firmata file into the Github for Windows GUI to track it.
94
+
###Using the Source code rather than release archive
88
95
89
-
**Linux**:
96
+
Clone this repo directly into the core Arduino libraries directory. If you are using
97
+
Arduino 1.5.x, the repo directory structure will not match the Arduino
98
+
library format, however it should still compile as long as you are using Arduino 1.5.7
99
+
or higher.
90
100
91
-
update the path and arduino version as necessary
101
+
You will first need to remove the existing Firmata library, then clone firmata/arduino
To generate properly formatted versions of Firmata (for Arduino 1.0.x and Arduino 1.5.x), run the
111
+
`release.sh` script.
112
+
113
+
97
114
<aname="contributing" />
98
115
##Contributing
99
116
100
117
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).
101
118
102
-
To contribute, fork this respository and create a new topic branch for the bug, feature or other existing issue you are addressing. Submit the pull request against the *dev* branch.
119
+
To contribute, fork this repository and create a new topic branch for the bug, feature or other existing issue you are addressing. Submit the pull request against the *master* branch.
103
120
104
121
If you would like to contribute but don't have a specific bugfix or new feature to contribute, you can take on an existing issue, see issues labeled "pull-request-encouraged". Add a comment to the issue to express your intent to begin work and/or to get any additional information about the issue.
105
122
106
-
You must thorougly test your contributed code. In your pull request, describe tests performed to ensure that no existing code is broken and that any changes maintain backwards compatibility with the existing api. Test on multiple Arduino board variants if possible. We hope to enable some form of automated (or at least semi-automated) testing in the future, but for now any tests will need to be executed manually by the contributor and reviewsers.
123
+
You must thoroughly test your contributed code. In your pull request, describe tests performed to ensure that no existing code is broken and that any changes maintain backwards compatibility with the existing api. Test on multiple Arduino board variants if possible. We hope to enable some form of automated (or at least semi-automated) testing in the future, but for now any tests will need to be executed manually by the contributor and reviewers.
107
124
108
125
Maintain the existing code style:
109
126
127
+
- If you are changing a C++ file, use [Artistic Style (astyle)](http://astyle.sourceforge.net/) to format your code
128
+
-[Sublime Text astyle plugin](https://github.com/timonwong/SublimeAStyleFormatter) change default indentation from 4 to 2 spaces
129
+
- If you are changing an .ino file, use the auto format feature (Tools -> Auto Format) in the Arduino IDE before submitting a pull request
110
130
- Indentation is 2 spaces
111
131
- Use spaces instead of tabs
112
132
- Use camel case for both private and public properties and methods
0 commit comments