Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.overkiz Namespace Reference

Namespaces

 alarm_control_panel
 
 binary_sensor
 
 button
 
 climate
 
 config_flow
 
 const
 
 coordinator
 
 cover
 
 diagnostics
 
 entity
 
 executor
 
 light
 
 lock
 
 number
 
 scene
 
 select
 
 sensor
 
 siren
 
 switch
 
 water_heater
 

Classes

class  HomeAssistantOverkizData
 

Functions

bool _async_migrate_entries (HomeAssistant hass, ConfigEntry config_entry)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
OverkizClient create_cloud_client (HomeAssistant hass, str username, str password, OverkizServer server)
 
OverkizClient create_local_client (HomeAssistant hass, str host, str token, bool verify_ssl)
 

Detailed Description

The Overkiz (by Somfy) integration.

Function Documentation

◆ _async_migrate_entries()

bool homeassistant.components.overkiz._async_migrate_entries ( HomeAssistant  hass,
ConfigEntry   config_entry 
)
private
Migrate old entries to new unique IDs.

Definition at line 174 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.overkiz.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up Overkiz from a config entry.

Definition at line 57 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.overkiz.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 165 of file __init__.py.

◆ create_cloud_client()

OverkizClient homeassistant.components.overkiz.create_cloud_client ( HomeAssistant  hass,
str  username,
str  password,
OverkizServer   server 
)
Create Overkiz cloud client.

Definition at line 249 of file __init__.py.

◆ create_local_client()

OverkizClient homeassistant.components.overkiz.create_local_client ( HomeAssistant  hass,
str  host,
str  token,
bool   verify_ssl 
)
Create Overkiz local client.

Definition at line 233 of file __init__.py.