Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
spuder committed Nov 3, 2024
1 parent d95e00f commit 1977df5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ Track all your filament with NFC tags



## Official Documentation: [openspool.io](https://openspool.io)


Adhere NFC stickers on all your filament. Build an ESP32 OpenSpool reader and place it next to your printer.
Touching the filament to the reader will automatically update your Bambu Printer filament settings.
Expand Down Expand Up @@ -137,6 +139,10 @@ In order to comply with the [OpenSourceRfid standard](https://github.com/Bambu-R

## Firmware

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.

Alternativly the firmware can be installed with `make` commands as shown below.

### OSX/Linux

```
Expand Down Expand Up @@ -166,9 +172,9 @@ TODO: Document windows flashing procedure

## First Time Configuration

A new wifi network will appear called `OpenSpool-xxxx`, join the network, navigate to [192.168.4.1](http://192.168.4.1), insert your wifi credentials and reboot.
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.

You can then navigate to the web interface at `openspool.local` or ip address.
You can then navigate to the web interface at `openspool-xxxxxx.local` or ip address.


## Configuration
Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ layout: home
</div>
</div>

{: .note}
If the above step fails, see the [README on github](https://github.com/spuder/OpenSpool) for running `make run-usb` command to upload manually.

# 🛠️ Configuration

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

0 comments on commit 1977df5

Please sign in to comment.