docs: German and English documentation for the NFC-only mode
This commit is contained in:
1 parent
728c40f0fa
commit
696b8ba518
6 files changed
+168
-26
No files matched your search
+13
-12
@@ -2,17 +2,18 @@
|
||||
|
||||
⚠️ **Wichtig: Ab Version 3.0.0 erfordert dieses System das [FilaMan-System](https://github.com/Fire-Devils/filaman-system) Backend. Frühere direkte Integrationen (Spoolman, MQTT, Bambu Lab) wurden in das zentrale FilaMan-System verschoben.**
|
||||
|
||||
FilaMan ist ein Werkzeug zur Filamentverwaltung für den 3D-Druck. Es verwendet ESP32-Hardware zur Gewichtsmessung und Verwaltung von NFC-Tags.
|
||||
Benutzer können Filamentspulen verwalten und das Gerät über eine Weboberfläche konfigurieren.
|
||||
FilaMan ist ein Werkzeug zur Filamentverwaltung für den 3D-Druck. Es verwendet ESP32-Hardware zur Gewichtsmessung und Verwaltung von NFC-Tags.
|
||||
Benutzer können Filamentspulen verwalten und das Gerät über eine Weboberfläche konfigurieren.
|
||||
Das System integriert sich nahtlos in das [FilaMan-System](https://github.com/Fire-Devils/filaman-system).
|
||||
|
||||
**NEU ab 3.3.1:** Eine abgespeckte Version ohne Waage ist ebenfalls möglich. Details finden sich unter [NFC-only Modus](docs/NFC-only_mode_de.md).
|
||||
|
||||

|
||||
|
||||
|
||||
Weitere Bilder finden Sie im [img Ordner](/img/)
|
||||
oder auf meiner Website: [FilaMan Website](https://www.filaman.app)
|
||||
Deutsches Erklärvideo: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62zaOHU)
|
||||
Weitere Bilder finden Sie im [img Ordner](/img/)
|
||||
oder auf meiner Website: [FilaMan Website](https://www.filaman.app)
|
||||
Deutsches Erklärvideo: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62zaOHU)
|
||||
Discord Server: [https://discord.gg/my7Gvaxj2v](https://discord.gg/my7Gvaxj2v)
|
||||
|
||||
## NEU: Recycling Fabrik
|
||||
@@ -27,7 +28,7 @@ dass die Spulen automatisch erkannt und über die FilaMan-Waage direkt in das Fi
|
||||
|
||||
**Was ist die Recycling Fabrik?**
|
||||
|
||||
Die Recycling Fabrik ist ein deutsches Unternehmen, das sich der Entwicklung und Herstellung von nachhaltigem 3D-Druck-Filament verschrieben hat.
|
||||
Die Recycling Fabrik ist ein deutsches Unternehmen, das sich der Entwicklung und Herstellung von nachhaltigem 3D-Druck-Filament verschrieben hat.
|
||||
Ihre Filamente bestehen zu 100 % aus recyceltem Material von Endkunden und aus der Industrie – für eine umweltbewusste und ressourcenschonende Zukunft.
|
||||
|
||||
Weitere Informationen und Produkte finden Sie hier: [www.recyclingfabrik.com](https://www.recyclingfabrik.com)
|
||||
@@ -45,7 +46,7 @@ Weitere Informationen und Produkte finden Sie hier: [www.recyclingfabrik.com](ht
|
||||
|
||||
### Weboberflächen-Features
|
||||
- **Echtzeit-Updates:** WebSocket-Verbindung für Live-Datenaktualisierungen.
|
||||
- **NFC-Tag-Verwaltung:**
|
||||
- **NFC-Tag-Verwaltung:**
|
||||
- Schreiben von Filamentdaten auf NFC-Tags.
|
||||
- Unterstützt automatische Spulenerkennung in kompatiblen Systemen.
|
||||
- **FilaMan-System Integration:**
|
||||
@@ -122,7 +123,7 @@ Wenn Sie einen Hersteller-NFC-Tag zum ersten Mal scannen:
|
||||
| PN532 SCL | 22 |
|
||||
| TTP223 I/O | 25 |
|
||||
|
||||
**!! Stellen Sie sicher, dass die DIP-Schalter am PN532 auf I2C eingestellt sind.**
|
||||
**!! Stellen Sie sicher, dass die DIP-Schalter am PN532 auf I2C eingestellt sind.**
|
||||
**Verwenden Sie den 3V-Pin des ESP für den Touch-Sensor.**
|
||||
|
||||

|
||||
@@ -130,10 +131,10 @@ Wenn Sie einen Hersteller-NFC-Tag zum ersten Mal scannen:
|
||||

|
||||

|
||||
|
||||
*Die Wägezelle wird an die meisten HX711-Module wie folgt angeschlossen:
|
||||
E+ rot
|
||||
E- schwarz
|
||||
A- weiß
|
||||
*Die Wägezelle wird an die meisten HX711-Module wie folgt angeschlossen:
|
||||
E+ rot
|
||||
E- schwarz
|
||||
A- weiß
|
||||
A+ grün*
|
||||
|
||||
## Software-Abhängigkeiten
|
||||
|
||||
@@ -2,17 +2,18 @@
|
||||
|
||||
⚠️ **Important: Starting with v3.0.0, this system requires the [FilaMan-System](https://github.com/Fire-Devils/filaman-system) backend. Previous direct integrations (Spoolman, MQTT, Bambu Lab) have been moved to the central FilaMan-System.**
|
||||
|
||||
FilaMan is a filament management tool for 3D printing. It uses ESP32 hardware for weight measurement and NFC tag management.
|
||||
Users can manage filament spools and configure the device via a web interface.
|
||||
FilaMan is a filament management tool for 3D printing. It uses ESP32 hardware for weight measurement and NFC tag management.
|
||||
Users can manage filament spools and configure the device via a web interface.
|
||||
The system integrates seamlessly with the [FilaMan-System](https://github.com/Fire-Devils/filaman-system).
|
||||
|
||||
**NEW since 3.3.1:** A reduced version w/o scale is also available. Details can be found in [NFC-only mode](docs/NFC-only_mode_en.md).
|
||||
|
||||

|
||||
|
||||
|
||||
More Images can be found in the [img Folder](/img/)
|
||||
or my website: [FilaMan Website](https://www.filaman.app)
|
||||
german explanatory video: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62zaOHU)
|
||||
More Images can be found in the [img Folder](/img/)
|
||||
or my website: [FilaMan Website](https://www.filaman.app)
|
||||
german explanatory video: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62zaOHU)
|
||||
Discord Server: [https://discord.gg/my7Gvaxj2v](https://discord.gg/my7Gvaxj2v)
|
||||
|
||||
## NEW: Recycling Fabrik
|
||||
@@ -27,7 +28,7 @@ that the spools can be automatically recognized and imported into the FilaMan-Sy
|
||||
|
||||
**What is Recycling Fabrik?**
|
||||
|
||||
Recycling Fabrik is a German company dedicated to developing and manufacturing sustainable 3D printing filament.
|
||||
Recycling Fabrik is a German company dedicated to developing and manufacturing sustainable 3D printing filament.
|
||||
Their filaments are made from 100% recycled material from both end customers and industry – for an environmentally conscious and resource-saving future.
|
||||
|
||||
More information and products can be found here: [www.recyclingfabrik.com](https://www.recyclingfabrik.com)
|
||||
@@ -45,7 +46,7 @@ More information and products can be found here: [www.recyclingfabrik.com](https
|
||||
|
||||
### Web Interface Features
|
||||
- **Real-time Updates:** WebSocket connection for live data updates.
|
||||
- **NFC Tag Management:**
|
||||
- **NFC Tag Management:**
|
||||
- Write filament data to NFC tags.
|
||||
- Supports automatic Spool detection in compatible systems.
|
||||
- **FilaMan-System Integration:**
|
||||
@@ -122,7 +123,7 @@ When you scan a manufacturer NFC tag for the first time:
|
||||
| PN532 SCL | 22 |
|
||||
| TTP223 I/O | 25 |
|
||||
|
||||
**!! Make sure that the DIP switches on the PN532 are set to I2C**
|
||||
**!! Make sure that the DIP switches on the PN532 are set to I2C**
|
||||
**Use the 3V pin from the ESP for the touch sensor**
|
||||
|
||||

|
||||
@@ -130,10 +131,10 @@ When you scan a manufacturer NFC tag for the first time:
|
||||

|
||||

|
||||
|
||||
*The load cell is connected to most HX711 modules as follows:
|
||||
E+ red
|
||||
E- black
|
||||
A- white
|
||||
*The load cell is connected to most HX711 modules as follows:
|
||||
E+ red
|
||||
E- black
|
||||
A- white
|
||||
A+ green*
|
||||
|
||||
## Software Dependencies
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
# NFC-only Modus
|
||||
|
||||
## Beschreibung
|
||||
Es kann praktisch sein, ein kleines Gerät in der Nähe deines Desktop-Computers zu haben, wenn du neue Spulen in deine Datenbank hinzufügst.
|
||||
So kannst du sofort NFC-Tags für sie schreiben. Da keine Waage erforderlich ist (das Gewicht einer neuen Spule ist in der Regel bekannt), ist es sinnvoll, auf diese Funktion zu verzichten, um einen kleineren Formfaktor zu erreichen.
|
||||
|
||||

|
||||
|
||||
## Bedienung
|
||||
|
||||
Bevor du das NFC-only Terminal verwenden kannst, musst du es in der `FilaMan System App` registrieren, wie bei jeder anderen Waage auch.
|
||||
|
||||
### Tag schreiben
|
||||
Hauptzweck ist das Schreiben neuer NFC-Tags.
|
||||
|
||||
Du startest den Schreibvorgang in der `FilaMan System App` (Web-GUI). Dann wählst du dein NFC-Gerät aus und folgst den Anweisungen auf dem Display.
|
||||
|
||||
### Tag lesen
|
||||
Das Gerät kann Tags zwar lesen, sinnvolle Anwendungsfälle sind jedoch ohne Waage eingeschränkt.
|
||||
Du kannst trotzdem eine Spule identifizieren und ihr einen Standort mit dem entsprechenden Standort-Tag zuweisen.
|
||||
|
||||
Aber ehrlich gesagt: der Hauptzweck des NFC-only Gerätes ist **TAG SCHREIBEN**.
|
||||
|
||||
## NFC-only Modus
|
||||
|
||||
Beim Start versucht der ESP32, den HX711 (Verstärker) zusammen mit einem angeschlossenen Loadcell-Sensor zu erkennen. Wenn das gelingt, startet er im Normalmodus mit voller Funktionalität.
|
||||
|
||||
Andernfalls schaltet er in den **NFC-only Modus**!
|
||||
|
||||
Statt einer Gewichtsanzeige zeigt das Display eine Bereitschaftsmeldung. Zusätzlich ist das Waagensymbol in der oberen Zeile durchgestrichen.
|
||||
|
||||

|
||||
|
||||
## Aufbau / Installation
|
||||
### Hardware
|
||||
Die Verkabelung der Hardware ist gleich wie bei der originalen, voll ausgestatteten FilaMan-Waage. Es gibt nur 3 Unterschiede:
|
||||
|
||||
- Kein HX711 angeschlossen (und natürlich keine Loadcell)
|
||||
- Kein Tastensensor (ohne Waage ist kein Tarieren nötig)
|
||||
- optional: 10k Pull-up-Widerstand an Pin 16 (RX2)
|
||||
|
||||
Der Pull-up-Widerstand ist nicht zwingend erforderlich, erhöht aber die Zuverlässigkeit beim Erkennen eines fehlenden HX711. Ohne Pull-up-Widerstand sollte es aber ebenfalls funktionieren.
|
||||
|
||||

|
||||
|
||||
| Komponente | ESP32 Pin |
|
||||
| ---- | ---- |
|
||||
| 10k Pull-up | 16 |
|
||||
| | 17 |
|
||||
| OLED SDA | 21 |
|
||||
| OLED SCL | 22 |
|
||||
| PN532 IRQ | 32 |
|
||||
| PN532 RESET | 33 |
|
||||
| PN532 SDA | 21 |
|
||||
| PN532 SCL | 22 |
|
||||
|
||||
#### PN532
|
||||
- **!! Stelle sicher, dass die DIP-Schalter des PN532 auf I2C gestellt sind**
|
||||
- Verbinde `VCC` mit 5V
|
||||
|
||||
#### OLED
|
||||
- Verbinde `VCC` mit 3,3V
|
||||
|
||||
#### 10k Widerstand (optional)
|
||||
- Verbinde den Widerstand mit PIN 16 (wo normalerweise der DOUT des HX711 angeschlossen wäre) und 5V
|
||||
|
||||
### Software
|
||||
Folge den Anweisungen in der [Hauptdokumentation](../README.de.md#schritt-für-schritt-installation).
|
||||
|
||||
Du benötigst Version 3.3.1 oder neuer für eine funktionierende Hardware-Erkennung und den NFC-only Modus.
|
||||
@@ -1,6 +1,76 @@
|
||||
# NFC-only mode
|
||||
|
||||
## Description
|
||||
It may be convenient to have a small device near your desktop computer when adding new spools to your database.
|
||||
So you are able to write NFC-tags for them right away. Since there is no need for a scale (the weight of a new
|
||||
It may be convenient to have a small device near your desktop computer when adding new spools to your database.
|
||||
So you are able to write NFC-tags for them right away. Since there is no need for a scale (the weight of a new
|
||||
spool should be well known), it is pleasant to leave the scale functionality out in advance of a smaller footprint.
|
||||
|
||||

|
||||
|
||||
## Usage
|
||||
|
||||
Before you can use the NFC-only device, you have to register it to your FilaMan System App as
|
||||
you would do with any regular scale device.
|
||||
|
||||
### Tag Writing
|
||||
Its main purpose is to write new NFC tags.
|
||||
|
||||
You start the writing process from within the FilaMan System App (Web GUI). You than select
|
||||
your NFC device and follow the instructions on the device display.
|
||||
|
||||
### Tag Reading
|
||||
Although the device is fully capable of tag reading, its use cases are limited due to the lack of a scale.
|
||||
But you can still identify a spool and assign it to a location with the according location tag.
|
||||
|
||||
But to be honest: the main purpose of the NFC-only device is **TAG WRITING**.
|
||||
|
||||
## NFC-only mode
|
||||
|
||||
During startup, the ESP32 tries to detect the HX711 (amplifier) together with a connected
|
||||
loadcell sensor. If successful it starts into normal mode with full functionality.
|
||||
|
||||
Otherwise it switches in **NFC-only mode!**
|
||||
|
||||
Instead of a weight reading the display shows a ready prompts. Additionally the scale icon
|
||||
in the top row is crossed out.
|
||||
|
||||

|
||||
|
||||
## Build / Installation
|
||||
### Hardware
|
||||
The wiring of the hardware is the same as the original, fully equipped FilaMan scale. There are only 3 differences:
|
||||
|
||||
- No HX711 connected (also no loadcell of course)
|
||||
- No touch sensor (without scale there is no need to tare)
|
||||
- optional: 10k pull-up resistor on Pin 16 (RX2)
|
||||
|
||||
The pull-up resistor is not mandatory, but for good measure. It makes it more reliable to
|
||||
detect a missing hx711. But it should also work w/o the pull-up resistor.
|
||||
|
||||

|
||||
|
||||
| Component | ESP32 Pin |
|
||||
| ---- | ---- |
|
||||
| 10k pull-up | 16 |
|
||||
| | 17 |
|
||||
| OLED SDA | 21 |
|
||||
| OLED SCL. | 22 |
|
||||
| PN532 IRQ | 32 |
|
||||
| PN532 RESET | 33 |
|
||||
| PN532 SDA | 21 |
|
||||
| PN532 SCL | 22 |
|
||||
|
||||
#### PN532
|
||||
- !! Make sure that the DIP switches on the PN532 are set to I2C
|
||||
- Connect `VCC` to 5V
|
||||
|
||||
#### OLED
|
||||
- Connect `VCC` to 3.3V
|
||||
|
||||
#### 10k Resistor (optional)
|
||||
- Connect to PIN 16 (where normally the DOUT of the HX711 would connect to) and 5V
|
||||
|
||||
### Software
|
||||
Follow the instructions in the [main readme](../README.md#step-by-step-installation).
|
||||
|
||||
You need version 3.3.1 or later for a working hardware recognition and NFC-only mode.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 205 KiB |
File renamed without changes.
|
Before Width: | Height: | Size: 59 KiB After Width: | Height: | Size: 59 KiB |
Reference in new issue
Block a user