Skip to content

Adding API Password deprecation information. #1382

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Adding API Password deprecation information. #1382

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4b560a3
Update README.rst
generalmat82 Oct 7, 2025
c7f8a6f
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 7, 2025
f135d74
Update README.rst
generalmat82 Oct 7, 2025
848b3f8
Update README.rst
generalmat82 Oct 7, 2025
96ba39c
Merge branch 'main' into patch-1
generalmat82 Oct 10, 2025
40b9c39
Merge branch 'main' into patch-1
generalmat82 Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,15 @@ Usage

It's required that you enable the `Native API <https://esphome.io/components/api.html>`_ component for the device.

The use of passwords for APIs in ESPHome is deprecated. Using an encryption key is the recommended method.

.. code:: yaml

# Example configuration entry
api:
password: 'MyPassword'
encryption:
key: 'aaaaaaaaaaaaaaaaa/aaaaaaaaaaaaaaaaaaaaaaaaa=' # A key can be obtained at https://next.esphome.io/components/api/

Check the output to get the local address of the device or use the ``name:``under ``esphome:`` from the device configuration.

Expand All @@ -60,7 +64,13 @@ The sample code below will connect to the device and retrieve details.
"""Connect to an ESPHome device and get details."""

# Establish connection
api = aioesphomeapi.APIClient("api_test.local", 6053, "MyPassword")

# If a password is used in the ESP configuration use the following line:
api = aioesphomeapi.APIClient("api_test.local", 6053, "MyPassword",noise_psk='aaaaaaaaaaaaaaaaa/aaaaaaaaaaaaaaaaaaaaaaaaa=')
# OR
#If there is no password used in the ESP configuration:
api = aioesphomeapi.APIClient("api_test.local", 6053, None,noise_psk='aaaaaaaaaaaaaaaaa/aaaaaaaaaaaaaaaaaaaaaaaaa=')

await api.connect(login=True)

# Get API version of the device's firmware
Expand All @@ -86,7 +96,11 @@ Subscribe to state changes of an ESPHome device.

async def main():
"""Connect to an ESPHome device and wait for state changes."""
cli = aioesphomeapi.APIClient("api_test.local", 6053, "MyPassword")
# If a password is used in the ESP configuration use the following line:
cli = aioesphomeapi.APIClient("api_test.local", 6053, "MyPassword",noise_psk='aaaaaaaaaaaaaaaaa/aaaaaaaaaaaaaaaaaaaaaaaaa=')
# OR
#If there is no password used in the ESP configuration:
cli = aioesphomeapi.APIClient("api_test.local", 6053, None, noise_psk='aaaaaaaaaaaaaaaaa/aaaaaaaaaaaaaaaaaaaaaaaaa=')

await cli.connect(login=True)

Expand Down