adafruit-mirror/PrettyPins
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Initial update.

Browse source
This commit is contained in:
Kattni Rembor 2021-11-15 15:38:26 -05:00
parent d4b7c6df5d
commit d7de9b41fb
1 changed files with 33 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -1,9 +1,38 @@
# PrettyPins
examples:
PrettyPins is designed to create lovely pinout diagrams.
## Requirements
The following is a list of required software and files necessary to run PrettyPins:
* A local clone of the PrettyPins repository
* The Fritzing object file for the board for which you are generating a diagram (available [here](https://github.com/adafruit/Fritzing-Library/tree/master/parts))
* An SVG editor, such as InkScape (free and available for all major OS's) or Illustrator (not free, and not available for all major OS's)
* Python 3 installed on your machine
* A local clone of the CircuitPython repository (for boards that support CircuitPython)
* The latest Arduino core for the board-type you're working with installed on your machine (for boards that support Arduino)
RP2040:
## Running PrettyPins
1. Place the Fritzing object file in the PrettyPins directory.
2. Run the PrettyPins command as shown below.
3. In the case of Arduino support, you must run the command TWICE for the Arduino pins to show up.
4. Open the `output.svg` and `pinlabels.svg` files into your SVG editor.
5. Save the `output.svg` file as something else, such as the name of the board you're diagramming.
* In Illustrator, when you "Save as", click "Ok", (and "Yes" to replacing the file if it already exists), then, under "Advanced Options", change "CSS Properties" to "Presentation Attributes". and "Decimal Places" to "4". Then, click Ok.
6. Copy the different seconds of labels out of `pinlabels.svg` into your working board file, and arrange them properly.
* For pins that are not easily accessible (such as NeoPixels or displays), either draw extra lines to the pin location, or create an icon for the pin next to the board and attach the labels to that.
* If you are replacing an old diagram (as with many of the ATtiny boards), include any notes from the original diagram in the new one.
7. Verify the pin label layout with Kattni by providing a screenshot of your working board file.
8. Finalise the diagram with the pin legend, any text blocks and the title/URL.
9. Save the SVG as follows:
* In Illustrator, do "Save as", click "Ok", (and "Yes" to replacing the file if it already exists), then, under "Advanced Options", change "CSS Properties" to "Presentation Attributes". and "Decimal Places" to "4". Then, click Ok.
* In Inkscape, save the file.
10. Finally, save the file as both a PDF and a PNG as well.
## Example PrettyPins Command Structure by Board Type
These are some examples of what the PrettyPins commandline command looks like, based on board chip type.
#### RP2040:
RP2040 does not have official Arduino support (yet).
```python3 parser.py "Adafruit Feather RP2040.fzpz" path/to/circuitpython/ports/raspberrypi/boards/adafruit_feather_rp2040/pins.c rp2040pins.csv```
@ -11,7 +40,7 @@ RP2040:
```python3 parser.py "Adafruit QT Py RP2040.fzpz" path/to/circuitpython/ports/raspberrypi/boards/adafruit_qtpy_rp2040/pins.c rp2040pins.csv```
ESP32-S2:
#### ESP32-S2:
```python3 parser.py "Adafruit Metro ESP32-S2.fzpz" path/to/circuitpython/ports/esp32s2/boards/adafruit_metro_esp32s2/pins.c esp32s2pins.csv -s "^D([0-9])" "IO\1"```
@ -19,7 +48,7 @@ ESP32-S2:
```python3 parser.py "Adafruit FunHouse.fzpz" path/to/circuitpython/ports/esp32s2/boards/adafruit_funhouse/pins.c esp32s2pins.csv -s "^D([0-9])" "IO\1"```
nRF52:
#### nRF52:
```python3 parser.py "Adafruit Feather nRF52840.fzpz" path/to/circuitpython/ports/nrf/boards/feather_nrf52840_express/pins.c nrf52840pins.csv -a ~/Library/Arduino15/packages/adafruit/hardware/nrf52/0.20.5/variants/feather_nrf52840_express```