Skip to content

Commit 6a3b827

Browse files
authored
Merge pull request #22 from bofh69/improve-sketch-docs
Add link to and image of case
2 parents 8a92553 + 18e9f8d commit 6a3b827

File tree

2 files changed

+24
-16
lines changed

2 files changed

+24
-16
lines changed

sketch/README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,20 @@ firmware that interfaces with the NXP PN5180 NFC module.
1717
My terrible prototype board:
1818
![Board](board.jpg)
1919

20+
## Printed case
21+
I've made a simple 3D printable case for it
22+
[here](https://www.printables.com/model/1545289-pn5180-tagomatic-case).
23+
The OnShape model is linked from there.
24+
25+
![The case](case.jpg)
26+
27+
The case is designed to mount on the backside of my Voron 2.4.
28+
It should fit other printers with 2020 frames as well.
29+
30+
The lower lip can be cut off, and optionally the screw hole can be
31+
filled, in the slicer and it can work as a simple,
32+
freestanding case too.
33+
2034
## Pin Connections
2135

2236
| PN5180 Pin | Raspberry Pi Pico Zero Pin |
@@ -50,46 +64,40 @@ of the PN5180. I've not implemented that, and I probably won't.
5064
### Prerequisites
5165

5266
The firmware requires the FastLED and SimpleRPC libraries.
53-
Install them using one of these methods:
5467

55-
**Arduino IDE:**
56-
1. Go to Sketch > Include Library > Manage Libraries
57-
2. Search for the libraries and install them.
58-
59-
**Arduino CLI:**
60-
```bash
61-
arduino-cli lib install simpleRPC
62-
arduino-cli lib install FastLED
63-
```
6468

6569
### Using Arduino IDE
6670

6771
1. Install the Arduino IDE
6872
2. Add Raspberry Pi Pico board support:
6973
- Go to Tools > Board > Board Manager
7074
- Search for "pico" and install "Arduino Mbed OS RP2040 Boards by Arduino" (version 4.4.1 was used).
71-
3. Install the libraries (see Prerequisites above)
75+
3. Install the libraries:
76+
- Go to Sketch > Include Library > Manage Libraries
77+
- Search for the libraries and install them.
7278
4. Press the select board pulldown: "Select Other Board and Port"
7379
5. Search for pico, choose "Raspberry Pi Pico"
7480
5. Select Port: Tools > Port > (your Pico's port)
7581
6. Upload the sketch (the arrow)
7682

7783
### Using Arduino CLI
7884

79-
This is untested...
80-
8185
```bash
82-
# Install board support
86+
arduino-cli config init
87+
arduino-cli core update-index
8388
arduino-cli core install arduino:mbed_rp2040
8489

90+
8591
# Install the libraries, see [Prerequisites]:
86-
arduino-cli lib install ...
92+
arduino-cli lib install FastLED
93+
arduino-cli lib install simpleRPC
8794

8895
# Compile
89-
arduino-cli compile --fqbn arduino:mbed_rp2040:pico sketch/pn5180_reader
96+
arduino-cli compile -e --fqbn arduino:mbed_rp2040:pico sketch/pn5180_reader
9097

9198
# Upload (replace /dev/ttyACM0 with your port)
9299
arduino-cli upload -p /dev/ttyACM0 --fqbn arduino:mbed_rp2040:pico sketch/pn5180_reader
100+
# (or copy the uf2 file to the bootloader's drive)
93101
```
94102

95103
## Protocol

sketch/case.jpg

33.8 KB
Loading

0 commit comments

Comments
 (0)