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 Supercacher Package Index.
$ pip3 install aioesphomeapi
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:6053
The 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-protoc
License
aioesphomeapi is licensed under MIT, for more details check LICENSE.
Project details
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 Distribution
Hashes for aioesphomeapi-15.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0d68000ef3c7281b6388f857b5e266c81cf5e9872170d56a01dbb83848caf30 |
|
MD5 | 3cc3fac1fd7ebaf240c80a814b575ff1 |
|
BLAKE2b-256 | 0a301975731aed9c01bb33205283e6982eceeaa79f44c7e8b4096162d5704ddf |