3D-Druck/Filaman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 110 Wiki Activity

add LICENSE file and update README for clarity and additional support information

Browse Source
This commit is contained in:
Manuel Weiser 2025-02-13 08:29:02 +01:00
parent 412127fce5
commit f49bbdb664
2 changed files with 73 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE.txt Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Manuel Weiser
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

120
README.md
View File

@ -1,10 +1,8 @@
# FilaMan - Filament Management System # FilaMan - Filament Management System
A comprehensive filament management system combining ESP32-based hardware for weight measurement and NFC tag reading/writing with a web interface for managing filament spools in conjunction with Bambu Lab AMS and Spoolman. FilaMan is a filament management system for 3D printing. It uses ESP32 hardware for weight measurement and NFC tag management.
Users can manage filament spools, monitor the status of the Automatic Material System (AMS) and make settings via a web interface.
## Project Overview The system integrates seamlessly with [Bambulab](https://bambulab.com/en-us) 3D printers and [Spoolman](https://github.com/Donkie/Spoolman) filament management as well as the [Openspool](https://github.com/spuder/OpenSpool) NFC-TAG format.
FilaMan is designed to streamline the management of filament spools for 3D printing. The system consists of an ESP32 microcontroller that handles weight measurement and NFC tag operations, and a web interface that allows users to manage filament spools, monitor AMS (Automatic Material System) status, and interact with Spoolman and Bambu Lab printers.
### ESP32 Hardware Features ### ESP32 Hardware Features
- **Weight Measurement:** Using a load cell with HX711 amplifier for precise weight tracking. - **Weight Measurement:** Using a load cell with HX711 amplifier for precise weight tracking.
@ -12,13 +10,15 @@ FilaMan is designed to streamline the management of filament spools for 3D print
- **OLED Display:** Shows current weight, connection status (WiFi, Bambu Lab, Spoolman). - **OLED Display:** Shows current weight, connection status (WiFi, Bambu Lab, Spoolman).
- **WiFi Connectivity:** WiFiManager for easy network configuration. - **WiFi Connectivity:** WiFiManager for easy network configuration.
- **MQTT Integration:** Connects to Bambu Lab printer for AMS control. - **MQTT Integration:** Connects to Bambu Lab printer for AMS control.
- **Data Persistence:** Stores calibration data in EEPROM. - **NFC-Tag NTAG215:** Use NTAG215 because of enaught space on the Tag
- **Watchdog Timer:** Ensures system stability.
### Web Interface Features ### Web Interface Features
- **Real-time Updates:** WebSocket connection for live data updates. - **Real-time Updates:** WebSocket connection for live data updates.
- **NFC Tag Management:** Write filament data to NFC tags. - **NFC Tag Management:**
- **AMS Integration:** - Write filament data to NFC tags.
- uses NFC-Tag Format of [Openspool](https://github.com/spuder/OpenSpool)
- so you can use it with automatic Spool detection in AMS
- **Bambulab AMS Integration:**
- Display current AMS tray contents. - Display current AMS tray contents.
- Assign filaments to AMS slots. - Assign filaments to AMS slots.
- Support for external spool holder. - Support for external spool holder.
@ -28,6 +28,9 @@ FilaMan is designed to streamline the management of filament spools for 3D print
- Update spool weights automatically. - Update spool weights automatically.
- Track NFC tag assignments. - Track NFC tag assignments.
### If you want to support my work, i would be happy to get a coffe
<a href="https://www.buymeacoffee.com/manuelw" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>
## Detailed Functionality ## Detailed Functionality
### ESP32 Functionality ### ESP32 Functionality
@ -39,49 +42,19 @@ FilaMan is designed to streamline the management of filament spools for 3D print
- **User Interactions:** The web interface allows users to interact with the system, select filaments, write NFC tags, and monitor AMS status. - **User Interactions:** The web interface allows users to interact with the system, select filaments, write NFC tags, and monitor AMS status.
- **UI Elements:** Includes dropdowns for selecting manufacturers and filaments, buttons for writing NFC tags, and real-time status indicators. - **UI Elements:** Includes dropdowns for selecting manufacturers and filaments, buttons for writing NFC tags, and real-time status indicators.
## Installation
### Prerequisites
- **Software:**
- [PlatformIO](https://platformio.org/) in VS Code
- [Spoolman](https://github.com/Donkie/Spoolman) instance
- Bambu Lab printer (optional for AMS integration)
- **Hardware:**
- ESP32 Development Board
- HX711 Load Cell Amplifier
- Load Cell (weight sensor)
- OLED Display (128x64 SSD1306)
- PN532 NFC Module
- Connecting wires
### Step-by-Step Installation
1. **Clone the Repository:**
```bash
git clone https://github.com/yourusername/FilaMan.git
cd FilaMan
```
2. **Install Dependencies:**
```bash
pio lib install
```
3. **Flash the ESP32:**
```bash
pio run --target upload
```
4. **Initial Setup:**
- Connect to the "FilaMan" WiFi access point.
- Configure WiFi settings through the captive portal.
- Access the web interface at `http://filaman.local` or the IP address.
## Hardware Requirements ## Hardware Requirements
### Components ### Components
- **ESP32 Development Board:** Any ESP32 variant. - **ESP32 Development Board:** Any ESP32 variant.
[https://amzn.eu/d/aXThslf](url)
- **HX711 Load Cell Amplifier:** For weight measurement. - **HX711 Load Cell Amplifier:** For weight measurement.
- **Load Cell:** Weight sensor. [https://amzn.eu/d/1wZ4v0x](url)
- **OLED Display:** 128x64 SSD1306. - **OLED Display:** 128x64 SSD1306.
[https://amzn.eu/d/dozAYDU](url)
- **PN532 NFC Module:** For NFC tag operations. - **PN532 NFC Module:** For NFC tag operations.
- **Connecting Wires:** For connections. [https://amzn.eu/d/8205DDh](url)
- **NFC-Tag:** [https://amzn.eu/d/fywy4c4](url)
### Pin Configuration ### Pin Configuration
| Component | ESP32 Pin | | Component | ESP32 Pin |
@ -108,31 +81,39 @@ FilaMan is designed to streamline the management of filament spools for 3D print
- `Adafruit_SSD1306`: OLED display control - `Adafruit_SSD1306`: OLED display control
- `HX711`: Load cell communication - `HX711`: Load cell communication
### External Services ## Installation
- **Bambu Lab Printer:** For AMS integration.
- **Spoolman:** For filament management.
## API Communication ### Prerequisites
- **Software:**
- [PlatformIO](https://platformio.org/) in VS Code
- [Spoolman](https://github.com/Donkie/Spoolman) instance
- **Hardware:**
- ESP32 Development Board
- HX711 Load Cell Amplifier
- Load Cell (weight sensor)
- OLED Display (128x64 SSD1306)
- PN532 NFC Module
- Connecting wires
### Spoolman Integration ### Step-by-Step Installation
The system communicates with Spoolman using its REST API for: 1. **Clone the Repository:**
- Fetching spool information. ```bash
- Updating spool weights. git clone https://github.com/ManuelW77/Filaman.git
- Managing NFC tag assignments. cd FilaMan
### Data Format
```json
{
"version": "2.0",
"protocol": "openspool",
"color_hex": "FFFFFF",
"type": "PLA",
"min_temp": 200,
"max_temp": 220,
"brand": "Vendor",
"sm_id": "1234"
}
``` ```
2. **Install Dependencies:**
```bash
pio lib install
```
3. **Flash the ESP32:**
```bash
pio run --target upload
```
4. **Initial Setup:**
- Connect to the "FilaMan" WiFi access point.
- Configure WiFi settings through the captive portal.
- Access the web interface at `http://filaman.local` or the IP address.
## Documentation ## Documentation
@ -163,4 +144,7 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
## Availability ## Availability
The code can be tested and the application can be downloaded from the [GitHub repository](https://github.com/yourusername/FilaMan). The code can be tested and the application can be downloaded from the [GitHub repository](https://github.com/ManuelW77/Filaman).
### If you want to support my work, i would be happy to get a coffe
<a href="https://www.buymeacoffee.com/manuelw" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>