HomeAssistant WS wrapper library
Project description
hass-client
Home Assistant async API wrapper
API Documentation
Example Usage:
from hass_ws import HassWS
async def main():
client = await HassWS("wss://server.hass", "token")
print(await client.fetch_states()) # Displays all HASS states
print(await client.call_service("light", "turn_on")) # Turns on all lights
async with client.listen_event(type="call_service") as listener:
async for i in listener:
print(i)
await client.close()
HassWS Interface:
await HassWS(server: str, token: str)
server
: Required, str. Base server URL of HASS instance, includingwss://
orws://
protocol specifier.token
: Required, str. Long-lived HASS access token.
Properties/Members:
HassWS().ready
: Boolean value,True
if the client is ready to send commands.HassWS().meta
:HassMeta
, server metadata.None
if not connected.
Methods:
await HassWS().close()
: Closes the currently active connection. To reconnect, callawait HassWS().authenticate()
await HassWS().fetch_states() -> HassEntity[]
: Returns current states of all entities.await HassWS().fetch_config() -> HassConfig
: Returns current server configawait HassWS().fetch_services() -> {domain: {service: HassService}}
: Returns all available servicesawait HassWS().fetch_panels() -> {name: HassPanel}
: Returns all UI panelsawait HassWS().call_service(domain: str, service: str, target: HassServiceTarget = {}, data: dict = {}) -> bool
: Calls a service, returning boolean success value.async with HassWS().listen_event(type: str = None) -> AsyncIterator
: Subscribes to an event (or all events, iftype = None
), and returns an asynchronous iterator for them.
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
Close
Hashes for hass_websocket_client-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb25e6d068d005c7e1f06e2111c9037e56df3b1d9758fd6a866f328431a3801c |
|
MD5 | fffb52c719fd43a81828cf0182887c62 |
|
BLAKE2b-256 | b6314ebc10e8f8858f62c8c81aecf11515579c82426a7b3a3bbb072ed401ad46 |
Close
Hashes for hass_websocket_client-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a7c495d9dafc20914553e1e2a4e32296fb119225eb9bba9763a1499893c6915c |
|
MD5 | 687374dc83052af63264d7e44ef54f27 |
|
BLAKE2b-256 | d2dc1573a17caa5427790f38afd921cce9cced76241dcc9ec2c55e900ca2becb |