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

Public Member Functions

None __init__ (self, UVCRemote camera, str uuid, str name, str password)
 
bytes|None camera_image (self, int|None width=None, int|None height=None)
 
None disable_motion_detection (self)
 
None enable_motion_detection (self)
 
dict[str, Any] extra_state_attributes (self)
 
bool is_recording (self)
 
str model (self)
 
bool motion_detection_enabled (self)
 
None set_motion_detection (self, bool mode)
 
str|None stream_source (self)
 
CameraEntityFeature supported_features (self)
 
None update (self)
 
- Public Member Functions inherited from homeassistant.components.camera.Camera
None __init__ (self)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
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)
 
None close_webrtc_session (self, str session_id)
 
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 state (self)
 
dict[str, str|Nonestate_attributes (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)
 
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 Member Functions

bool _login (self)
 

Private Attributes

 _attr_name
 
 _attr_unique_id
 
 _camera
 
 _caminfo
 
 _connect_addr
 
 _nvr
 
 _password
 
 _uuid
 

Static Private Attributes

string _attr_brand = "Ubiquiti"
 
bool _attr_is_streaming = False
 
bool _attr_should_poll = True
 

Additional Inherited Members

- 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

A Ubiquiti Unifi Video Camera.

Definition at line 90 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.uvc.camera.UnifiVideoCamera.__init__ (   self,
UVCRemote  camera,
str  uuid,
str  name,
str  password 
)
Initialize an Unifi camera.

Definition at line 98 of file camera.py.

Member Function Documentation

◆ _login()

bool homeassistant.components.uvc.camera.UnifiVideoCamera._login (   self)
private
Login to the camera.

Definition at line 149 of file camera.py.

◆ camera_image()

bytes | None homeassistant.components.uvc.camera.UnifiVideoCamera.camera_image (   self,
int | None   width = None,
int | None   height = None 
)
Return the image of this camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 190 of file camera.py.

◆ disable_motion_detection()

None homeassistant.components.uvc.camera.UnifiVideoCamera.disable_motion_detection (   self)
Disable motion detection in camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 227 of file camera.py.

◆ enable_motion_detection()

None homeassistant.components.uvc.camera.UnifiVideoCamera.enable_motion_detection (   self)
Enable motion detection in camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 223 of file camera.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.uvc.camera.UnifiVideoCamera.extra_state_attributes (   self)
Return the camera state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 119 of file camera.py.

◆ is_recording()

bool homeassistant.components.uvc.camera.UnifiVideoCamera.is_recording (   self)
Return true if the camera is recording.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 129 of file camera.py.

◆ model()

str homeassistant.components.uvc.camera.UnifiVideoCamera.model (   self)
Return the model of this camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 145 of file camera.py.

◆ motion_detection_enabled()

bool homeassistant.components.uvc.camera.UnifiVideoCamera.motion_detection_enabled (   self)
Camera Motion Detection Status.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 140 of file camera.py.

◆ set_motion_detection()

None homeassistant.components.uvc.camera.UnifiVideoCamera.set_motion_detection (   self,
bool  mode 
)
Set motion detection on or off.

Definition at line 213 of file camera.py.

◆ stream_source()

str | None homeassistant.components.uvc.camera.UnifiVideoCamera.stream_source (   self)
Return the source of the stream.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 231 of file camera.py.

◆ supported_features()

CameraEntityFeature homeassistant.components.uvc.camera.UnifiVideoCamera.supported_features (   self)
Return supported features.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 109 of file camera.py.

◆ update()

None homeassistant.components.uvc.camera.UnifiVideoCamera.update (   self)
Update the info.

Definition at line 248 of file camera.py.

Member Data Documentation

◆ _attr_brand

string homeassistant.components.uvc.camera.UnifiVideoCamera._attr_brand = "Ubiquiti"
staticprivate

Definition at line 94 of file camera.py.

◆ _attr_is_streaming

bool homeassistant.components.uvc.camera.UnifiVideoCamera._attr_is_streaming = False
staticprivate

Definition at line 95 of file camera.py.

◆ _attr_name

homeassistant.components.uvc.camera.UnifiVideoCamera._attr_name
private

Definition at line 103 of file camera.py.

◆ _attr_should_poll

bool homeassistant.components.uvc.camera.UnifiVideoCamera._attr_should_poll = True
staticprivate

Definition at line 93 of file camera.py.

◆ _attr_unique_id

homeassistant.components.uvc.camera.UnifiVideoCamera._attr_unique_id
private

Definition at line 102 of file camera.py.

◆ _camera

homeassistant.components.uvc.camera.UnifiVideoCamera._camera
private

Definition at line 186 of file camera.py.

◆ _caminfo

homeassistant.components.uvc.camera.UnifiVideoCamera._caminfo
private

Definition at line 187 of file camera.py.

◆ _connect_addr

homeassistant.components.uvc.camera.UnifiVideoCamera._connect_addr
private

Definition at line 174 of file camera.py.

◆ _nvr

homeassistant.components.uvc.camera.UnifiVideoCamera._nvr
private

Definition at line 101 of file camera.py.

◆ _password

homeassistant.components.uvc.camera.UnifiVideoCamera._password
private

Definition at line 104 of file camera.py.

◆ _uuid

homeassistant.components.uvc.camera.UnifiVideoCamera._uuid
private

Definition at line 102 of file camera.py.


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