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

Namespaces

 binary_sensor
 
 button
 
 config_flow
 
 const
 
 cover
 
 device_trigger
 
 diagnostics
 
 entity
 
 fan
 
 light
 
 logbook
 
 models
 
 scene
 
 switch
 
 util
 

Functions

LutronKeypad _async_build_lutron_keypad (Smartbridge bridge, dict[str, Any] bridge_device, dict[str, Any] bridge_keypad, int keypad_device_id)
 
dict[int, vol.Schema] _async_build_trigger_schemas (dict[int, dict[str, int]] keypad_button_names_to_leap)
 
None _async_migrate_unique_ids (HomeAssistant hass, LutronCasetaConfigEntry entry)
 
None _async_register_bridge_device (HomeAssistant hass, str config_entry_id, dict bridge_device, Smartbridge bridge)
 
LutronKeypadData _async_setup_keypads (HomeAssistant hass, str config_entry_id, Smartbridge bridge, dict[str, str|int] bridge_device)
 
def _async_subscribe_keypad_events (HomeAssistant hass, Smartbridge bridge, dict[int, LutronKeypad] keypads, dict[int, LutronButton] keypad_buttons, dict[int, dict[int, str]] leap_to_keypad_button_names)
 
str _get_button_name (LutronKeypad keypad, dict[str, Any] bridge_button)
 
str _get_button_name_from_triggers (LutronKeypad keypad, int button_number)
 
str _handle_none_keypad_serial (dict keypad_device, int bridge_serial)
 
tuple[str, str] _id_to_identifier (str lutron_id)
 
int|None async_get_lip_button (str device_type, int leap_button)
 
bool async_remove_config_entry_device (HomeAssistant hass, LutronCasetaConfigEntry entry, dr.DeviceEntry device_entry)
 
bool async_setup (HomeAssistant hass, ConfigType base_config)
 
bool async_setup_entry (HomeAssistant hass, LutronCasetaConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, LutronCasetaConfigEntry entry)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA
 
string DATA_BRIDGE_CONFIG = "lutron_caseta_bridges"
 
list PLATFORMS
 

Detailed Description

Component for interacting with a Lutron Caseta system.

Function Documentation

◆ _async_build_lutron_keypad()

LutronKeypad homeassistant.components.lutron_caseta._async_build_lutron_keypad ( Smartbridge  bridge,
dict[str, Any]  bridge_device,
dict[str, Any]  bridge_keypad,
int  keypad_device_id 
)
private

Definition at line 336 of file __init__.py.

◆ _async_build_trigger_schemas()

dict[int, vol.Schema] homeassistant.components.lutron_caseta._async_build_trigger_schemas ( dict[int, dict[str, int]]  keypad_button_names_to_leap)
private
Build device trigger schemas.

Definition at line 318 of file __init__.py.

◆ _async_migrate_unique_ids()

None homeassistant.components.lutron_caseta._async_migrate_unique_ids ( HomeAssistant  hass,
LutronCasetaConfigEntry   entry 
)
private
Migrate entities since the occupancygroup were not actually unique.

Definition at line 125 of file __init__.py.

◆ _async_register_bridge_device()

None homeassistant.components.lutron_caseta._async_register_bridge_device ( HomeAssistant  hass,
str  config_entry_id,
dict  bridge_device,
Smartbridge   bridge 
)
private
Register the bridge device in the device registry.

Definition at line 210 of file __init__.py.

◆ _async_setup_keypads()

LutronKeypadData homeassistant.components.lutron_caseta._async_setup_keypads ( HomeAssistant  hass,
str  config_entry_id,
Smartbridge  bridge,
dict[str, str | int]  bridge_device 
)
private
Register keypad devices (Keypads and Pico Remotes) in the device registry.

Definition at line 233 of file __init__.py.

◆ _async_subscribe_keypad_events()

def homeassistant.components.lutron_caseta._async_subscribe_keypad_events ( HomeAssistant  hass,
Smartbridge  bridge,
dict[int, LutronKeypad keypads,
dict[int, LutronButton keypad_buttons,
dict[int, dict[int, str]]  leap_to_keypad_button_names 
)
private
Subscribe to lutron events.

Definition at line 418 of file __init__.py.

◆ _get_button_name()

str homeassistant.components.lutron_caseta._get_button_name ( LutronKeypad  keypad,
dict[str, Any]  bridge_button 
)
private
Get the LEAP button name and check for override.

Definition at line 370 of file __init__.py.

◆ _get_button_name_from_triggers()

str homeassistant.components.lutron_caseta._get_button_name_from_triggers ( LutronKeypad  keypad,
int  button_number 
)
private
Retrieve the caseta button name from device triggers.

Definition at line 388 of file __init__.py.

◆ _handle_none_keypad_serial()

str homeassistant.components.lutron_caseta._handle_none_keypad_serial ( dict  keypad_device,
int  bridge_serial 
)
private

Definition at line 401 of file __init__.py.

◆ _id_to_identifier()

tuple[str, str] homeassistant.components.lutron_caseta._id_to_identifier ( str  lutron_id)
private
Convert a lutron caseta identifier to a device identifier.

Definition at line 480 of file __init__.py.

◆ async_get_lip_button()

int | None homeassistant.components.lutron_caseta.async_get_lip_button ( str  device_type,
int  leap_button 
)
Get the LIP button for a given LEAP button.

Definition at line 406 of file __init__.py.

◆ async_remove_config_entry_device()

bool homeassistant.components.lutron_caseta.async_remove_config_entry_device ( HomeAssistant  hass,
LutronCasetaConfigEntry  entry,
dr.DeviceEntry   device_entry 
)
Remove lutron_caseta config entry from a device.

Definition at line 485 of file __init__.py.

◆ async_setup()

bool homeassistant.components.lutron_caseta.async_setup ( HomeAssistant  hass,
ConfigType  base_config 
)
Set up the Lutron component.

Definition at line 103 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.lutron_caseta.async_setup_entry ( HomeAssistant  hass,
LutronCasetaConfigEntry   entry 
)
Set up a bridge from a config entry.

Definition at line 152 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.lutron_caseta.async_unload_entry ( HomeAssistant  hass,
LutronCasetaConfigEntry   entry 
)
Unload the bridge from a config entry.

Definition at line 471 of file __init__.py.

Variable Documentation

◆ _LOGGER

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

Definition at line 71 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.lutron_caseta.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.All(
4  cv.ensure_list,
5  [
6  {
7  vol.Required(CONF_HOST): cv.string,
8  vol.Required(CONF_KEYFILE): cv.string,
9  vol.Required(CONF_CERTFILE): cv.string,
10  vol.Required(CONF_CA_CERTS): cv.string,
11  }
12  ],
13  )
14  },
15  extra=vol.ALLOW_EXTRA,
16 )

Definition at line 75 of file __init__.py.

◆ DATA_BRIDGE_CONFIG

string homeassistant.components.lutron_caseta.DATA_BRIDGE_CONFIG = "lutron_caseta_bridges"

Definition at line 73 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.lutron_caseta.PLATFORMS
Initial value:
1 = [
2  Platform.BINARY_SENSOR,
3  Platform.BUTTON,
4  Platform.COVER,
5  Platform.FAN,
6  Platform.LIGHT,
7  Platform.SCENE,
8  Platform.SWITCH,
9 ]

Definition at line 92 of file __init__.py.