@impact0815/node-red-contrib-home-connect 0.0.0-stage → 0.2.1

package/examples/README.de.md

@@ -0,0 +1,62 @@
+# Home-Connect-Beispiel-Flows
+
+**[English](README.md) · Deutsch**
+
+Diese Beispiele sind so erklärt, dass sie auch ohne Programmierkenntnisse nutzbar sind. Am besten mit dem integrierten Simulator beginnen: Er verwendet kein Home-Connect-Konto, keine Zugangsdaten und kein echtes Gerät.
+
+## Vor dem Start
+
+1. `@impact0815/node-red-contrib-home-connect` installieren.
+2. Node-RED neu starten und den Editor neu laden.
+3. Für die drei Dashboard-Beispiele zusätzlich `@flowfuse/node-red-dashboard` installieren:
+
+   ```bash
+   cd ~/.node-red
+   npm install @flowfuse/node-red-dashboard
+   ```
+
+## Mitgeliefertes Beispiel importieren
+
+1. Node-RED öffnen.
+2. **Menü → Import → Beispiele → @impact0815/node-red-contrib-home-connect** wählen.
+3. Ein Beispiel auswählen.
+4. **Importieren** anklicken.
+5. Oben rechts **Deployen** anklicken.
+
+Für den Einstieg **01-first-steps-device-list** verwenden. Danach links am Inject-Node auf den Knopf drücken. In der Debug-Seitenleiste sollten drei simulierte Geräte erscheinen.
+
+## Welches Beispiel passt?
+
+| Beispiel | Geeignet für | Vorgehen |
+|---|---|---|
+| `01-first-steps-device-list.json` | Erster Test | Deployen, Inject-Knopf drücken, Geräteliste im Debug-Fenster ansehen. |
+| `02-events.json` | Live-Änderungen | Deployen und simulierte Ereignisse im Debug-Fenster verfolgen. |
+| `03-safe-read-write.json` | Sicherer Schreibtest | **Dry-Run** eingeschaltet lassen. Der Flow prüft einen Befehl, sendet ihn aber nicht. |
+| `04-local-read-only.json` | Lokale LAN-Profile | Beispielverbindung durch die eigene lokale Read-only-Verbindung ersetzen. Der Flow enthält keinen Write-Node. |
+| `dashboard-dishwasher-washer-oven.json` | Vollständiges Dashboard | Deployen und `/dashboard/overview` öffnen. Unterstützt Cloud und lokales Read-only. |
+| `dashboard-screenshot-simulated.json` | Demo ohne Netzwerk | Deployen und Dashboard öffnen. Alle Geräte und Werte sind simuliert. |
+| `demo-home-connect-flowfuse-1.34.1-scriptless.json` | Isolierte Oberflächen-Demo | Importieren, wenn nur das Dashboard ohne Home-Connect-Runtime-Nodes oder Netzwerkzugriff ausprobiert werden soll. |
+
+## Vom Simulator zu den eigenen Geräten
+
+1. Zuerst prüfen, ob der gewählte Flow mit dem Simulator funktioniert.
+2. Entweder eine **Production-Cloud-Verbindung** oder eine **Local-LAN-Verbindung (read-only)** anlegen.
+3. Jeden Home-Connect-Node im importierten Flow öffnen und die eigene Verbindung auswählen.
+4. **Fertig**, danach **Deployen** anklicken.
+5. Für Cloud-Zugriff die OAuth-Autorisierung abschließen und nur die benötigten Rechte vergeben.
+6. Cloud-Write-Nodes auf **Dry-Run** lassen, bis Gerät, Befehl und Werte eindeutig geprüft sind.
+
+Lokaler LAN-Zugriff ist immer nur lesend. Ein lokaler Schreibversuch wird vor jedem Netzwerkzugriff abgewiesen.
+
+## Wenn nichts angezeigt wird
+
+- Prüfen, ob Node-RED nach der Installation neu gestartet wurde.
+- Prüfen, ob der Flow deployt wurde.
+- Debug-Seitenleiste öffnen und kontrollieren, ob ein Filter Meldungen ausblendet.
+- Bei Dashboards prüfen, ob `@flowfuse/node-red-dashboard` installiert ist.
+- Bei Cloud-Flows die deployte Verbindung testen und OAuth-Rechte prüfen.
+- Siehe [deutsche Troubleshooting-Anleitung](../docs/TROUBLESHOOTING.de.md) oder [englische Troubleshooting-Anleitung](../docs/TROUBLESHOOTING.md).
+
+## Sicherheit und Datenschutz
+
+Nie Client Secrets, Tokens, Profil-PSK/IV, echte Geräte-IDs, private Adressen oder Flows mit Zugangsdaten weitergeben. Zuerst simulierte Daten und Dry-Run verwenden. Gerätesteuerung kann Hitze, Bewegung und Wasserverbrauch auslösen.

package/examples/README.md

@@ -0,0 +1,62 @@
+# Home Connect example flows
+
+**English · [Deutsch](README.de.md)**
+
+These examples are designed to be usable without programming knowledge. Start with the built-in simulator: it uses no Home Connect account, no credentials, and no real appliance.
+
+## Before you start
+
+1. Install `@impact0815/node-red-contrib-home-connect`.
+2. Restart Node-RED and reload the editor.
+3. For the three dashboard examples, also install `@flowfuse/node-red-dashboard`:
+
+   ```bash
+   cd ~/.node-red
+   npm install @flowfuse/node-red-dashboard
+   ```
+
+## Import an included example
+
+1. Open Node-RED.
+2. Choose **Menu → Import → Examples → @impact0815/node-red-contrib-home-connect**.
+3. Select an example.
+4. Click **Import**.
+5. Click **Deploy** in the upper-right corner.
+
+Start with **01-first-steps-device-list**. Press the button on the left side of its Inject node. The Debug sidebar should show three simulated appliances.
+
+## Which example should I choose?
+
+| Example | Good for | What to do |
+|---|---|---|
+| `01-first-steps-device-list.json` | First test | Deploy, press the Inject button, read the appliance list in Debug. |
+| `02-events.json` | Live changes | Deploy and watch simulated events in Debug. |
+| `03-safe-read-write.json` | Safe writing test | Keep **dry-run** enabled. The flow validates a command but does not send it. |
+| `04-local-read-only.json` | Local LAN profiles | Replace the example connection with your own read-only local configuration. It contains no Write node. |
+| `dashboard-dishwasher-washer-oven.json` | Full dashboard | Deploy, then open `/dashboard/overview`. It supports cloud and local read-only data. |
+| `dashboard-screenshot-simulated.json` | Network-free demo | Deploy and open the dashboard. All appliances and values are simulated. |
+| `demo-home-connect-flowfuse-1.34.1-scriptless.json` | Isolated UI demo | Import when you only want to explore the dashboard without Home Connect runtime nodes or network access. |
+
+## Moving from the simulator to your appliances
+
+1. First confirm that the chosen flow works with the simulator.
+2. Create either a **Production cloud** connection or a **Local LAN (read-only)** connection.
+3. Open every Home Connect node in the imported flow and select your own connection.
+4. Click **Done**, then **Deploy**.
+5. For cloud access, complete OAuth authorization and use only the permissions you need.
+6. Keep cloud Write nodes in **dry-run** until the displayed appliance, command, and values are correct.
+
+Local LAN access is always read-only. A local Write request is rejected before network I/O.
+
+## If nothing appears
+
+- Confirm that Node-RED was restarted after installation.
+- Confirm that the flow was deployed.
+- Open the Debug sidebar and check whether its filter is hiding messages.
+- For dashboards, confirm that `@flowfuse/node-red-dashboard` is installed.
+- For cloud flows, test the deployed connection and verify OAuth scopes.
+- See the [English troubleshooting guide](../docs/TROUBLESHOOTING.md) or [German troubleshooting guide](../docs/TROUBLESHOOTING.de.md).
+
+## Safety and privacy
+
+Never share Client Secrets, tokens, profile PSK/IV values, real appliance IDs, private addresses, or exported flows containing credentials. Use simulated data and dry-run first. Appliance control can cause heat, motion, and water use.