Skip to content

Commit 713d204

Browse files
author
jantje
committed
Updated web pages based on input from user
1 parent a578ec8 commit 713d204

15 files changed

+112
-44
lines changed

‎Eclipse update site/WebContent/fragments/how_to/add_library.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
11
How to add a library - Arduino Eclipse Plugin!
22
=====
3+
Part of the power of arduino is the multitude of libraries available to the users.
4+
Therefore this is a basic functionality of the Arduino eclipse plugin.
5+
The Arduino core team has done a good job in hiding the complexity of using libraries. In a real IDE you do not want to hide this complexity to the full extend that the Arduino IDE does. As such there is some more visibility (read work and possibilities) in regards to libraries.
6+
In your project there is a subfolder called libraries. This folder contains the libraries that have been imported into your project. This list should only contain libraries you really use.
7+
Adding a library to this folder is what we call importing a library.
8+
It is very easy to import a library into your project.
9+
In V3 it is even as simple as in the Arduino IDE.
310

4-
Part of the power of arduino is the multitude of libraries available to the users. It is very easy to import a library into your project.
11+
V3
12+
-----
13+
Simply add the include statement to your code.
14+
Save your file.
15+
The automatic library includer will import the library into your project.
16+
You may have to wait a while before the indexer has indexed the source code and the library includer can kick in.
17+
18+
V2 and V3
19+
-----
20+
521
Select the project you want the library to add to. In the main menu select "Arduino->add a library to the selected project".
6-
A dialog box will pop up showing all available libraries.
22+
A dialog box will pop up showing all available libraries.
723
![import library](http://iloapp.baeyens.it/data/_gallery/public/1/137950377839940200_resized.png)
824

925

@@ -14,4 +30,4 @@ Note: from march 2015 there is no more subsections (hardware/arduino/library) Al
1430
**Party success**
1531

1632
1. drink a beer
17-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
33+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")

‎Eclipse update site/WebContent/fragments/how_to/change_arduino_bord.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@ Right click on the project and select properties.
77
In properties select Arduino.
88
Here you can change your Arduino settings.
99
The dialog looks pretty much like the one in the sketch creation wizard.
10-
![change Arduino board settings](http://iloapp.baeyens.it/data/_gallery/public/6/141807692282059000_resized.png)
10+
![change Arduino board settings](http://iloapp.baeyens.it/data/_gallery/public/6/141807692282059000_resized.png =500x)
1111

1212
**Party success**
1313

14-
1. drink a beer
15-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
14+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")

‎Eclipse update site/WebContent/fragments/how_to/change_compilations_settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ The other options seem pretty straightforward.
1919
**Party success**
2020

2121
1. drink a beer
22-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
22+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")

‎Eclipse update site/WebContent/fragments/how_to/change_serial_port.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,17 @@ Change your Arduino port settings
22
===
33

44
Once you have your sketch you may wonder: "I entered my board information in the sketch creation wizard but how can I change it?"
5-
It is in the same dialog as in the change your board settings. Please see that section.
5+
It is in the same dialog as in the change your board settings. Please see that section.
6+
7+
For Teensy users only.
8+
----
9+
Teensy does not use the serial port for upload but it is still important to set the port right.
10+
This becomes apparent when you start using the serial monitor. Because the plugin closes the port and reopens the port during a upload it needs to have the right com port.
11+
Not having set the right port will result in serial port madness.
12+
You have been warned!!
13+
14+
15+
**Party success**
16+
17+
1. drink a beer
18+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")

‎Eclipse update site/WebContent/fragments/how_to/configure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This section assumes you have installed the Arduino Eclipse plugin or product.
1313
7. Fill it in like below (using the location of the Arduino IDE c:/arduino)
1414
8. Add the location of your private libraries.
1515
in V1 this looks like
16-
![V1](http://iloapp.baeyens.it/data/_gallery/public/1/134998877869708900_resized.png)
16+
![V1](http://iloapp.baeyens.it/data/_gallery/public/1/134998877869708900_resized.png =500x)
1717
in V2 this looks like
1818
![V2](http://iloapp.baeyens.it/data/_gallery/public/6/141798497248313500_resized.png)
1919
The newer version no longer uses RXTX so there is no longer a "test serial dll" button. If the button is there click it.
@@ -32,4 +32,4 @@ This section assumes you have installed the Arduino Eclipse plugin or product.
3232
**Party success**
3333

3434
1. drink a beer
35-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
35+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")

‎Eclipse update site/WebContent/fragments/how_to/create_a_library.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,41 @@
11
How to create a library with the Arduino Eclipse plugin.
22
==
33

4-
As you have a real development environment now which allows you to modify libraries as if they are part of your code you may wonder: "how can I make my own libraries?"
4+
As you have a real development environment now which allows you to modify libraries as if they are part of your code you may wonder: "how can I make my own libraries?"
55

6-
The way I do it is a multiple step process as you can see below.
6+
The way I do it is a multiple step process as you can see below.
77

88
**start by having a project**
9-
For sake of this demo I created a empty workspace and created a sketch in there. Here is what it looks like:
9+
For sake of this demo I created a empty workspace and created a sketch in there. Here is what it looks like:
1010
![freshly created sketch in empty workspace](http://iloapp.baeyens.it/data/_gallery/public/6/141814238387984300_resized.png)
1111

1212
**write your first version of the library code**
13-
In most cases you will start by simply creating a class (right click the folder and select new class) inside a existing project.
14-
Later you will decide that this class/code is worth to be upgraded to a library.
15-
So here we created the class in our project.
16-
![a class added to the project](http://iloapp.baeyens.it/data/_gallery/public/6/141814162454370900_resized.png)
13+
In most cases you will start by simply creating a class (right click the folder and select new class) inside a existing project.
14+
Later you will decide that this class/code is worth to be upgraded to a library.
15+
So we create a class in our project.
1716

18-
**Create a subfolder with the library name in you private library folder**
17+
**Create a subfolder with the library name in you private library folder**
1918
Don't put any files there, just create the folder.
20-
On my system I created a folder in /home/jan/Arduino/libraries with the name Libcodeclass. Note that it is a good practise to have the same name for the folder as for the header file (that is even with casing).
19+
On my system I created a folder in /home/jan/Arduino/libraries with the name Libcodeclass. Note that it is a good practise to have the same name for the folder as for the header file (that is even with casing).
2120

2221
**Import the library in your project**
2322
Because we created a folder the plugin can add the folder to the project.
2423
select the Arduino item in the menu->import an Arduino library.
25-
![Add the library to your project](http://iloapp.baeyens.it/data/_gallery/public/6/141814162245895400_resized.png)
24+
![Add the library to your project](http://iloapp.baeyens.it/data/_gallery/public/6/141814162245895400_resized.png)
2625
now your project should look something like:
2726
![a empty library folder](http://iloapp.baeyens.it/data/_gallery/public/6/141814162454370900_resized.png)
2827
Note that the Libcodeclass folder under libraries is empty.
29-
Also not the small arrow in the folder icon which indicates this is a linked folder.
28+
Also not the small arrow in the folder icon which indicates this is a linked folder.
3029

3130
**Drag and drop the class to the library folder**
3231
Now simply drag and drop the header file and source code to the library folder.
33-
![we are done](http://iloapp.baeyens.it/data/_gallery/public/6/141814162408665500_resized.png)
32+
![we are done](http://iloapp.baeyens.it/data/_gallery/public/6/141814162408665500_resized.png)
3433
That is all there is to it.
3534

36-
Note that you can just as well create the class in the Libcodeclass folder in eclipse. However in most cases you will promote existing code to a library.
35+
Note that you can just as well create the class in the Libcodeclass folder in eclipse. However in most cases you will promote existing code to a library.
3736

3837

3938
**Party success**
4039

4140
1. drink a beer
42-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
41+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")

‎Eclipse update site/WebContent/fragments/how_to/create_sketch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ In V2 only one project is created. The Arduino code is in folder Arduino in your
7171
**Party success**
7272

7373
1. drink a beer
74-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
74+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")

‎Eclipse update site/WebContent/fragments/how_to/install_V1_plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,6 @@ You want the C++ version and preferably the 32 bit version
3939
**Party success**
4040

4141
1. drink a beer
42-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
42+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")
4343

4444

‎Eclipse update site/WebContent/fragments/how_to/install_V2_plugin.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ People who use MAC OSX may want to read [the blog of garretto]("http://robots.da
99
WINDOWS USERS BE AWARE
1010
====
1111
From Arduino IDE 1.5.6 make is no longer part of the Arduino IDE.
12-
Moreover the [toolchain delivered as part of Arduino IDE contains a bug.](https://github.com/arduino/Arduino/issues/2422)
13-
As such we do not advise to Arduino IDE 1.5.6 or later on windows.
14-
Mac and linux normally come with make preinstalled and do not suffer the bug.
12+
[Watch this movie to see how to fix.](https://www.youtube.com/watch?v=cspLbTqBi7k)
13+
Moreover the [toolchain delivered as part of Arduino IDE contains a bug.](https://github.com/arduino/Arduino/issues/2422)
14+
As such we do not advise to Arduino IDE 1.5.6 till 6.1 on windows. Advised is 1.6.5.
15+
16+
Mac and linux
17+
====
18+
Mac and linux normally come with make preinstalled and do not suffer from the windows bug.
1519

1620
Detailed installation instructions
1721
-----
18-
**Install an Arduino IDE 1.5.0 beta or later**
22+
**Install an Arduino IDE 1.6.5**
1923

2024
1. [Download Arduino ](http://arduino.cc/en/Main/Software)
2125
2. Unzip in a local folder without spaces. (I assume c:/Arduino)
@@ -46,6 +50,6 @@ You want the C++ version
4650
**Party success**
4751

4852
1. drink a beer
49-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
53+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")
5054

5155

‎Eclipse update site/WebContent/fragments/how_to/install_V2_product.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,19 @@ If you are not sure what you want to install please see the
77

88
WINDOWS USERS BE AWARE
99
====
10+
From Arduino IDE 1.5.6 make is no longer part of the Arduino IDE.
11+
[Watch this movie to see how to fix.](https://www.youtube.com/watch?v=cspLbTqBi7k)
12+
Moreover the [toolchain delivered as part of Arduino IDE contains a bug.](https://github.com/arduino/Arduino/issues/2422)
13+
As such we do not advise to Arduino IDE 1.5.6 till 6.1 on windows. Advised is 1.6.5.
14+
In windows unpack is a 2 step process. I use 7Zip to uncompress and then I use 7Zip to unpak the tar file.
1015

11-
1. From Arduino IDE 1.5.6 make is no longer part of the Arduino IDE.
12-
2. Moreover the [toolchain delivered as part of Arduino IDE contains a bug.](https://github.com/arduino/Arduino/issues/2422)
13-
As such we do not advise to Arduino IDE 1.5.6 or later on windows.
14-
Mac and linux normally come with make preinstalled and do not suffer the bug.
15-
3. In windows unpack is a 2 step process. I use 7Zip to uncompress and then I use 7Zip to unpak the tar file.
16+
Mac and linux
17+
====
18+
Mac and linux normally come with make preinstalled and do not suffer from the windows bug.
1619

1720
Detailed installation instructions
1821
-----
19-
**Install an Arduino IDE 1.5.0 beta or later**
22+
**Install an Arduino IDE 1.6.5**
2023

2124
1. [Download Arduino ](http://arduino.cc/en/Main/Software)
2225
2. Unzip in a local folder without spaces. (I assume c:/arduino)
@@ -31,6 +34,6 @@ Detailed installation instructions
3134
**Party success**
3235

3336
1. drink a beer
34-
2. [Buy Jantje a beer](http://eclipse.baeyens.it/donate.html "thanks")
37+
2. [Become a patron of jantje](http://eclipse.baeyens.it/donate.html "thanks")
3538

3639

0 commit comments

Comments
 (0)