aiohomeconnect package¶

Asynchronous Python client for Home Connect API.

Subpackages¶

Submodules¶

aiohomeconnect.client module¶

Provide a client for Home Connect API.

class aiohomeconnect.client.AbstractAuth(httpx_client: AsyncClient, host: str)[source]¶

Bases: ABC

Abstract class to make authenticated requests.

abstractmethod async async_get_access_token() → str[source]¶: Return a valid access token.

connect_sse(method: str, url: str, **kwargs: Any) → AsyncIterator[EventSource][source]¶: Create a SSE connection.

async request(method: str, url: str, **kwargs: Any) → Response[source]¶

Make a request.

The url parameter must start with a slash.

class aiohomeconnect.client.Client(auth: AbstractAuth)[source]¶

Bases: object

Represent a client for the Home Connect API.

async get_active_program(ha_id: str, *, accept_language: Language | None = Language.EN) → Program[source]¶: Get the active program.

async get_active_program_option(ha_id: str, *, option_key: OptionKey, accept_language: Language | None = Language.EN) → Option[source]¶: Get a specific option of the active program.

async get_active_program_options(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfOptions[source]¶

Get all options of the active program.

You can retrieve a list of options of the currently running program.

async get_all_programs(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfPrograms[source]¶: Get all programs of a given home appliance.

async get_available_commands(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfCommands[source]¶: Get a list of available and writable commands.

async get_available_program(ha_id: str, *, program_key: ProgramKey, accept_language: Language | None = Language.EN) → ProgramDefinition[source]¶: Get a specific available program.

async get_available_programs(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfAvailablePrograms[source]¶: Get all currently available programs on the given home appliance.

async get_home_appliances() → ArrayOfHomeAppliances[source]¶

Get all home appliances which are paired with the logged-in user account.

This endpoint returns a list of all home appliances which are paired with the logged-in user account. All paired home appliances are returned independent of their current connection state. The connection state can be retrieved within the field ‘connected’ of the respective home appliance. The haId is the primary access key for further API access to a specific home appliance.

async get_image(ha_id: str, *, image_key: str) → None[source]¶: Get a specific image.

async get_images(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfImages[source]¶: Get a list of available images.

async get_selected_program(ha_id: str, *, accept_language: Language | None = Language.EN) → Program[source]¶

Get the selected program.

In most cases the selected program is the program which is currently shown on the display of the home appliance. This program can then be manually adjusted or started on the home appliance itself.

async get_selected_program_option(ha_id: str, *, option_key: OptionKey, accept_language: Language | None = Language.EN) → Option[source]¶: Get a specific option of the selected program.

async get_selected_program_options(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfOptions[source]¶: Get all options of the selected program.

async get_setting(ha_id: str, *, setting_key: SettingKey, accept_language: Language | None = Language.EN) → GetSetting[source]¶: Get a specific setting.

async get_settings(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfSettings[source]¶

Get a list of available settings.

Get a list of available setting of the home appliance.

Further documentation can be found [here](https://api-docs.home-connect.com/settings).

async get_specific_appliance(ha_id: str) → HomeAppliance[source]¶

Get a specific paired home appliance.

This endpoint returns a specific home appliance which is paired with the logged-in user account. It is returned independent of their current connection state. The connection state can be retrieved within the field ‘connected’ of the respective home appliance. The haId is the primary access key for further API access to a specific home appliance.

async get_status(ha_id: str, *, accept_language: Language | None = Language.EN) → ArrayOfStatus[source]¶

Get a list of available status.

A detailed description of the available status can be found [here](https://api-docs.home-connect.com/states).

async get_status_value(ha_id: str, *, status_key: StatusKey, accept_language: Language | None = Language.EN) → Status[source]¶

Get a specific status.

A detailed description of the available status can be found [here](https://api-docs.home-connect.com/states).

async put_command(ha_id: str, *, command_key: CommandKey, value: Any, accept_language: Language | None = Language.EN) → None[source]¶: Execute a specific command.

async put_commands(ha_id: str, *, put_commands: PutCommands, accept_language: Language | None = Language.EN) → None[source]¶: Execute multiple commands.

async set_active_program_option(ha_id: str, *, option_key: OptionKey, value: Any, name: str | None = None, display_value: str | None = None, unit: str | None = None, accept_language: Language | None = Language.EN) → None[source]¶

Set a specific option of the active program.

This operation can be used to modify one specific option of the active program, e.g. to extend the duration of the active program by another 5 minutes.

Please note that changing options of the running program is currently only supported by ovens.

async set_active_program_options(ha_id: str, *, array_of_options: ArrayOfOptions, accept_language: Language | None = Language.EN) → None[source]¶

Set all options of the active program.

Update the options for the currently running program. With this API endpoint, you have to provide all options with their new values. If you want to update only one option, you can use the endpoint specific to that option.

Please note that changing options of the running program is currently only supported by ovens.

async set_selected_program(ha_id: str, *, program_key: ProgramKey, name: str | None = None, options: list[Option] | None = None, accept_language: Language | None = Language.EN) → None[source]¶

Select the given program.

In most cases the selected program is the program which is currently shown on the display of the home appliance. This program can then be manually adjusted or started on the home appliance itself.

A selected program will not be started automatically. You don’t have to set a program as selected first if you intend to start it via API - you can set it directly as active program.

Selecting a program will update the available options and constraints directly from the home appliance. Any changes to the available options due to the state of the appliance is only reflected in the selected program.

async set_selected_program_option(ha_id: str, *, option_key: OptionKey, value: Any, name: str | None = None, display_value: str | None = None, unit: str | None = None, accept_language: Language | None = Language.EN) → None[source]¶: Set a specific option of the selected program.

async set_selected_program_options(ha_id: str, *, array_of_options: ArrayOfOptions, accept_language: Language | None = Language.EN) → None[source]¶: Set all options of the selected program.

async set_setting(ha_id: str, *, setting_key: SettingKey, value: Any, accept_language: Language | None = Language.EN) → None[source]¶: Set a specific setting.

async set_settings(ha_id: str, *, put_settings: PutSettings, accept_language: Language | None = Language.EN) → None[source]¶: Set multiple settings.

async start_program(ha_id: str, *, program_key: ProgramKey, name: str | None = None, options: list[Option] | None = None, accept_language: Language | None = Language.EN) → None[source]¶

Start the given program.

By putting a program object to this endpoint, the system will try to start it if all preconditions are fulfilled: * Home appliance is connected * Remote Control and Remote Control Start Allowed is enabled * No other program is currently active

Furthermore, the program must exist on the home appliance and its options must be set correctly. Keys of program, which can be executed on an oven, are for instance: * Cooking.Oven.Program.HeatingMode.HotAir * Cooking.Oven.Program.HeatingMode.TopBottomHeating * Cooking.Oven.Program.HeatingMode.PizzaSetting * Cooking.Oven.Program.HeatingMode.PreHeating

Keys for options of these oven programs are: * Cooking.Oven.Option.SetpointTemperature: 30 - 250 °C * BSH.Common.Option.Duration: 1 - 86340 seconds

There are no programs available for freezers, fridge freezers, refrigerators and wine coolers.

async stop_program(ha_id: str, *, accept_language: Language | None = Language.EN) → None[source]¶: Stop the active program.

async stream_all_events(*, accept_language: Language | None = Language.EN) → AsyncGenerator[EventMessage][source]¶

Get stream of events for all appliances.

Server Sent Events are available as Eventsource API in JavaScript and are implemented by various HTTP client libraries and tools including curl.

Unfortunately, SSE is not compatible to OpenAPI specs and can therefore not be properly specified within this API description.

An SSE event contains three parts separated by linebreaks: event, data and id. Different events are separated by empty lines.

The event field can be one of these types: KEEP-ALIVE, STATUS, EVENT, NOTIFY, CONNECTED, DISCONNECTED, PAIRED, DEPAIRED.

In case of all event types (except KEEP-ALIVE), the “data” field is populated with the JSON object defined below.

The id contains the home appliance ID. (except for KEEP-ALIVE event type)

Further documentation can be found here: * [Events availability matrix](https://api-docs.home-connect.com/events#availability-matrix) * [Program changes](https://api-docs.home-connect.com/events#program-changes) * [Option changes](https://api-docs.home-connect.com/events#option-changes) * [Program progress changes](https://api-docs.home-connect.com/events#program-progress-changes) * [Home appliance state changes](https://api-docs.home-connect.com/events#home-appliance-state-changes)

async stream_events(ha_id: str, *, accept_language: Language | None = Language.EN) → AsyncGenerator[EventMessage][source]¶

Get stream of events for one appliance.

If you want to do a one-time query of the current status, you can ask for the content-type application/vnd.bsh.sdk.v1+json and get the status as normal HTTP response.

If you want an ongoing stream of events in real time, ask for the content type text/event-stream and you’ll get a stream as Server Sent Events.

Server Sent Events are available as Eventsource API in JavaScript and are implemented by various HTTP client libraries and tools including curl.

Unfortunately, SSE is not compatible to OpenAPI specs and can therefore not be properly specified within this API description.

An SSE event contains three parts separated by linebreaks: event, data and id. Different events are separated by empty lines.

The event field can be one of these types: KEEP-ALIVE, STATUS, EVENT, NOTIFY, CONNECTED, DISCONNECTED.

In case of all event types (except KEEP-ALIVE), the “data” field is populated with the JSON object defined below.

The id contains the home appliance ID.

aiohomeconnect.const module¶

Provide common constants for Home Connect API.