Fehlermeldung API Password deprecated on… für ESPHome beheben

Mit Home Assistant 2023.2 wurde erneut auch einiges an der Integration von ESPHome in Home Assistant getan. Seit dem Update habe ich für einige meiner ESP-Boards die Fehlermeldung API Password deprecated on… erhalten. Diese Fehlermeldung ist das Ergebnis des mit 2023.2 als veraltet (deprecated) eingestuften API Passworts für die Einbindung der ESP-Boards. Die Korrektur ist schnell gemacht und ich erkläre dir hier was du tun musst!

„Damals“, als ESPHome noch ganz neu in Home Assistant war, genügte es, für die Kommunikation von dem ESP-Board mit Home Assistant ein API Passwort zu vergeben. Im Laufe der zwischenzeitlichen Updates, wurde dieses API Passwort als bald veraltet (also deprecated) angekündigt und man soll(te) stattdessen den sichereren Weg über einen Base64 Encryption Key gehen.

Konkret bedeutet dies, das man folgenden Beispielcode des ESP-Boards (also unter ESPHome, Edit)

# Enable Home Assistant API
api:
  password: "einPasswort!"

…gegen folgenden Beispielcode austauschen muss:

api:
  encryption:
    key: "zsbJinXcw1UictAdz/VdGLG+cA/qMpy9Mua2uUQKTHs="

Einen solchen Base64 Encryption Key generiert dir die ESPHome-Seite automatisch. Bei jedem Aufruf wird ein neuer, zufälliger solcher Key generiert, denn du kopieren und nutzen kannst (grün umrandet von mir):

Du magst Home Assistant? Dann abonniere kostenlos meine Beiträge mit Tipps, Tricks und Anleitungen rund um Home Assistant:

Follow Home Assistant
( 410 Followers )
X

Follow Home Assistant

E-mail : *
* Ich stimme der Datenschutzerklärung zu!

Garantiert kein Spam, keine Werbung und immer mit Abmelde-Link, solltest du es dir anders überlegen!

Base63 Encryption Key für ESPHome

Dann muss man das ESP-Board mit dem neuen Programmcode versorgen, diesen also installieren (was in der Regel über WiFi also Wireless erfolgen dürfte).

Sobald das ESP-Board dann mit dem neuen Programmcode startet, wird es sich nicht mehr mit Home Assistant verbinden können, da du ja das alte Passwort entfernt hast, über welches die Verbindung bislang authentifiziert wurde.

In den ESPHome-Logs wird dir eine wie folgt aussehende Fehlermeldung gezeigt werden:

[21:08:19][W][api.connection:071]: ::FFFF:192.168.1.15: Socket operation failed: HANDSHAKESTATE_READ_FAILED errno=11

Ab hier hilft dir dann aber Home Assistant weiter (deswegen mögen wir Home Assistant ja so sehr! ;)) und wird dir unter Integrations anbieten, das ESP-Board neu zu konfigurieren. Führst du diesen Schritt durch, wird dir ein Eingabefeld für den Base64 Encryption Key angezeigt. Hier gibst du den zuvor im Code genutzten Key an. Fertig!

Ich hatte einzelne ESP-Boards, bei denen nach dem Entfernen des API Passworts das Board nicht automatisch unter Integrations zum Neu konfigurieren angezeigt wurde (auch nicht nach einigem Warten). Warum dies so ist, kann ich aktuell noch nicht sagen. Bei mir hat es in einem solchen Fall aber geholfen, das „alte“ ESP-Board zu löschen und dann das Board wie ein neues erneut hinzuzufügen.

Bei diesem Vorgehen haben bei mir alle Entitäten ihre Namen behalten und sind weiterhin uneingeschränkt nutzbar!

Dieser Beitrag ist Teil einer kleinen Beitrags-Serie rund um den hass.io Home Assistant.

Produktempfehlungen

Schreibe einen Kommentar