Skip to content

Commit c26d156

Browse files
committed
Update videos
1 parent e6b4f05 commit c26d156

File tree

1 file changed

+32
-29
lines changed

1 file changed

+32
-29
lines changed

README.md

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,18 @@ Checkout the official documentation on [https://openspool.io](https://openspool.
2121

2222
---
2323

24+
25+
<p align="center">
26+
<img src="https://i.giphy.com/media/v1.Y2lkPTc5MGI3NjExcWxoemp6bTdmNm02c2t5cnF4MGU3M2Znb3d3MWQ1c2E5NnF6YTBkZCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/BmAJiIJ0wcBnsKGBBL/giphy.gif" alt="Centered GIF">
27+
</p>
28+
29+
2430
Adhere NFC stickers on all your filament. Build an ESP32 OpenSpool reader and place it next to your printer.
2531
Touching the filament to the reader will automatically update your Bambu Printer filament settings.
2632
Almost as seamlessly as if you were using Bambu filament with an AMS.
2733

28-
## Objectives
2934

30-
- Make it so easy to put RFID stickers on filament spools that your grandma could do it.
31-
- 100% programable using just a modern iphone/android (no RFID programmer or scripting).
32-
- Change filament in 10 seconds using 1 hand.
33-
- 100% reliability so that filament can be changed with your eyes closed.
3435

35-
## 🎥 Demo
36-
37-
[![](https://img.youtube.com/vi/ah7dm-dtQ5w/0.jpg)](https://youtube.com/watch?v=ah7dm-dtQ5w)
38-
[![](https://img.youtube.com/vi/pWnvJc-8KLI/0.jpg)](https://youtube.com/shorts/pWnvJc-8KLI?si=9-C1rhqrvL1i5CpR)
39-
[![](https://img.youtube.com/vi/kvVpRKFNU9k/0.jpg)](https://www.youtube.com/shorts/kvVpRKFNU9k)
4036

4137

4238
## 🖨️ Protocol
@@ -52,8 +48,7 @@ Almost as seamlessly as if you were using Bambu filament with an AMS.
5248

5349
### 🧬 OpenSpool Protocol
5450

55-
OpenSpool aims to use the simplest possible protocol for RFID tags. All you need is a [13.56Mhz RFID tag](https://a.co/d/5ojDUNk) that supports NDEF records (NFC Tags) and has at least 500 bytes of memory. NTAG 215/216 are a great choice. Purchasing links provided below.
56-
51+
OpenSpool aims to use the simplest possible protocol for RFID tags. All you need is a [NTAG215/216](https://a.co/d/5ojDUNk)
5752
#### NDEF Record
5853

5954
Example record stored on NFC tag.
@@ -73,14 +68,20 @@ payload =
7368
}
7469
```
7570

76-
<img src="./images/phone2.png" width="300">
71+
72+
<p align=center>
73+
<img src="./imagesphone2.png" width="200">
74+
</p>
7775

7876

7977
#### Web Preview
8078

81-
By touching your phone to a spool tag, you can see information about the spool.
79+
Spool information can be seen using your phone.
80+
81+
<p align=center>
82+
<img src="./images/NFC2.png" width="200">
83+
</p>
8284

83-
![](./images/NFC2.png)
8485

8586
```
8687
https://openspool.io/tag_info?color_hex=FFAABB&type=PLA&brand=Generic&min_temp=220&max_temp=240&protocol=openspool&version=1.0
@@ -110,7 +111,6 @@ OpenSpool requires an ESP32-S3 and PN532 NFC Reader (SPI Mode).
110111
| | Hardware | Link 1 | Link 2|
111112
| --- | --- | --- | --- |
112113
| ![](./images/wemos-d1minis3.png) | Wemos D1 Mini s3 | | [Aliexpress](https://www.aliexpress.us/item/3256805262904443.html?gatewayAdapt=glo2usa) |
113-
| ![](./images/pn532-large.png) | PN532 (Large) (Beware of Fakes!) | [Amazon](https://amzn.to/40CVE7R) | [Aliexpress](https://www.aliexpress.us/item/3256806348384449.html)|
114114
| ![](./images/pn532-small.png) | PN532 (Small) | [Amazon](https://amzn.to/4eoBz8s) | [Aliexpress](https://www.aliexpress.us/item/3256805787598774.html)|
115115
| ![](./images/NFC.png) | NTAG 215/216 (13.56Mhz NFC Tags >500 bytes) | [Amazon](https://amzn.to/4epJzpO) | |
116116
| ![](./images/LED1.png) | WS2812B LED | [Amazon](https://amzn.to/40FFOt5) | |
@@ -131,16 +131,6 @@ If you are unable to find a Wemos D1 Mini `s3`, you can stil buy an `s2`, as it
131131
| NTAG 215 | 504 bytes ||
132132
| NTAG 216 | 888 bytes ||
133133

134-
### Caution of Fakes
135-
136-
There is a plethora of fake D1 Mini S2 microcontrollers and PN532 RFID readers in the market.
137-
For the D1 Mini microcontroller, you need the `ESP32-S2FN4R2` not the `ESP32-S2FH4`
138-
For the PN532 RFID reader, you need the model that contains the silkscreen.
139-
140-
141-
While temping to buy a fake/clone esp32 or PN5432 at a lower cost, they inevitibly cause headaches as they are less reliable at reading NFC tags.
142-
Purchasing at reputable vendors is highly recomended.
143-
If you do find a cheaper price and have verified reliablity, please let us know.
144134

145135
# Wiring Diagram
146136

@@ -179,7 +169,13 @@ ls /dev/cu*
179169
Upload firmware and restart
180170

181171
```bash
182-
USB_ADDRESS=/dev/cu.usbmodemXXXXX make run-usb-pcb-mini
172+
USB_ADDRESS=/dev/cu.usbmodemXXXXX make lolin_s2_mini
173+
```
174+
175+
or
176+
177+
```bash
178+
USB_ADDRESS=/dev/cu.usbmodemXXXXX make lolin_s3_mini
183179
```
184180

185181
## 🛜 First Time Configuration
@@ -198,15 +194,15 @@ Do not put your printer into LAN Only Mode, it is not required.
198194
![](./images/PrinterSettings.png)
199195

200196
After changing these 3 settings, you will need to reboot the ESP32.
201-
Upon successful connection to the 3d printer, you will observe a checkmark next to MQTT in the web interface, and a blue LED will illuminate next to the USB port.
197+
Upon successful connection to the 3d printer, you will observe a checkmark next to MQTT in the web interface.
202198

203199
![](./images/WebInterface1.png)
204200

205201

206202
## Factory Reset
207203

208204
Press and hold the D0 button for 10 seconds.
209-
This will erase wifi credentials and bambu access credentials from OpenSpool.
205+
This will erase wifi credentials and bambu access credentials from esp32.
210206

211207
# 🔧 Troubleshooting
212208

@@ -247,6 +243,13 @@ Use the [MQTTX client](https://mqttx.app) to observe the messages that OpenSpool
247243
mqttx sub -t 'device/$SERIAL_NUMBER/report' -u -P $LAN_ACCESS_CODE --mqtt-version 3.1.1 -h $IP_ADDRESS -p 8883 -l mqtts --insecure
248244
```
249245

246+
## 🎥 Demo
247+
248+
[![](https://img.youtube.com/vi/ah7dm-dtQ5w/0.jpg)](https://youtube.com/watch?v=ah7dm-dtQ5w)
249+
[![](https://img.youtube.com/vi/pWnvJc-8KLI/0.jpg)](https://youtube.com/shorts/pWnvJc-8KLI?si=9-C1rhqrvL1i5CpR)
250+
[![](https://img.youtube.com/vi/kvVpRKFNU9k/0.jpg)](https://www.youtube.com/shorts/kvVpRKFNU9k)
251+
252+
250253
# 👥 Contributors
251254

252255
<!-- readme: contributors -start -->

0 commit comments

Comments
 (0)