forked from Apollon77/ioBroker.homeconnect
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move german docu to seperated README_de.md
- Loading branch information
Showing
2 changed files
with
122 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
|  | ||
|
|
||
| # ioBroker.homeconnect | ||
|
|
||
| [](https://github.com/iobroker-community-adapters/ioBroker.homeconnect/blob/main/LICENSE) | ||
| [](https://www.npmjs.com/package/iobroker.homeconnect) | ||
|  | ||
| [](https://weblate.iobroker.net/engage/adapters/?utm_source=widget)</br> | ||
|  | ||
|  | ||
|  | ||
|  | ||
| </br> | ||
| **Version:** </br> | ||
| [](https://www.npmjs.com/package/iobroker.homeconnect) | ||
|  | ||
|  | ||
| </br> | ||
| **Tests:** </br> | ||
| [](https://github.com/iobroker-community-adapters/ioBroker.homeconnect/actions/workflows/test-and-release.yml) | ||
| [](https://github.com/iobroker-community-adapters/ioBroker.homeconnect/actions/workflows/codeql.yml) | ||
|
|
||
| ## Sentry | ||
| **This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.** | ||
| For more details and for information how to disable the error reporting see [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0. | ||
|
|
||
| ## Homeconnect Adapter for ioBroker | ||
|
|
||
| ## Voraussetzungen vor der Installation | ||
|
|
||
| Es muß mindestens Node.js Version 18 installiert sein!! | ||
|
|
||
| Für den Adapter wird eine ClientID benötigt. Nutze die Einstellungen um jeden Schritt der Registrierung zu erreichen. | ||
|
|
||
| <https://developer.home-connect.com> | ||
|
|
||
|  | ||
|
|
||
| Bei **Default Home Connect User Account for Testing** die E-Mail-Adresse angeben, mit der die Home-Connect-App | ||
| registriert wurde, diese wird später auch beim Authorization-Prozess benötigt. | ||
|
|
||
|  | ||
|
|
||
| Bei **Account Type** Individual auswählen. Die restlichen Daten sofern vorhanden ergänzen (keine Ahnung, ob das geprüft wird). | ||
|
|
||
|  | ||
|
|
||
| Dann auf **Applications** und anschließend auf **Register Application** gehen. | ||
|
|
||
|  | ||
|
|
||
| Bei **Application ID** einen Namen für die Application eintragen, z.B. ioBroker. Bei **OAuth Flow** Device Flow selektieren. | ||
| **Home Connect User Account for Testing** kann leer bleiben. Bei **Success Redirect** eine URI eintragen, z.B. https://example.com. | ||
| Dann Speichern und dann hat man die benötigte ClientID. | ||
|
|
||
| ## Konfiguration | ||
|
|
||
| In der Adapter-Config muss der Homeconnect App Benutzername und Passwort und die erstellte ClientID eingetragen werden. | ||
|
|
||
| ## Benutzung | ||
|
|
||
| Mit den states in commands kannst du das Programm stoppen, pausieren oder fortführen. | ||
|
|
||
| Mit den states in settings kannst du das Gerät ein oder ausschalten. | ||
|
|
||
| Ändern des States programs.active.BSH_Common_Root_ActiveProgram führt zum starten eines Programms | ||
| Update iQ300: Es muss das gewüschnte Programm eingetragen werden. Wenn man programs.selected.BSH_Common_Root_SelectedProgram ausliest und einträgt, hat der User die Möglichkeit am Gerät des gewünschte Programm auszuwählen, welches dann per ioBroker gestartet wird. | ||
|
|
||
| Ändern des States programs.selected.BSH_Common_Root_SelectedProgram führt zum auswählen des Programms oder Optionen | ||
|
|
||
| Wenn man checken möchte, ob ein Programm fertig ist muss | ||
|
|
||
| status.BSH_Common_Status_OperationState | ||
|
|
||
| auf den kompletten Status Name übrprüft werden: | ||
|
|
||
| BSH.Common.EnumType.OperationState.Finished | ||
|
|
||
| Weitere Zustände sind noch: | ||
|
|
||
| "BSH.Common.EnumType.OperationState.Inactive": "Inactive", | ||
| "BSH.Common.EnumType.OperationState.Ready": "Ready", | ||
| "BSH.Common.EnumType.OperationState.Run": "Run", | ||
| "BSH.Common.EnumType.OperationState.ActionRequired": "ActionRequired", | ||
| "BSH.Common.EnumType.OperationState.Finished": "Finished" | ||
|
|
||
| Oder ob ein Gerät geöffnet ist | ||
|
|
||
| "BSH.Common.EnumType.DoorState.Open": "Open", | ||
| "BSH.Common.EnumType.DoorState.Closed": "Closed" | ||
|
|
||
| ## Changelog | ||
|
|
||
| Der Changelog findet sich in der englischen README.md Datei. | ||
|
|
||
| ## License | ||
|
|
||
| The MIT License (MIT) | ||
|
|
||
| Copyright (c) 2024 iobroker-community-adapters <[email protected]> | ||
| Copyright (c) 2023 dna909 <[email protected]>, TA2k | ||
|
|
||
| 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. |