Skip to content

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
spuder committed Nov 3, 2024
1 parent c001156 commit d95e00f
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@ gem "jekyll", "~> 4.3.4" # installed by `gem jekyll`
gem "just-the-docs", "0.10.0" # pinned to the current release
# gem "just-the-docs" # always download the latest release
gem "jekyll-default-layout"

gem "kramdown"
7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Development

```bash
bundle exec jekyll serve
```

[http://127.0.0.1:4000](http://127.0.0.1:4000)
13 changes: 12 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,15 @@ plugins:

head_scripts:
#https://github.com/esphome/esp-web-tools/issues/515#issuecomment-2387664391
- https://unpkg.com/[email protected]/dist/web/install-button.js?module
- https://unpkg.com/[email protected]/dist/web/install-button.js?module

callouts:
warning:
title: Warning
color: red
note:
title: Note
color: blue
important:
title: Important
color: blue
33 changes: 31 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ title: Home
layout: home
---

# OpenSpool Firmware Installation
# 📟 OpenSpool Firmware Installation

<div class="install-container">
<script type="module" src="https://unpkg.com/[email protected]/dist/web/install-button.js"></script>

<h2>Install the firmware</h2>
<h2> 🔩 Install the firmware</h2>

<div class="button-row">
<esp-web-install-button
Expand All @@ -28,6 +28,35 @@ layout: home
<p><strong>Note:</strong> Installation requires Chrome or Edge browser on desktop</p>
</div>
</div>

# 🛠️ Configuration

Once the firmware is installed, You will need to join the RFID reader to the same network as your 3d printer.


## 🛜 Wireless Configuration

1. Join the wifi network 'OpenSpool'
2. Navigate to [192.168.4.1](http://192.168.4.1)
3. Enter your wifi credentials
4. Reboot the RFID Reader


## 🖨️ Printer Configuration

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.

{: .note }
Mac/Linux: `arp -a| grep openspool`
Windows: `arp -a`

Enter your Printer IP, LAN Access Code and Serial Number

![](./images/printersettings.png)

{: .note }
`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.

----

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

0 comments on commit d95e00f

Please sign in to comment.