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

Public Member Functions

def __init__ (self, hass, name, buffer_size, timeout, image_field, webhook_id)
 
None async_added_to_hass (self)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
def extra_state_attributes (self)
 
def image_field (self)
 
def motion_detection_enabled (self)
 
def name (self)
 
def update_image (self, image, filename)
 
- 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)
 
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_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)
 
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

 queue
 
 state
 
 webhook_id
 
 webhook_url
 
- 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_is_recording
 
 _current_image
 
 _expired_listener
 
 _filename
 
 _image_field
 
 _last_trip
 
 _name
 
 _timeout
 

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

The representation of a Push camera.

Definition at line 101 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.push.camera.PushCamera.__init__ (   self,
  hass,
  name,
  buffer_size,
  timeout,
  image_field,
  webhook_id 
)
Initialize push camera component.

Definition at line 104 of file camera.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.push.camera.PushCamera.async_added_to_hass (   self)
Call when entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 118 of file camera.py.

◆ async_camera_image()

bytes | None homeassistant.components.push.camera.PushCamera.async_camera_image (   self,
int | None   width = None,
int | None   height = None 
)
Return a still image response.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 163 of file camera.py.

◆ extra_state_attributes()

def homeassistant.components.push.camera.PushCamera.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 185 of file camera.py.

◆ image_field()

def homeassistant.components.push.camera.PushCamera.image_field (   self)
HTTP field containing the image file.

Definition at line 132 of file camera.py.

◆ motion_detection_enabled()

def homeassistant.components.push.camera.PushCamera.motion_detection_enabled (   self)
Camera Motion Detection Status.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 180 of file camera.py.

◆ name()

def homeassistant.components.push.camera.PushCamera.name (   self)
Return the name of this camera.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 175 of file camera.py.

◆ update_image()

def homeassistant.components.push.camera.PushCamera.update_image (   self,
  image,
  filename 
)
Update the camera image.

Definition at line 136 of file camera.py.

Member Data Documentation

◆ _attr_is_recording

homeassistant.components.push.camera.PushCamera._attr_is_recording
private

Definition at line 139 of file camera.py.

◆ _current_image

homeassistant.components.push.camera.PushCamera._current_image
private

Definition at line 113 of file camera.py.

◆ _expired_listener

homeassistant.components.push.camera.PushCamera._expired_listener
private

Definition at line 110 of file camera.py.

◆ _filename

homeassistant.components.push.camera.PushCamera._filename
private

Definition at line 109 of file camera.py.

◆ _image_field

homeassistant.components.push.camera.PushCamera._image_field
private

Definition at line 114 of file camera.py.

◆ _last_trip

homeassistant.components.push.camera.PushCamera._last_trip
private

Definition at line 108 of file camera.py.

◆ _name

homeassistant.components.push.camera.PushCamera._name
private

Definition at line 107 of file camera.py.

◆ _timeout

homeassistant.components.push.camera.PushCamera._timeout
private

Definition at line 111 of file camera.py.

◆ queue

homeassistant.components.push.camera.PushCamera.queue

Definition at line 112 of file camera.py.

◆ state

homeassistant.components.push.camera.PushCamera.state

Definition at line 138 of file camera.py.

◆ webhook_id

homeassistant.components.push.camera.PushCamera.webhook_id

Definition at line 115 of file camera.py.

◆ webhook_url

homeassistant.components.push.camera.PushCamera.webhook_url

Definition at line 116 of file camera.py.


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