From 1977df505c600bc41c741b3a69376b26795f2b33 Mon Sep 17 00:00:00 2001 From: Spencer Owen Date: Sun, 3 Nov 2024 15:07:08 -0700 Subject: [PATCH] Readme --- README.md | 10 ++++++++-- docs/index.md | 3 +++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b25b1c8..8e86603 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 ``` @@ -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 diff --git a/docs/index.md b/docs/index.md index be1ec7f..cadbff8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,6 +29,9 @@ layout: home +{: .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.