Skip to content

Commit 2c1b158

Browse files
committed
Update README for version 2.0.0
1 parent c5ffbfd commit 2c1b158

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,19 @@ Currently included are:
1616
- Arduino Uno Shield
1717
- Arduino Zero Shield
1818
- Arduino Pro Mini Socket
19+
- Pro Mini Clone Socket
1920

2021
Shield means the Arduino is designed to plug in from beneath your PCB; socket means it is designed to plug in from above.
2122

23+
# Compatibility with KiCad 5
24+
This library is in the new KiCad 6 "S-Expressions" format, and is not compatible with KiCad 5. If you need compatibility with KiCad 5, please use version 1.4.1 of this repository - but be aware that said version does not contain all features and is not being maintained.
25+
2226
## Comments, Requests, Bugs & Contributions
2327
All are welcome.
2428
Please file an Issue or Pull Request at https://github.com/Alarm-Siren/arduino-kicad-library
2529

2630
## License
27-
Copyright 2017-2019, Nicholas Parks Young. All Rights Reserved.
31+
Copyright 2017-2022, Nicholas Parks Young. All Rights Reserved.
2832
This library is licensed under the GNU LGPL v2.1, which can be found in file LICENSE.txt.
2933

3034
## Donations
@@ -35,14 +39,20 @@ If you've found this library useful and you'd like to make a donation towards it
3539

3640
## Library Setup
3741
To add this library to your KiCad Project, do the following steps:
38-
1. Copy the source files to your Project. Make sure that the Arduino.pretty folder structure is preserved.
39-
2. In Eeschema (the schematic editor of KiCad) go to Preferences -> Component Libraries. Click the "Add" button next to "Component library files".
40-
3. Navigate to your project folder, select "arduino.lib" and click "open".
41-
4. You may wish to adjust the newly added arduino schematic library to be near the top of the load order using the "Up" and "Down" buttons, but this is optional and is only relevant if you have other libraries that use the same names for parts.
42-
5. OK out and exit Eeschema. Open Pcbnew (the PCB editor of KiCad) go to Preferences -> Footprint Libraries Manager.
43-
6. Select the "Project Specific Libraries" tab and then click "Append Library".
44-
7. In the new line of the table, set Library Path to "$(KIPRJMOD)\Arduino.pretty" on Windows or "$(KIPRJMOD)/Arduino.pretty" on Linux/Mac, and ensure Plugin Type is "KiCad". Options and Description can be left blank. You should set Nickname to something descriptive - like "Arduino" for example!
45-
8. All done: you are now ready to use these schematic components and footprints!
42+
1. Copy the source files to the root of your KiCad project's folder. Make sure that the Arduino.pretty folder structure is preserved.
43+
2. In Schematic Editor go to "Preferences" -> "Manage Symbol Libraries..." menu option.
44+
3. In the Symbol Libraries dialogue that appears, switch to the "Project Specific Libraries" tab.
45+
4. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
46+
5. In the new line of the table, set Library Path to "${KIPRJMOD}\arduino.kicad_sym" on Windows or "${KIPRJMOD}/arduino.kicad_sym" on Linux/Mac, and ensure Plugin Type is "KiCad".
47+
6. You can leave the Options and Description fields blank. You should set Nickname to something descriptive - for example, "Arduino Library".
48+
7. Close the Symbol Libraries dialogue and exit Schematic Editor.
49+
8. In PCB Editor go to "Preferences" -> "Manage Footprint Libraries..." menu option.
50+
9. In the Footprint Libraries Libraries dialogue that appears, switch to the "Project Specific Libraries" tab.
51+
10. Click "Add empty row to table" button (the button with a big cross in it, beneath the table).
52+
11. In the new line of the table, set Library Path to "${KIPRJMOD}\Arduino.pretty" on Windows or "${KIPRJMOD}/Arduino.pretty" on Linux/Mac, and ensure Plugin Type is "KiCad".
53+
12. You can leave the Options and Description fields blank. You should set Nickname to something descriptive - for example, "Arduino Library".
54+
13. Close the Footprint Libraries dialogue and exit PCB Editor.
55+
14. All done: you are now ready to use these schematic components and footprints!
4656

4757
## A note about Power and Reset pins
4858

@@ -53,6 +63,8 @@ Regardless of the above, I needed to make a decision about what electrical type
5363

5464
Therefore, I have decided to use Power Input as this presents the least issues. This means if you're actually using any of the power pins as Power Outputs in your schematic, by default the ERC will complain that the relevant nets are undriven. To fix this you will need to add the special "PWR_FLAG" component to the affected net.
5565

66+
NOTE: As of version 2.0.0, on the 5V-based Arduino boards the 3.3V output pin has been changed to Power Output, as these will be powered by an on-board regulator and should not have external power fed into them.
67+
5668
### Reset
5769
Reset pins on the Arduino Platform have interesting electrical characteristics, which mean that no KiCad electrical type exactly matches their functionality. I settled on Open Collector as the nearest candidate, but unlike a true Open Collector pin on an integrated circuit, the reset pins on the Arduino Platform have an internal weak pull-up, and the reset button that can strongly pull low, so your circuit needs to be able to cope with all these situations.
5870

0 commit comments

Comments
 (0)