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

Namespaces

 alarm_control_panel
 
 binary_sensor
 
 climate
 
 config_flow
 
 const
 
 entity
 
 light
 
 sensor
 
 switch
 
 water_heater
 

Functions

def _HiveEntityT
 
bool async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, DeviceEntry device_entry)
 
None async_remove_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA
 

Detailed Description

Support for the Hive devices and services.

Function Documentation

◆ _HiveEntityT()

def homeassistant.components.hive._HiveEntityT
private

Definition at line 128 of file __init__.py.

◆ async_remove_config_entry_device()

bool homeassistant.components.hive.async_remove_config_entry_device ( HomeAssistant  hass,
ConfigEntry  config_entry,
DeviceEntry   device_entry 
)
Remove a config entry from a device.

Definition at line 121 of file __init__.py.

◆ async_remove_entry()

None homeassistant.components.hive.async_remove_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Remove a config entry.

Definition at line 112 of file __init__.py.

◆ async_setup()

bool homeassistant.components.hive.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Hive configuration setup.

Definition at line 47 of file __init__.py.

◆ async_setup_entry()

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

Definition at line 70 of file __init__.py.

◆ async_unload_entry()

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

Definition at line 103 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.hive._LOGGER = logging.getLogger(__name__)
private

Definition at line 28 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.hive.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  vol.All(
3  cv.deprecated(DOMAIN),
4  {
5  DOMAIN: vol.Schema(
6  {
7  vol.Required(CONF_PASSWORD): cv.string,
8  vol.Required(CONF_USERNAME): cv.string,
9  vol.Optional(CONF_SCAN_INTERVAL, default=2): cv.positive_int,
10  },
11  )
12  },
13  ),
14  extra=vol.ALLOW_EXTRA,
15 )

Definition at line 30 of file __init__.py.