Build Your First SpoolSense Scanner¶
This is the shortest path from no hardware to your first successful spool scan. You do not need a display, keypad, middleware, Home Assistant, or a special printer to get started.
Before you buy anything¶
SpoolSense can always scan and identify compatible NFC tags. Connecting the scan to a printer depends on your printer and firmware.
The recommended beginner build¶
You can choose among several supported boards and readers later. For a first build, use this combination:
| Part | Recommended choice | Why |
|---|---|---|
| Microcontroller | ESP32-WROOM DevKit | Common, inexpensive, and enough pins for future extras |
| NFC reader | PN5180 | Supports every SpoolSense tag format |
| First tags | NTAG215 stickers | Cheap and supported by both reader types |
| Connections | 8 female-to-female jumper wires | No breadboard required |
| Power | A data-capable USB cable | Used for flashing and power |
Already own different hardware?
That may work too. See all supported boards and reader options before buying replacements.
Your path to the first scan¶
Get the five parts above
Use the full shopping list for search terms and optional alternatives.
Connect the PN5180 to the ESP32
Follow the pin-by-pin PN5180 wiring guide. Double-check 3.3V and ground before connecting USB.
Flash and configure the scanner
Open the web flasher in Chrome or Edge, select ESP32-WROOM, and follow the Wi-Fi setup.
Scan your first tag
Place an NTAG215 sticker over the reader. The scanner web interface will show its UID and let you register it.
Choose what to connect next¶
Your scanner is useful on its own. Pick only the next step that matches what you want to accomplish.
Register tags and keep filament details and remaining weight in one place.
Set up Spoolman → Dashboard Add Home AssistantExpose material, color, weight, and scanner status as dashboard sensors.
Connect Home Assistant → Printer Connect Klipper or AFCAssign spools to tools or lanes and send filament information to your printer.
Set up printer integration →Add extras only when you want them¶
A TFT display, character LCD, status LED, and keypad are optional. Once the basic scanner works, use the extras guide to decide whether any of them improve your workflow.
Need help?
Visit Troubleshooting, ask in the SpoolSense Discord, or open an issue on GitHub.