homeassistant.components.proxy.camera Namespace Reference

Classes
class	ImageOpts
class	ProxyCamera

Functions
def	_crop_image (image, opts)
def	_precheck_image (image, opts)
def	_resize_image (image, opts)
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_CACHE_IMAGES = "cache_images"
string	CONF_FORCE_RESIZE = "force_resize"
string	CONF_IMAGE_LEFT = "image_left"
string	CONF_IMAGE_QUALITY = "image_quality"
string	CONF_IMAGE_REFRESH_RATE = "image_refresh_rate"
string	CONF_IMAGE_TOP = "image_top"
string	CONF_MAX_IMAGE_HEIGHT = "max_image_height"
string	CONF_MAX_IMAGE_WIDTH = "max_image_width"
string	CONF_MAX_STREAM_HEIGHT = "max_stream_height"
string	CONF_MAX_STREAM_WIDTH = "max_stream_width"
string	CONF_STREAM_QUALITY = "stream_quality"
string	DEFAULT_BASENAME = "Camera Proxy"
int	DEFAULT_QUALITY = 75
string	MODE_CROP = "crop"
string	MODE_RESIZE = "resize"
	PLATFORM_SCHEMA

Detailed Description

Proxy camera platform that enables image processing of camera data.

Function Documentation

_crop_image()

def homeassistant.components.proxy.camera._crop_image (   image,   opts  )

private

Crop image.

Definition at line 143 of file camera.py.

_precheck_image()

def homeassistant.components.proxy.camera._precheck_image (   image,   opts  )

private

Perform some pre-checks on the given image.

Definition at line 78 of file camera.py.

_resize_image()

def homeassistant.components.proxy.camera._resize_image (   image,   opts  )

private

Resize image.

Definition at line 96 of file camera.py.

async_setup_platform()

None homeassistant.components.proxy.camera.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the Proxy camera platform.

Definition at line 68 of file camera.py.

Variable Documentation

_LOGGER

homeassistant.components.proxy.camera._LOGGER = logging.getLogger(__name__)

private

Definition at line 28 of file camera.py.

CONF_CACHE_IMAGES

string homeassistant.components.proxy.camera.CONF_CACHE_IMAGES = "cache_images"

Definition at line 30 of file camera.py.

CONF_FORCE_RESIZE

string homeassistant.components.proxy.camera.CONF_FORCE_RESIZE = "force_resize"

Definition at line 31 of file camera.py.

CONF_IMAGE_LEFT

string homeassistant.components.proxy.camera.CONF_IMAGE_LEFT = "image_left"

Definition at line 39 of file camera.py.

CONF_IMAGE_QUALITY

string homeassistant.components.proxy.camera.CONF_IMAGE_QUALITY = "image_quality"

Definition at line 32 of file camera.py.

CONF_IMAGE_REFRESH_RATE

string homeassistant.components.proxy.camera.CONF_IMAGE_REFRESH_RATE = "image_refresh_rate"

Definition at line 33 of file camera.py.

CONF_IMAGE_TOP

string homeassistant.components.proxy.camera.CONF_IMAGE_TOP = "image_top"

Definition at line 38 of file camera.py.

CONF_MAX_IMAGE_HEIGHT

string homeassistant.components.proxy.camera.CONF_MAX_IMAGE_HEIGHT = "max_image_height"

Definition at line 35 of file camera.py.

CONF_MAX_IMAGE_WIDTH

string homeassistant.components.proxy.camera.CONF_MAX_IMAGE_WIDTH = "max_image_width"

Definition at line 34 of file camera.py.

CONF_MAX_STREAM_HEIGHT

string homeassistant.components.proxy.camera.CONF_MAX_STREAM_HEIGHT = "max_stream_height"

Definition at line 37 of file camera.py.

CONF_MAX_STREAM_WIDTH

string homeassistant.components.proxy.camera.CONF_MAX_STREAM_WIDTH = "max_stream_width"

Definition at line 36 of file camera.py.

CONF_STREAM_QUALITY

string homeassistant.components.proxy.camera.CONF_STREAM_QUALITY = "stream_quality"

Definition at line 40 of file camera.py.

DEFAULT_BASENAME

string homeassistant.components.proxy.camera.DEFAULT_BASENAME = "Camera Proxy"

Definition at line 45 of file camera.py.

DEFAULT_QUALITY

int homeassistant.components.proxy.camera.DEFAULT_QUALITY = 75

Definition at line 46 of file camera.py.

MODE_CROP

string homeassistant.components.proxy.camera.MODE_CROP = "crop"

Definition at line 43 of file camera.py.

MODE_RESIZE

string homeassistant.components.proxy.camera.MODE_RESIZE = "resize"

Definition at line 42 of file camera.py.

PLATFORM_SCHEMA

homeassistant.components.proxy.camera.PLATFORM_SCHEMA

Initial value:

=  CAMERA_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_ENTITY_ID): cv.entity_id,
        vol.Optional(CONF_NAME): cv.string,
        vol.Optional(CONF_CACHE_IMAGES, default=False): cv.boolean,
        vol.Optional(CONF_FORCE_RESIZE, default=False): cv.boolean,
        vol.Optional(CONF_MODE, default=MODE_RESIZE): vol.In([MODE_RESIZE, MODE_CROP]),
        vol.Optional(CONF_IMAGE_QUALITY): int,
        vol.Optional(CONF_IMAGE_REFRESH_RATE): float,
        vol.Optional(CONF_MAX_IMAGE_WIDTH): int,
        vol.Optional(CONF_MAX_IMAGE_HEIGHT): int,
        vol.Optional(CONF_MAX_STREAM_WIDTH): int,
        vol.Optional(CONF_MAX_STREAM_HEIGHT): int,
        vol.Optional(CONF_IMAGE_LEFT): int,
        vol.Optional(CONF_IMAGE_TOP): int,
        vol.Optional(CONF_STREAM_QUALITY): int,
    }
)

Definition at line 48 of file camera.py.