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

package/docs/official-api-contract.json

@@ -0,0 +1,418 @@
+{
+  "schemaVersion": 1,
+  "source": "Official Home Connect Swagger 2.0 specifications supplied with the project review",
+  "specifications": [
+    {
+      "file": "hcsdk-simulation.yaml",
+      "sha256": "5942f5ca450a46fa9a6f53ff6d13627972040f105dcd786efddcf9a44ce376a3",
+      "swagger": "2.0",
+      "host": "simulator.home-connect.com",
+      "basePath": "/api",
+      "consumes": [
+        "application/vnd.bsh.sdk.v1+json"
+      ],
+      "produces": [
+        "application/vnd.bsh.sdk.v1+json"
+      ],
+      "operations": [
+        {
+          "method": "GET",
+          "path": "/api/homeappliances",
+          "operationId": "get_home_appliances"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}",
+          "operationId": "get_specific_appliance"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs",
+          "operationId": "get_all_programs"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/available",
+          "operationId": "get_available_programs"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/available/{programkey}",
+          "operationId": "get_available_program"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/active",
+          "operationId": "get_active_program"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/active",
+          "operationId": "start_program"
+        },
+        {
+          "method": "DELETE",
+          "path": "/api/homeappliances/{haId}/programs/active",
+          "operationId": "stop_program"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/active/options",
+          "operationId": "get_active_program_options"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/active/options",
+          "operationId": "set_active_program_options"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/active/options/{optionkey}",
+          "operationId": "get_active_program_option"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/active/options/{optionkey}",
+          "operationId": "set_active_program_option"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/selected",
+          "operationId": "get_selected_program"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/selected",
+          "operationId": "set_selected_program"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/selected/options",
+          "operationId": "get_selected_program_options"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/selected/options",
+          "operationId": "set_selected_program_options"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/selected/options/{optionkey}",
+          "operationId": "get_selected_program_option"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/selected/options/{optionkey}",
+          "operationId": "set_selected_program_option"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/images",
+          "operationId": "get_images"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/images/{imagekey}",
+          "operationId": "get_image"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/settings",
+          "operationId": "get_settings"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/settings",
+          "operationId": "set_settings"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/settings/{settingkey}",
+          "operationId": "get_setting"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/settings/{settingkey}",
+          "operationId": "set_setting"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/status",
+          "operationId": "get_status"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/status/{statuskey}",
+          "operationId": "get_status_value"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/events",
+          "operationId": "get_all_events"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/events",
+          "operationId": "get_events"
+        }
+      ],
+      "oauth": {
+        "type": "oauth2",
+        "flow": "accessCode",
+        "authorizationUrl": "https://simulator.home-connect.com/security/oauth/authorize",
+        "tokenUrl": "https://simulator.home-connect.com/security/oauth/token"
+      }
+    },
+    {
+      "file": "hcsdk-production.yaml",
+      "sha256": "a0704118d429eb1a7becf9d624068a2c48ce8d7c0a2250128be2487ff0758c57",
+      "swagger": "2.0",
+      "host": "api.home-connect.com",
+      "basePath": "/api",
+      "consumes": [
+        "application/vnd.bsh.sdk.v1+json"
+      ],
+      "produces": [
+        "application/vnd.bsh.sdk.v1+json"
+      ],
+      "operations": [
+        {
+          "method": "GET",
+          "path": "/api/homeappliances",
+          "operationId": "get_home_appliances"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}",
+          "operationId": "get_specific_appliance"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs",
+          "operationId": "get_all_programs"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/available",
+          "operationId": "get_available_programs"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/available/{programkey}",
+          "operationId": "get_available_program"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/active",
+          "operationId": "get_active_program"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/active",
+          "operationId": "start_program"
+        },
+        {
+          "method": "DELETE",
+          "path": "/api/homeappliances/{haId}/programs/active",
+          "operationId": "stop_program"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/active/options",
+          "operationId": "get_active_program_options"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/active/options",
+          "operationId": "set_active_program_options"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/active/options/{optionkey}",
+          "operationId": "get_active_program_option"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/active/options/{optionkey}",
+          "operationId": "set_active_program_option"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/selected",
+          "operationId": "get_selected_program"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/selected",
+          "operationId": "set_selected_program"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/selected/options",
+          "operationId": "get_selected_program_options"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/selected/options",
+          "operationId": "set_selected_program_options"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/programs/selected/options/{optionkey}",
+          "operationId": "get_selected_program_option"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/programs/selected/options/{optionkey}",
+          "operationId": "set_selected_program_option"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/images",
+          "operationId": "get_images"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/images/{imagekey}",
+          "operationId": "get_image"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/settings",
+          "operationId": "get_settings"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/settings",
+          "operationId": "set_settings"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/settings/{settingkey}",
+          "operationId": "get_setting"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/settings/{settingkey}",
+          "operationId": "set_setting"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/status",
+          "operationId": "get_status"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/status/{statuskey}",
+          "operationId": "get_status_value"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/commands",
+          "operationId": "get_available_commands"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/commands",
+          "operationId": "put_commands"
+        },
+        {
+          "method": "PUT",
+          "path": "/api/homeappliances/{haId}/commands/{commandkey}",
+          "operationId": "put_command"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/events",
+          "operationId": "get_all_events"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/events",
+          "operationId": "get_events"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps",
+          "operationId": "get_maps"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}",
+          "operationId": "get_map"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/occupancyGrid",
+          "operationId": "get_map_occupancy_grid"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/layout",
+          "operationId": "get_map_layout"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus",
+          "operationId": "get_map_cleaning_status"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects",
+          "operationId": "get_map_detected_objects"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/cleaningStatus/objects/{objectId}",
+          "operationId": "get_map_detected_object"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/rooms",
+          "operationId": "get_map_rooms"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/rooms/{roomId}",
+          "operationId": "get_map_room"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/zones",
+          "operationId": "get_map_zones"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/maps/{mapId}/zones/{zoneId}",
+          "operationId": "get_map_zone"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/robot/position",
+          "operationId": "get_map_robot_position"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/config/restrictions",
+          "operationId": "get_map_config_restrictions"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/cleaningSummary",
+          "operationId": "get_map_cleaning_summaries"
+        },
+        {
+          "method": "GET",
+          "path": "/api/homeappliances/{haId}/map/cleaningSummary/{counter}",
+          "operationId": "get_map_cleaning_summary"
+        }
+      ],
+      "oauth": {
+        "type": "oauth2",
+        "flow": "accessCode",
+        "authorizationUrl": "https://api.home-connect.com/security/oauth/authorize",
+        "tokenUrl": "https://api.home-connect.com/security/oauth/token"
+      }
+    }
+  ]
+}

package/examples/01-first-steps-device-list.json

@@ -0,0 +1,148 @@
+[
+  {
+    "id": "hc-list-flow",
+    "type": "tab",
+    "label": "Home Connect 01 – Geräteliste",
+    "disabled": false,
+    "info": "Einfachster Start: lokale Testgeräte automatisch erkennen. Keine Zugangsdaten erforderlich."
+  },
+  {
+    "id": "hc-list-note",
+    "type": "comment",
+    "z": "hc-list-flow",
+    "name": "1. Deployen  2. Knopf links klicken  3. Debug-Fenster öffnen",
+    "info": "Der integrierte Simulator führt keine externen Zugriffe aus. Für Production später eine eigene deployte und autorisierte Verbindung auswählen. Outputs include health/warnings (home-connect-health/v1). No firmware data or undocumented endpoint is used.",
+    "x": 310,
+    "y": 40,
+    "wires": []
+  },
+  {
+    "id": "hc-list-config",
+    "type": "home-connect-config",
+    "name": "Home Connect – integrierter Simulator",
+    "environment": "builtin-simulator",
+    "redirectUri": "http://localhost:1880/home-connect/oauth/callback",
+    "scope": "IdentifyAppliance",
+    "language": "de-DE",
+    "allowWrite": false,
+    "requestTimeout": 15000,
+    "maxRequestsPerDay": 900,
+    "minimumRequestInterval": 250
+  },
+  {
+    "id": "hc-list-inject",
+    "type": "inject",
+    "z": "hc-list-flow",
+    "name": "Geräteliste laden",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": true,
+    "onceDelay": 1,
+    "topic": "",
+    "payload": "",
+    "payloadType": "date",
+    "x": 140,
+    "y": 100,
+    "wires": [
+      [
+        "hc-list-discover"
+      ]
+    ]
+  },
+  {
+    "id": "hc-list-discover",
+    "type": "home-connect-discover",
+    "z": "hc-list-flow",
+    "name": "Alle Geräte erkennen",
+    "connection": "hc-list-config",
+    "mode": "all",
+    "haId": "",
+    "x": 370,
+    "y": 100,
+    "wires": [
+      [
+        "hc-list-summary",
+        "hc-list-debug-raw"
+      ],
+      [
+        "hc-list-debug-error"
+      ]
+    ]
+  },
+  {
+    "id": "hc-list-summary",
+    "type": "function",
+    "z": "hc-list-flow",
+    "name": "Einfache Geräteliste",
+    "func": "msg.payload=(msg.payload||[]).map(entry=>({name:entry.appliance?.name,brand:entry.appliance?.brand,type:entry.appliance?.type,vib:entry.appliance?.vib,connected:entry.appliance?.connected,health:entry.health,warnings:entry.warnings,haId:entry.appliance?.haId}));\nreturn msg;",
+    "outputs": 1,
+    "timeout": 0,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 610,
+    "y": 80,
+    "wires": [
+      [
+        "hc-list-debug-simple"
+      ]
+    ]
+  },
+  {
+    "id": "hc-list-debug-simple",
+    "type": "debug",
+    "z": "hc-list-flow",
+    "name": "Geräteliste (einfach)",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 870,
+    "y": 80,
+    "wires": []
+  },
+  {
+    "id": "hc-list-debug-raw",
+    "type": "debug",
+    "z": "hc-list-flow",
+    "name": "Vollständige Capabilities",
+    "active": false,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 630,
+    "y": 130,
+    "wires": []
+  },
+  {
+    "id": "hc-list-debug-error",
+    "type": "debug",
+    "z": "hc-list-flow",
+    "name": "Fehler",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "msg",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 610,
+    "y": 180,
+    "wires": []
+  }
+]