Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.template.image Namespace Reference

Classes

class  StateImageEntity
 
class  TriggerImageEntity
 

Functions

list[StateImageEntity_async_create_entities (HomeAssistant hass, list[dict[str, Any]] definitions, str|None unique_id_prefix)
 
None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 
None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string DEFAULT_NAME = "Template Image"
 
int GET_IMAGE_TIMEOUT = 10
 
 IMAGE_CONFIG_SCHEMA
 
 IMAGE_SCHEMA
 

Detailed Description

Support for image which integrates with other components.

Function Documentation

◆ _async_create_entities()

list[StateImageEntity] homeassistant.components.template.image._async_create_entities ( HomeAssistant  hass,
list[dict[str, Any]]  definitions,
str | None   unique_id_prefix 
)
private
Create the template image.

Definition at line 56 of file image.py.

◆ async_setup_entry()

None homeassistant.components.template.image.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Initialize config entry.

Definition at line 96 of file image.py.

◆ async_setup_platform()

None homeassistant.components.template.image.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the template image.

Definition at line 69 of file image.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.template.image._LOGGER = logging.getLogger(__name__)
private

Definition at line 32 of file image.py.

◆ DEFAULT_NAME

string homeassistant.components.template.image.DEFAULT_NAME = "Template Image"

Definition at line 34 of file image.py.

◆ GET_IMAGE_TIMEOUT

int homeassistant.components.template.image.GET_IMAGE_TIMEOUT = 10

Definition at line 36 of file image.py.

◆ IMAGE_CONFIG_SCHEMA

homeassistant.components.template.image.IMAGE_CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional(CONF_NAME): cv.template,
4  vol.Required(CONF_URL): cv.template,
5  vol.Optional(CONF_VERIFY_SSL, default=True): bool,
6  vol.Optional(CONF_DEVICE_ID): selector.DeviceSelector(),
7  }
8 )

Definition at line 46 of file image.py.

◆ IMAGE_SCHEMA

homeassistant.components.template.image.IMAGE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_URL): cv.template,
4  vol.Optional(CONF_VERIFY_SSL, default=True): bool,
5  }
6 ).extend(make_template_entity_common_schema(DEFAULT_NAME).schema)
vol.Schema make_template_entity_common_schema(str default_name)

Definition at line 38 of file image.py.