Python API for interacting with ESPHome devices.
Project description
aioesphomeapi allows you to interact with devices flashed with ESPHome.
Installation
The module is available from the Python Package Index.
$ pip3 install aioesphomeapiAn optional cython extension is available for better performance, and the module will try to build it automatically.
The extension requires a C compiler and Python development headers. The module will fall back to the pure Python implementation if they are unavailable.
Building the extension can be forcefully disabled by setting the environment variable SKIP_CYTHON to 1.
Usage
It’s required that you enable the Native API component for the device.
# Example configuration entry
api:
password: 'MyPassword'Check the output to get the local address of the device or use the name:``under ``esphome: from the device configuration.
[17:56:38][C][api:095]: API Server:
[17:56:38][C][api:096]: Address: api_test.local:6053The sample code below will connect to the device and retrieve details.
import aioesphomeapi
import asyncio
async def main():
"""Connect to an ESPHome device and get details."""
# Establish connection
api = aioesphomeapi.APIClient("api_test.local", 6053, "MyPassword")
await api.connect(login=True)
# Get API version of the device's firmware
print(api.api_version)
# Show device details
device_info = await api.device_info()
print(device_info)
# List all entities of the device
entities = await api.list_entities_services()
print(entities)
loop = asyncio.get_event_loop()
loop.run_until_complete(main())Subscribe to state changes of an ESPHome device.
import aioesphomeapi
import asyncio
async def main():
"""Connect to an ESPHome device and wait for state changes."""
cli = aioesphomeapi.APIClient("api_test.local", 6053, "MyPassword")
await cli.connect(login=True)
def change_callback(state):
"""Print the state changes of the device.."""
print(state)
# Subscribe to the state changes
await cli.subscribe_states(change_callback)
loop = asyncio.get_event_loop()
try:
asyncio.ensure_future(main())
loop.run_forever()
except KeyboardInterrupt:
pass
finally:
loop.close()Other examples:
Development
For development is recommended to use a Python virtual environment (venv).
# Setup virtualenv (optional)
$ python3 -m venv .
$ source bin/activate
# Install aioesphomeapi and development depenencies
$ pip3 install -e .
$ pip3 install -r requirements_test.txt
# Run linters & test
$ script/lint
# Update protobuf _pb2.py definitions (requires a protobuf compiler installation)
$ script/gen-protocA cli tool is also available for watching logs:
aioesphomeapi-logs --helpA cli tool is also available to discover devices:
aioesphomeapi-discoverLicense
aioesphomeapi is licensed under MIT, for more details check LICENSE.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file aioesphomeapi-24.4.0.tar.gz.
File metadata
- Download URL: aioesphomeapi-24.4.0.tar.gz
- Upload date:
- Size: 99.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8eeec0b0d4e30d42d497994bdbfaf3e4daaa8b97c0946b4ffe530e018c16906a |
|
| MD5 | aa4086388bab01b5deb477c0f8bf76ac |
|
| BLAKE2b-256 | 955321fc40705d7e30299796a0c98fa1ed6b4ea282e158f2ebb341c6298d082f |
File details
Details for the file aioesphomeapi-24.4.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: aioesphomeapi-24.4.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 2.4 MB
- Tags: CPython 3.12, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7f9205b7fa3819b8f1e382c03eed8a25433ac19ff72e6782f3b53c7cfef3946f |
|
| MD5 | 145224e871c7ab63df97ce35658907aa |
|
| BLAKE2b-256 | 2b380494e7459f92ca5b763147c3c6266e1f90de3642a60f0080ad0fc65ebca7 |
File details
Details for the file aioesphomeapi-24.4.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.
File metadata
- Download URL: aioesphomeapi-24.4.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
- Upload date:
- Size: 2.3 MB
- Tags: CPython 3.12, manylinux: glibc 2.17+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3d005f0100eb6d90e3024d0a0361096eff2aa03ebb1fc4da1e3dbb8de8c84a00 |
|
| MD5 | f7a9a4d80239ef7686a4c8140645bc28 |
|
| BLAKE2b-256 | afb0927a234433d6cdf44436348c597c5d69ce4f9c2e7f8989529c24e3093ea1 |
File details
Details for the file aioesphomeapi-24.4.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl.
File metadata
- Download URL: aioesphomeapi-24.4.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl
- Upload date:
- Size: 2.2 MB
- Tags: CPython 3.12, manylinux: glibc 2.17+ i686, manylinux: glibc 2.5+ i686
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 48b227c176a3709af0aadd1dbcf3438cb9a537394221ee411ebbe68963125904 |
|
| MD5 | 496bdc6e90085bbd63f314c6206d1961 |
|
| BLAKE2b-256 | 0a92a557f883d990b2fb9c2902def6d77d9d0992bedc444f3be1408b75a6a8c4 |
File details
Details for the file aioesphomeapi-24.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: aioesphomeapi-24.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 2.3 MB
- Tags: CPython 3.11, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04fb9f52737b31fd73a7b299baeffcb9cc4d811a67609f153456b74e899e2be6 |
|
| MD5 | bf1cb96df987dcb3bbac91673160f04c |
|
| BLAKE2b-256 | c01ef124a3e012d17fc95aaf08f2f92d8dcb621002bde465a0b2ae80dafbf5a8 |
File details
Details for the file aioesphomeapi-24.4.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.
File metadata
- Download URL: aioesphomeapi-24.4.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
- Upload date:
- Size: 2.3 MB
- Tags: CPython 3.11, manylinux: glibc 2.17+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7a94e0b00a0c95f9fe210309b7b92869bf3cc282d5b5b56db7b4ecbe9a5a61c1 |
|
| MD5 | e5ea747496fd16f52bf7c32f972816cb |
|
| BLAKE2b-256 | 57c144fcdf3beb5262daf4043e38b94bcf8392ad518abb13b47bdfb7f275faa1 |
File details
Details for the file aioesphomeapi-24.4.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl.
File metadata
- Download URL: aioesphomeapi-24.4.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl
- Upload date:
- Size: 2.2 MB
- Tags: CPython 3.11, manylinux: glibc 2.17+ i686, manylinux: glibc 2.5+ i686
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 321d032038b66979071ba073d751380dd6e84d397bff24b59cc1d3800d73c092 |
|
| MD5 | b9c5deaee5c8421843b256b9330a9dec |
|
| BLAKE2b-256 | 5e67b9b9be2ef5c25dff93c41e871a93844721e42e7c07cbb727b4d19244013c |
