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

Public Member Functions

None __init__ (self, ProtectData data, UFPCamera camera, CameraChannel channel, bool is_default, bool secure, bool disable_stream)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
None async_disable_motion_detection (self)
 
None async_enable_motion_detection (self)
 
str|None stream_source (self)
 
- Public Member Functions inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
None __init__ (self, ProtectData data, ProtectDeviceType device, EntityDescription|None description=None)
 
None async_added_to_hass (self)
 
None async_update (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_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)
 
- 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|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_recording (self)
 
bool is_streaming (self)
 
str|None model (self)
 
bool motion_detection_enabled (self)
 
str state (self)
 
dict[str, str|Nonestate_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)
 

Public Attributes

 channel
 
- Public Attributes inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
 data
 
 device
 
 entity_description
 
- 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
 

Private Member Functions

None _async_set_stream_source (self)
 
None _async_update_device_from_protect (self, ProtectDeviceType device)
 

Private Attributes

 _attr_available
 
 _attr_entity_registry_enabled_default
 
 _attr_extra_state_attributes
 
 _attr_is_recording
 
 _attr_motion_detection_enabled
 
 _attr_name
 
 _attr_supported_features
 
 _attr_unique_id
 
 _disable_stream
 
 _last_image
 
 _secure
 
 _stream_source
 

Static Private Attributes

tuple _state_attrs
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.unifiprotect.entity.BaseProtectEntity
 None
 
- 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

A Ubiquiti UniFi Protect Camera.

Definition at line 163 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.unifiprotect.camera.ProtectCamera.__init__ (   self,
ProtectData  data,
UFPCamera  camera,
CameraChannel  channel,
bool  is_default,
bool  secure,
bool  disable_stream 
)
Initialize an UniFi camera.

Definition at line 173 of file camera.py.

Member Function Documentation

◆ _async_set_stream_source()

None homeassistant.components.unifiprotect.camera.ProtectCamera._async_set_stream_source (   self)
private

Definition at line 206 of file camera.py.

◆ _async_update_device_from_protect()

None homeassistant.components.unifiprotect.camera.ProtectCamera._async_update_device_from_protect (   self,
ProtectDeviceType  device 
)
private
Update Entity object from Protect device.

Reimplemented from homeassistant.components.unifiprotect.entity.BaseProtectEntity.

Definition at line 217 of file camera.py.

◆ async_camera_image()

bytes | None homeassistant.components.unifiprotect.camera.ProtectCamera.async_camera_image (   self,
int | None   width = None,
int | None   height = None 
)
Return the Camera Image.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 243 of file camera.py.

◆ async_disable_motion_detection()

None homeassistant.components.unifiprotect.camera.ProtectCamera.async_disable_motion_detection (   self)
Call the job and disable motion detection.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 262 of file camera.py.

◆ async_enable_motion_detection()

None homeassistant.components.unifiprotect.camera.ProtectCamera.async_enable_motion_detection (   self)
Call the job and enable motion detection.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 258 of file camera.py.

◆ stream_source()

str | None homeassistant.components.unifiprotect.camera.ProtectCamera.stream_source (   self)
Return the Stream Source.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 254 of file camera.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_available
private

Definition at line 232 of file camera.py.

◆ _attr_entity_registry_enabled_default

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_entity_registry_enabled_default
private

Definition at line 198 of file camera.py.

◆ _attr_extra_state_attributes

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_extra_state_attributes
private

Definition at line 235 of file camera.py.

◆ _attr_is_recording

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_is_recording
private

Definition at line 227 of file camera.py.

◆ _attr_motion_detection_enabled

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_motion_detection_enabled
private

Definition at line 223 of file camera.py.

◆ _attr_name

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_name
private

Definition at line 193 of file camera.py.

◆ _attr_supported_features

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_supported_features
private

Definition at line 213 of file camera.py.

◆ _attr_unique_id

homeassistant.components.unifiprotect.camera.ProtectCamera._attr_unique_id
private

Definition at line 192 of file camera.py.

◆ _disable_stream

homeassistant.components.unifiprotect.camera.ProtectCamera._disable_stream
private

Definition at line 185 of file camera.py.

◆ _last_image

homeassistant.components.unifiprotect.camera.ProtectCamera._last_image
private

Definition at line 251 of file camera.py.

◆ _secure

homeassistant.components.unifiprotect.camera.ProtectCamera._secure
private

Definition at line 184 of file camera.py.

◆ _state_attrs

tuple homeassistant.components.unifiprotect.camera.ProtectCamera._state_attrs
staticprivate
Initial value:
= (
"_attr_available",
"_attr_is_recording",
"_attr_motion_detection_enabled",
)

Definition at line 167 of file camera.py.

◆ _stream_source

homeassistant.components.unifiprotect.camera.ProtectCamera._stream_source
private

Definition at line 214 of file camera.py.

◆ channel

homeassistant.components.unifiprotect.camera.ProtectCamera.channel

Definition at line 183 of file camera.py.


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