You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Many 3d printer fillament companies are uniting around a open standared called `OpenTag`. It planned to be finalized in early-mid 2025. OpenSpool will support OpenTag formatted tags as soon as it is finalized. See [here](https://github.com/Bambu-Research-Group/RFID-Tag-Guide/blob/main/OpenSourceRfid.md) for more information.
49
+
Many 3d printer filament companies are uniting around an open standard called `OpenTag`. It planned to be finalized in early-mid 2025. OpenSpool will support OpenTag formatted tags as soon as it is finalized. See [here](https://github.com/Bambu-Research-Group/RFID-Tag-Guide/blob/main/OpenTag.md) for more information.
50
50
51
51
### 🧬 OpenSpool Protocol
52
52
@@ -55,10 +55,9 @@ OpenSpool aims to use the simplest possible protocol for RFID tags. All you need
Currently OpenSpool works with Bambu printers over mqtt. Other integrations are planned. Pull Requests welcome
94
+
Currently, OpenSpool works with Bambu printers over MQTT. Other integrations are planned. Pull Requests welcome
96
95
97
-
| Integration | Supported |
98
-
| --- | --- |
99
-
| Bambu | ✅ |
100
-
| OctoPrint | 🚧 In Progress |
101
-
| Prusa Connect | 🗓️ Planned |
102
-
| SpoolMan | 🗓️ Planned |
103
-
| Klipper / Moonraker | 🗓️ Planned |
104
-
| Anker | ❔ |
96
+
| Integration | Supported|
97
+
| -------------------|------------- |
98
+
| Bambu | ✅|
99
+
| OctoPrint | 🚧 In Progress |
100
+
| Prusa Connect | 🗓️ Planned|
101
+
| SpoolMan | 🗓️ Planned|
102
+
| Klipper / Moonraker | 🗓️ Planned |
103
+
| Anker | ❔ |
105
104
106
105
## 🔧 Hardware
107
106
108
107
OpenSpool requires an ESP32-S3 and PN532 NFC Reader (SPI Mode).
109
108
110
-
The openspool schematics will always be free. If you don't want to source the parts yourself, you can
109
+
The OpenSpool schematics will always be free. If you don't want to source the parts yourself, you can
111
110
[buy a kit on tindie.com](https://www.tindie.com/products/36746/)
112
111
113
112
<ahref="https://www.tindie.com/stores/spuder/?ref=offsite_badges&utm_source=sellers_spuder&utm_medium=badges&utm_campaign=badge_small"><imgsrc="https://d2ss6ovg47m0r5.cloudfront.net/badges/tindie-smalls.png"alt="I sell on Tindie"width="200"height="55"></a>
@@ -118,28 +117,28 @@ The openspool schematics will always be free. If you don't want to source the pa
118
117
119
118
120
119
121
-
|| Hardware | Link 1 | Link 2|
122
-
| --- | --- | --- | ---|
123
-
|| Wemos D1 Mini s3 ||[Aliexpress](https://www.aliexpress.us/item/3256805262904443.html?gatewayAdapt=glo2usa)|
|<imgsrc="./images/wemos-d1minis3.png"alt="D1 Mini s3"height="200"> | Wemos D1 Mini s3 ||[AliExpress](https://www.aliexpress.us/item/3256805262904443.html?gatewayAdapt=glo2usa)|
If you are unable to find a Wemos D1 Mini `s3`, you can stil buy an `s2`, as it is pin compatable. However be advised the `s2` has less memory and may expierence occassional disconnects from the printer
130
+
If you are unable to find a Wemos D1 Mini `s3`, you can still buy an `s2`, as it is pin compatable. However, be advised the `s2` has less memory and may experience occasional disconnects from the printer
132
131
133
-
|| Hardware | Link 1 | Link 2|
134
-
| --- | --- | --- | ---|
135
-
|| Wemos D1 Mini S2 (Beware of Fakes!)|[Amazon](https://amzn.to/4fqq9m7)|[Aliexpress](https://www.aliexpress.us/item/3256802958877264.html)|
|<imgsrc="./images/wemos-d1mini.png"alt="D1 Mini s3"height="200"> | Wemos D1 Mini S2 (Beware of Fakes!)|[Amazon](https://amzn.to/4fqq9m7)|[AliExpress](https://www.aliexpress.us/item/3256802958877264.html)|
136
135
137
136
138
-
| Tag | Bytes | Supported |
139
-
| --- | --- | ---|
140
-
| NTAG 213 | 144 bytes | ❌ |
141
-
| NTAG 215 | 504 bytes | ✅ |
142
-
| NTAG 216 | 888 bytes | ✅ |
137
+
| Tag | Bytes | Supported |
138
+
| --------| ---------| --------- |
139
+
| NTAG 213 | 144 bytes | ❌ |
140
+
| NTAG 215 | 504 bytes | ✅ |
141
+
| NTAG 216 | 888 bytes | ✅ |
143
142
144
143
145
144
# Wiring Diagram
@@ -156,9 +155,9 @@ Be sure to put the PN532 into `SPI` mode (not `i2c` or `UART`)
156
155
157
156
## 🤖 Firmware
158
157
159
-
The recomended method to install firmware is by navigating to [openspool.io](https://openspool.io) in Chrome/Edge and using the web based programming tool.
158
+
The recommended method to install firmware is by navigating to [openspool.io](https://openspool.io) in Chrome/Edge and using the web based programming tool.
160
159
161
-
Alternativly the firmware can be installed with `make` commands as shown below.
160
+
Alternatively the firmware can be installed with `make` commands as shown below.
162
161
163
162
### OSX/Linux
164
163
@@ -170,7 +169,7 @@ cd OpenSpool/firmware
170
169
```
171
170
172
171
Press and hold the D0 button while pressing the reset button on the Wemos D1 Mini.
173
-
A new usb serial device will appear.
172
+
A new USB serial device will appear.
174
173
175
174
```bash
176
175
ls /dev/cu*
@@ -190,14 +189,14 @@ USB_ADDRESS=/dev/cu.usbmodemXXXXX make lolin_s3_mini
190
189
191
190
## 🛜 First Time Configuration
192
191
193
-
A new wifi network will appear called `OpenSpool`, join the network, navigate to [192.168.4.1](http://192.168.4.1), insert your wifi credentials and reboot.
192
+
A new Wi-Fi network will appear called `OpenSpool`, join the network, navigate to [192.168.4.1](http://192.168.4.1), insert your Wi-Fi credentials and reboot.
194
193
195
-
You can then navigate to the web interface at `openspool-xxxxxx.local` or ip address.
194
+
You can then navigate to the web interface at `openspool-xxxxxx.local` or IP address.
196
195
197
196
198
197
## 🎛️ Configuration
199
198
200
-
On first boot, you will need to specify your 3d printer IP Address, Serial Number and Lan Access Code.
199
+
On first boot, you will need to specify your 3d printer IP Address, Serial Number and LAN Access Code.
201
200
202
201
Do not put your printer into LAN Only Mode, it is not required.
203
202
@@ -212,15 +211,15 @@ Upon successful connection to the 3d printer, you will observe a checkmark next
212
211
## Factory Reset
213
212
214
213
Press and hold the D0 button for 10 seconds.
215
-
This will erase wifi credentials and bambu access credentials from esp32.
214
+
This will erase Wi-Fi credentials and Bambu access credentials from esp32.
216
215
217
216
# 🔧 Troubleshooting
218
217
219
218
### LED is breathing blue
220
-
This means the OpenSpool is hosting a wireless access point called 'OpenSpool'. Connect to it then navigate to [192.168.4.1](http://192.168.4.1) to configure wifi.
219
+
This means the OpenSpool is hosting a wireless access point called 'OpenSpool'. Connect to it then navigate to [192.168.4.1](http://192.168.4.1) to configure Wi-Fi.
221
220
222
221
### LED is solid white
223
-
OpenSpool has succesfully joined the wifi network and is ready to scan for RFID tags
222
+
OpenSpool has successfully joined the Wi-Fi network and is ready to scan for RFID tags
224
223
225
224
226
225
### NFC Tags aren't reading reliably
@@ -229,19 +228,19 @@ If using the red NP5332 reader (smaller model), it detects tags best on the corn
229
228
230
229
If using the blue PN532 reader (larger model), it detects tags best directly in the center of the antenna.
231
230
232
-
Be sure you aren't using a [counterfit PN532](https://forum.dangerousthings.com/t/success-pn532-is-not-easy-to-work-with/1108/10)
231
+
Be sure you aren't using a [counterfeit PN532](https://forum.dangerousthings.com/t/success-pn532-is-not-easy-to-work-with/1108/10)
233
232
234
233
### MQTT Disconnects
235
234
236
235
The A1/P1 have a limit of 4 mqtt connections. If more than 4 connections are reached clients may be asked to disconnect.
237
236
238
237
If a client attempts to write invalid data any mqtt topic, the printer will ask the client to disconnect.
239
-
All esphome resources must use `state_topic:` with a null value to prevent esphome from broadcasting on any topic.
238
+
All ESPhome resources must use `state_topic:` with a null value to prevent ESPhome from broadcasting on any topic.
240
239
241
240
242
241
### TLS Errors
243
242
244
-
Reach out to the discord for help verifying that the Root Certificate is correct.
243
+
Reach out to the discord for help to verify that the Root Certificate is correct.
0 commit comments