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

Public Member Functions

None __init__ (self, HomeAssistant hass, Mapping[str, Any] device_info, str identifier, str title)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
str name (self)
 
str|None stream_source (self)
 
bool use_stream_for_stills (self)
 
- 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_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)
 
- 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)
 
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 Attributes

 content_type
 
 hass
 
 verify_ssl
 
- 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
 

Private Attributes

 _attr_device_info
 
 _attr_frame_interval
 
 _attr_supported_features
 
 _attr_unique_id
 
 _auth
 
 _authentication
 
 _last_image
 
 _last_update
 
 _last_url
 
 _limit_refetch
 
 _name
 
 _password
 
 _still_image_url
 
 _stream_source
 
 _update_lock
 
 _username
 

Additional Inherited Members

- 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 generic implementation of an IP camera.

Definition at line 71 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.generic.camera.GenericCamera.__init__ (   self,
HomeAssistant  hass,
Mapping[str, Any]  device_info,
str  identifier,
str  title 
)
Initialize a generic camera.

Definition at line 78 of file camera.py.

Member Function Documentation

◆ async_camera_image()

bytes | None homeassistant.components.generic.camera.GenericCamera.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 126 of file camera.py.

◆ name()

str homeassistant.components.generic.camera.GenericCamera.name (   self)
Return the name of this device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 182 of file camera.py.

◆ stream_source()

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

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 186 of file camera.py.

◆ use_stream_for_stills()

bool homeassistant.components.generic.camera.GenericCamera.use_stream_for_stills (   self)
Whether or not to use stream to generate stills.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 122 of file camera.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.generic.camera.GenericCamera._attr_device_info
private

Definition at line 116 of file camera.py.

◆ _attr_frame_interval

homeassistant.components.generic.camera.GenericCamera._attr_frame_interval
private

Definition at line 100 of file camera.py.

◆ _attr_supported_features

homeassistant.components.generic.camera.GenericCamera._attr_supported_features
private

Definition at line 102 of file camera.py.

◆ _attr_unique_id

homeassistant.components.generic.camera.GenericCamera._attr_unique_id
private

Definition at line 88 of file camera.py.

◆ _auth

homeassistant.components.generic.camera.GenericCamera._auth
private

Definition at line 107 of file camera.py.

◆ _authentication

homeassistant.components.generic.camera.GenericCamera._authentication
private

Definition at line 89 of file camera.py.

◆ _last_image

homeassistant.components.generic.camera.GenericCamera._last_image
private

Definition at line 112 of file camera.py.

◆ _last_update

homeassistant.components.generic.camera.GenericCamera._last_update
private

Definition at line 113 of file camera.py.

◆ _last_url

homeassistant.components.generic.camera.GenericCamera._last_url
private

Definition at line 111 of file camera.py.

◆ _limit_refetch

homeassistant.components.generic.camera.GenericCamera._limit_refetch
private

Definition at line 99 of file camera.py.

◆ _name

homeassistant.components.generic.camera.GenericCamera._name
private

Definition at line 92 of file camera.py.

◆ _password

homeassistant.components.generic.camera.GenericCamera._password
private

Definition at line 91 of file camera.py.

◆ _still_image_url

homeassistant.components.generic.camera.GenericCamera._still_image_url
private

Definition at line 93 of file camera.py.

◆ _stream_source

homeassistant.components.generic.camera.GenericCamera._stream_source
private

Definition at line 96 of file camera.py.

◆ _update_lock

homeassistant.components.generic.camera.GenericCamera._update_lock
private

Definition at line 114 of file camera.py.

◆ _username

homeassistant.components.generic.camera.GenericCamera._username
private

Definition at line 90 of file camera.py.

◆ content_type

homeassistant.components.generic.camera.GenericCamera.content_type

Definition at line 103 of file camera.py.

◆ hass

homeassistant.components.generic.camera.GenericCamera.hass

Definition at line 87 of file camera.py.

◆ verify_ssl

homeassistant.components.generic.camera.GenericCamera.verify_ssl

Definition at line 104 of file camera.py.


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