Skip to content

Commit d95e00f

Browse files
committed
Add docs
1 parent c001156 commit d95e00f

File tree

4 files changed

+52
-3
lines changed

4 files changed

+52
-3
lines changed

docs/Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ gem "jekyll", "~> 4.3.4" # installed by `gem jekyll`
66
gem "just-the-docs", "0.10.0" # pinned to the current release
77
# gem "just-the-docs" # always download the latest release
88
gem "jekyll-default-layout"
9+
10+
gem "kramdown"

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Development
2+
3+
```bash
4+
bundle exec jekyll serve
5+
```
6+
7+
[http://127.0.0.1:4000](http://127.0.0.1:4000)

docs/_config.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,15 @@ plugins:
1616

1717
head_scripts:
1818
#https://github.com/esphome/esp-web-tools/issues/515#issuecomment-2387664391
19-
- https://unpkg.com/esp-web-tools@8.0.6/dist/web/install-button.js?module
19+
- https://unpkg.com/esp-web-tools@8.0.6/dist/web/install-button.js?module
20+
21+
callouts:
22+
warning:
23+
title: Warning
24+
color: red
25+
note:
26+
title: Note
27+
color: blue
28+
important:
29+
title: Important
30+
color: blue

docs/index.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Home
33
layout: home
44
---
55

6-
# OpenSpool Firmware Installation
6+
# 📟 OpenSpool Firmware Installation
77

88
<div class="install-container">
99
<script type="module" src="https://unpkg.com/esp-web-tools@8.0.6/dist/web/install-button.js"></script>
1010

11-
<h2>Install the firmware</h2>
11+
<h2> 🔩 Install the firmware</h2>
1212

1313
<div class="button-row">
1414
<esp-web-install-button
@@ -28,6 +28,35 @@ layout: home
2828
<p><strong>Note:</strong> Installation requires Chrome or Edge browser on desktop</p>
2929
</div>
3030
</div>
31+
32+
# 🛠️ Configuration
33+
34+
Once the firmware is installed, You will need to join the RFID reader to the same network as your 3d printer.
35+
36+
37+
## 🛜 Wireless Configuration
38+
39+
1. Join the wifi network 'OpenSpool'
40+
2. Navigate to [192.168.4.1](http://192.168.4.1)
41+
3. Enter your wifi credentials
42+
4. Reboot the RFID Reader
43+
44+
45+
## 🖨️ Printer Configuration
46+
47+
Once openspool has joined your network, navigate to `openspool-xxXXxx.local` (where xxXXxx are the last 6 digits of the mac address). Or the ip address.
48+
49+
{: .note }
50+
Mac/Linux: `arp -a| grep openspool`
51+
Windows: `arp -a`
52+
53+
Enter your Printer IP, LAN Access Code and Serial Number
54+
55+
![](./images/printersettings.png)
56+
57+
{: .note }
58+
`Printer IP`, `Lan Access Code` and `Serial Number` are stored locally on the microcontroller and never leave the device. Do not share your Acces Code with anyone.
59+
3160
----
3261

3362
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/

0 commit comments

Comments
 (0)