homeassistant.components.freebox.camera.FreeboxCamera Class Reference

Inheritance diagram for homeassistant.components.freebox.camera.FreeboxCamera:

Collaboration diagram for homeassistant.components.freebox.camera.FreeboxCamera:

Public Member Functions
None	__init__ (self, HomeAssistant hass, FreeboxRouter router, dict[str, Any] node)
None	async_disable_motion_detection (self)
None	async_enable_motion_detection (self)
None	async_update_signal (self)
None	update_node (self, dict[str, Any] node)
Public Member Functions inherited from homeassistant.components.freebox.entity.FreeboxHomeEntity
None	__init__ (self, HomeAssistant hass, FreeboxRouter router, dict[str, Any] node, dict[str, Any]|None sub_node=None)
None	async_added_to_hass (self)
None	async_will_remove_from_hass (self)
int|None	get_command_id (self, nodes, str ep_type, str name)
Any|None	get_home_endpoint_value (self, Any command_id)
def	get_value (self, str ep_type, str name)
None	remove_signal_update (self, Callable[[], None] dispatcher)
bool	set_home_endpoint_value (self, int|None command_id, bool|None value=None)
Public Member Functions inherited from homeassistant.helpers.entity.Entity
None	__init_subclass__ (cls, **Any kwargs)
str	__repr__ (self)
None	add_to_platform_abort (self)
None	add_to_platform_finish (self)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_internal_will_remove_from_hass (self)
None	async_on_remove (self, CALLBACK_TYPE func)
None	async_registry_entry_updated (self)
None	async_remove (self, *bool force_remove=False)
None	async_removed_from_registry (self)
None	async_schedule_update_ha_state (self, bool force_refresh=False)
None	async_set_context (self, Context context)
None	async_update_ha_state (self, bool force_refresh=False)
str|None	attribution (self)
dict[str, Any]|None	capability_attributes (self)
str|None	device_class (self)
DeviceInfo|None	device_info (self)
bool	enabled (self)
EntityCategory|None	entity_category (self)
bool	entity_registry_enabled_default (self)
bool	entity_registry_visible_default (self)
Mapping[str, Any]|None	extra_state_attributes (self)
bool	force_update (self)
HassJobType	get_hassjob_type (self, str function_name)
er.EntityOptionsType|None	get_initial_entity_options (self)
bool	has_entity_name (self)
str|None	icon (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (self)
str|None	unit_of_measurement (self)
bool	use_device_name (self)
Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None	__init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
Any	__new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
Public Member Functions inherited from homeassistant.components.ffmpeg.camera.FFmpegCamera
None	__init__ (self, HomeAssistant hass, dict[str, Any] config)
bytes|None	async_camera_image (self, int|None width=None, int|None height=None)
web.StreamResponse	handle_async_mjpeg_stream (self, web.Request request)
str	name (self)
str	stream_source (self)
Public Member Functions inherited from homeassistant.components.camera.Camera
None	__init__ (self)
Stream|None	async_create_stream (self)
WebRTCClientConfiguration	async_get_webrtc_client_configuration (self)
None	async_handle_async_webrtc_offer (self, str offer_sdp, str session_id, WebRTCSendMessage send_message)
str|None	async_handle_web_rtc_offer (self, str offer_sdp)
None	async_internal_added_to_hass (self)
None	async_on_webrtc_candidate (self, str session_id, RTCIceCandidateInit candidate)
None	async_refresh_providers (self, *bool write_state=True)
None	async_turn_off (self)
None	async_turn_on (self)
None	async_update_token (self)
None	async_write_ha_state (self)
bool	available (self)
str|None	brand (self)
CameraCapabilities	camera_capabilities (self)
bytes|None	camera_image (self, int|None width=None, int|None height=None)
None	close_webrtc_session (self, str session_id)
None	disable_motion_detection (self)
None	enable_motion_detection (self)
str	entity_picture (self)
float	frame_interval (self)
StreamType|None	frontend_stream_type (self)
web.StreamResponse	handle_async_still_stream (self, web.Request request, float interval)
bool	is_on (self)
bool	is_recording (self)
bool	is_streaming (self)
str|None	model (self)
bool	motion_detection_enabled (self)
str	state (self)
dict[str, str|None]	state_attributes (self)
CameraEntityFeature	supported_features (self)
CameraEntityFeature	supported_features_compat (self)
None	turn_off (self)
None	turn_on (self)
bool	use_stream_for_stills (self)

Private Attributes
	_attr_extra_state_attributes
	_attr_is_streaming
	_attr_motion_detection_enabled
	_command_motion_detection
	_name
	_supported_features

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.camera.Camera
	stream
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.camera.Camera
	bool
	CameraEntityFeature
	float
	None

Detailed Description

Representation of a Freebox camera.

Definition at line 68 of file camera.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.freebox.camera.FreeboxCamera.__init__	(		self,
		HomeAssistant	hass,
		FreeboxRouter	router,
		dict[str, Any]	node
	)

Initialize a camera.

Definition at line 71 of file camera.py.

Member Function Documentation

async_disable_motion_detection()

None homeassistant.components.freebox.camera.FreeboxCamera.async_disable_motion_detection

(

self

)

Disable motion detection in camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 99 of file camera.py.

async_enable_motion_detection()

None homeassistant.components.freebox.camera.FreeboxCamera.async_enable_motion_detection

(

self

)

Enable motion detection in the camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 94 of file camera.py.

async_update_signal()

None homeassistant.components.freebox.camera.FreeboxCamera.async_update_signal

(

self

)

Update the camera node.

Reimplemented from homeassistant.components.freebox.entity.FreeboxHomeEntity.

Definition at line 104 of file camera.py.

update_node()

None homeassistant.components.freebox.camera.FreeboxCamera.update_node	(		self,
		dict[str, Any]	node
	)

Update params.

Definition at line 109 of file camera.py.

Member Data Documentation

_attr_extra_state_attributes

homeassistant.components.freebox.camera.FreeboxCamera._attr_extra_state_attributes

private

Definition at line 91 of file camera.py.

_attr_is_streaming

homeassistant.components.freebox.camera.FreeboxCamera._attr_is_streaming

private

Definition at line 115 of file camera.py.

_attr_motion_detection_enabled

homeassistant.components.freebox.camera.FreeboxCamera._attr_motion_detection_enabled

private

Definition at line 97 of file camera.py.

_command_motion_detection

homeassistant.components.freebox.camera.FreeboxCamera._command_motion_detection

private

Definition at line 88 of file camera.py.

_name

homeassistant.components.freebox.camera.FreeboxCamera._name

private

Definition at line 111 of file camera.py.

_supported_features

homeassistant.components.freebox.camera.FreeboxCamera._supported_features

private

Definition at line 84 of file camera.py.

---

The documentation for this class was generated from the following file:

• core/homeassistant/components/freebox/camera.py