homeassistant.components.image Namespace Reference

Namespaces
	const
	media_source

Classes
class	Image
class	ImageContentTypeError
class	ImageEntity
class	ImageEntityDescription
class	ImageStreamView
class	ImageView

Functions
Image	_async_get_image (ImageEntity image_entity, int timeout)
web.StreamResponse	async_get_still_stream (web.Request request, ImageEntity image_entity)
None	async_handle_snapshot_service (ImageEntity image, ServiceCall service_call)
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
str	valid_image_content_type (str|None content_type)

Variables
	_LOGGER = logging.getLogger(__name__)
dictionary	CACHED_PROPERTIES_WITH_ATTR_
	Final
string	FRAME_BOUNDARY = "frame-boundary"
	FRAME_SEPARATOR = bytes(f"\r\n--{FRAME_BOUNDARY}\r\n", "utf-8")
	LAST_FRAME_MARKER = bytes(f"\r\n--{FRAME_BOUNDARY}--\r\n", "utf-8")
	minutes
	PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA
	PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE
	seconds
	VolDictType

Detailed Description

The image integration.

Function Documentation

_async_get_image()

Image homeassistant.components.image._async_get_image ( ImageEntity  image_entity, int  timeout  )

private

Fetch image from an image entity.

Definition at line 97 of file __init__.py.

async_get_still_stream()

web.StreamResponse homeassistant.components.image.async_get_still_stream	(	web.Request	request,
		ImageEntity	image_entity
	)

Generate an HTTP multipart stream from the Image.

Definition at line 323 of file __init__.py.

async_handle_snapshot_service()

None homeassistant.components.image.async_handle_snapshot_service	(	ImageEntity	image,
		ServiceCall	service_call
	)

Handle snapshot services calls.

Definition at line 408 of file __init__.py.

async_setup()

bool homeassistant.components.image.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the image component.

Definition at line 108 of file __init__.py.

async_setup_entry()

bool homeassistant.components.image.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up a config entry.

Definition at line 144 of file __init__.py.

async_unload_entry()

bool homeassistant.components.image.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 149 of file __init__.py.

valid_image_content_type()

str homeassistant.components.image.valid_image_content_type

(

str | None

content_type

)

Validate the assigned content type is one of an image.

Definition at line 90 of file __init__.py.

Variable Documentation

_LOGGER

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

private

Definition at line 48 of file __init__.py.

CACHED_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.image.CACHED_PROPERTIES_WITH_ATTR_

Initial value:

=  {
    "content_type",
    "image_last_updated",
    "image_url",
}

Definition at line 154 of file __init__.py.

Final

homeassistant.components.image.Final

Definition at line 50 of file __init__.py.

FRAME_BOUNDARY

string homeassistant.components.image.FRAME_BOUNDARY = "frame-boundary"

Definition at line 67 of file __init__.py.

FRAME_SEPARATOR

homeassistant.components.image.FRAME_SEPARATOR = bytes(f"\r\n--{FRAME_BOUNDARY}\r\n", "utf-8")

Definition at line 68 of file __init__.py.

LAST_FRAME_MARKER

homeassistant.components.image.LAST_FRAME_MARKER = bytes(f"\r\n--{FRAME_BOUNDARY}--\r\n", "utf-8")

Definition at line 69 of file __init__.py.

minutes

homeassistant.components.image.minutes

Definition at line 62 of file __init__.py.

PLATFORM_SCHEMA

homeassistant.components.image.PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA

Definition at line 53 of file __init__.py.

PLATFORM_SCHEMA_BASE

homeassistant.components.image.PLATFORM_SCHEMA_BASE = cv.PLATFORM_SCHEMA_BASE

Definition at line 54 of file __init__.py.

seconds

homeassistant.components.image.seconds

Definition at line 55 of file __init__.py.

VolDictType

homeassistant.components.image.VolDictType

Definition at line 71 of file __init__.py.