3D-Druck/openspoolman
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improvement: Improve readme

Browse Source
This commit is contained in:
Filip Bednárik 2024-12-13 17:49:39 +01:00
parent 900388cdd3
commit 1530e9de86
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -7,7 +7,7 @@ Similar functionality to https://github.com/spuder/OpenSpool using only your pho
Everything works locally without cloud access, you can use scripts/init_bambulab.py script to access your PRINTER_ID and PRINTER_CODE if it is not available on your printer. Everything works locally without cloud access, you can use scripts/init_bambulab.py script to access your PRINTER_ID and PRINTER_CODE if it is not available on your printer.
What you need: ### What you need:
- Android Phone with Chrome web browser or iPhone (manual process much more complicated) - Android Phone with Chrome web browser or iPhone (manual process much more complicated)
- Server to run OpenSpoolMan with https that is reachable from your Phone and can reach both SpoolMan and Bambu Lab printer on the network - Server to run OpenSpoolMan with https that is reachable from your Phone and can reach both SpoolMan and Bambu Lab printer on the network
- Active Bambu Lab Account or PRINTER_ID and PRINTER_CODE on your printer - Active Bambu Lab Account or PRINTER_ID and PRINTER_CODE on your printer
@ -15,13 +15,13 @@ What you need:
- SpoolMan installed https://github.com/Donkie/Spoolman - SpoolMan installed https://github.com/Donkie/Spoolman
- NFC Tags https://eu.store.bambulab.com/en-sk/collections/nfc/products/nfc-tag-with-adhesive https://www.aliexpress.com/item/1005006332360160.html - NFC Tags https://eu.store.bambulab.com/en-sk/collections/nfc/products/nfc-tag-with-adhesive https://www.aliexpress.com/item/1005006332360160.html
How to setup: ### How to setup:
- Rename config.template to config.py and: - Rename config.env.template to config.env or set environment properies and:
- set BASE_URL - that is the URL where OpenSpoolMan will be available on your network. Must be https for NFC write to work. - set OPENSPOOLMAN_BASE_URL - that is the URL where OpenSpoolMan will be available on your network. Must be https for NFC write to work. without trailing slash
- set PRINTER_ID - On your printer clicking on Setting -> Device -> Printer SN - set PRINTER_ID - On your printer clicking on Setting -> Device -> Printer SN
- set PRINTER_CODE - On your printer clicking on Setting -> Lan Only Mode -> Access Code (you _don't_ need to enable the LAN Only Mode) - set PRINTER_ACCESS_CODE - On your printer clicking on Setting -> Lan Only Mode -> Access Code (you _don't_ need to enable the LAN Only Mode)
- set PRINTER_IP - On your printer clicking on Setting -> Lan Only Mode -> IP Address (you _don't_ need to enable the LAN Only Mode) - set PRINTER_IP - On your printer clicking on Setting -> Lan Only Mode -> IP Address (you _don't_ need to enable the LAN Only Mode)
- set SPOOLMAN_PROTO, _IP, _PORT - according to your SpoolMan installation - set SPOOLMAN_BASE_URL - according to your SpoolMan installation without trailing slash
- Run the server (wsgi.py) - Run the server (wsgi.py)
- Run Spool Man - Run Spool Man
- Add following extra Fields to your SpoolMan: - Add following extra Fields to your SpoolMan:
@ -40,13 +40,21 @@ How to setup:
- On the website pick the slot you put your filament in - On the website pick the slot you put your filament in
- Done - Done
Notes: ### Deployment
Run locally in venv by configuring environment properties and running wsgi.py, supports adhoc ssl.
Run in docker by configuring config.env and running compose.yaml, you will need more setup/config to run ssl.
Run in kubernetes using helm chart, where you can configure the ingress with SSL. https://github.com/truecharts/public/blob/master/charts/library/common/values.yaml
### Notes:
- If you change the BASE_URL of this app, you will need to reconfigure all NFC TAGS - If you change the BASE_URL of this app, you will need to reconfigure all NFC TAGS
TBD: ### TBD:
- Filament remaining in AMS (I have only AMS lite, if you have AMS we can test together) - Filament remaining in AMS (I have only AMS lite, if you have AMS we can test together)
- Filament spending based on printing - Filament spending based on printing
- Evidently needed GUI improvements - Evidently needed GUI improvements
- Code cleanup - Code cleanup
- Video showcase - Video showcase
- Docker compose SSL
- TODOs - TODOs