Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.canary.camera.CanaryCamera Class Reference
Inheritance diagram for homeassistant.components.canary.camera.CanaryCamera:
[legend]
Collaboration diagram for homeassistant.components.canary.camera.CanaryCamera:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, CanaryDataUpdateCoordinator coordinator, str location_id, Device device, str ffmpeg_args)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
StreamResponse|None handle_async_mjpeg_stream (self, Request request)
 
bool is_recording (self)
 
Location location (self)
 
bool motion_detection_enabled (self)
 
None renew_live_stream_session (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.canary.coordinator.CanaryDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, *Api api)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.camera.Camera
None __init__ (self)
 
Stream|None async_create_stream (self)
 
None async_disable_motion_detection (self)
 
None async_enable_motion_detection (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|None handle_async_mjpeg_stream (self, web.Request request)
 
web.StreamResponse handle_async_still_stream (self, web.Request request, float interval)
 
bool is_on (self)
 
bool is_streaming (self)
 
str|None model (self)
 
str state (self)
 
dict[str, str|Nonestate_attributes (self)
 
str|None stream_source (self)
 
CameraEntityFeature supported_features (self)
 
CameraEntityFeature supported_features_compat (self)
 
None turn_off (self)
 
None turn_on (self)
 
bool use_stream_for_stills (self)
 
- 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_added_to_hass (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)
 
None async_will_remove_from_hass (self)
 
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)
 
str|UndefinedType|None name (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, strtranslation_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)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 
 _device
 
 _expires_at
 
 _ffmpeg_arguments
 
 _image
 
 _live_stream_session
 
 _location_id
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.canary.coordinator.CanaryDataUpdateCoordinator
 canary
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.components.camera.Camera
 stream
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.camera.Camera
 bool
 
 CameraEntityFeature
 
 float
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

An implementation of a Canary security camera.

Definition at line 85 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.canary.camera.CanaryCamera.__init__ (   self,
HomeAssistant  hass,
CanaryDataUpdateCoordinator  coordinator,
str  location_id,
Device  device,
str  ffmpeg_args 
)
Initialize a Canary security camera.

Definition at line 88 of file camera.py.

Member Function Documentation

◆ async_camera_image()

bytes | None homeassistant.components.canary.camera.CanaryCamera.async_camera_image (   self,
int | None   width = None,
int | None   height = None 
)
Return a still image response from the camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 133 of file camera.py.

◆ handle_async_mjpeg_stream()

StreamResponse | None homeassistant.components.canary.camera.CanaryCamera.handle_async_mjpeg_stream (   self,
Request   request 
)
Generate an HTTP MJPEG stream from the camera.

Definition at line 165 of file camera.py.

◆ is_recording()

bool homeassistant.components.canary.camera.CanaryCamera.is_recording (   self)
Return true if the device is recording.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 124 of file camera.py.

◆ location()

Location homeassistant.components.canary.camera.CanaryCamera.location (   self)
Return information about the location.

Definition at line 119 of file camera.py.

◆ motion_detection_enabled()

bool homeassistant.components.canary.camera.CanaryCamera.motion_detection_enabled (   self)
Return the camera motion detection status.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 129 of file camera.py.

◆ renew_live_stream_session()

None homeassistant.components.canary.camera.CanaryCamera.renew_live_stream_session (   self)
Renew live stream session.

Definition at line 189 of file camera.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.canary.camera.CanaryCamera._attr_device_info
private

Definition at line 106 of file camera.py.

◆ _attr_name

homeassistant.components.canary.camera.CanaryCamera._attr_name
private

Definition at line 104 of file camera.py.

◆ _attr_unique_id

homeassistant.components.canary.camera.CanaryCamera._attr_unique_id
private

Definition at line 105 of file camera.py.

◆ _device

homeassistant.components.canary.camera.CanaryCamera._device
private

Definition at line 102 of file camera.py.

◆ _expires_at

homeassistant.components.canary.camera.CanaryCamera._expires_at
private

Definition at line 113 of file camera.py.

◆ _ffmpeg_arguments

homeassistant.components.canary.camera.CanaryCamera._ffmpeg_arguments
private

Definition at line 100 of file camera.py.

◆ _image

homeassistant.components.canary.camera.CanaryCamera._image
private

Definition at line 157 of file camera.py.

◆ _live_stream_session

homeassistant.components.canary.camera.CanaryCamera._live_stream_session
private

Definition at line 191 of file camera.py.

◆ _location_id

homeassistant.components.canary.camera.CanaryCamera._location_id
private

Definition at line 101 of file camera.py.


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