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

Public Member Functions

None __init__ (self, str config_entry_id, str username, str password, dict[str, Any] camera, MotionEyeClient client, DataUpdateCoordinator coordinator, MappingProxyType[str, str] options)
 
None async_request_action (self, str action)
 
None async_request_snapshot (self)
 
None async_set_text_overlay (self, str|None left_text=None, str|None right_text=None, str|None custom_left_text=None, str|None custom_right_text=None)
 
bool available (self)
 
bool motion_detection_enabled (self)
 
- Public Member Functions inherited from homeassistant.components.motioneye.entity.MotionEyeEntity
None __init__ (self, str config_entry_id, str type_name, dict[str, Any] camera, MotionEyeClient client, DataUpdateCoordinator coordinator, MappingProxyType[str, Any] options, EntityDescription|None entity_description=None)
 
DeviceInfo device_info (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.mjpeg.camera.MjpegCamera
None __init__ (self, *str|None name=None, str mjpeg_url, str|None still_image_url, str|None authentication=None, str|None username=None, str password="", bool verify_ssl=True, str|None unique_id=None, DeviceInfo|None device_info=None)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
web.StreamResponse|None handle_async_mjpeg_stream (self, web.Request request)
 
str stream_source (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)
 
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 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)
 
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 Member Functions

dict[str, Any] _get_mjpeg_camera_properties_for_camera (self, dict[str, Any] camera)
 
None _handle_coordinator_update (self)
 
bool _is_acceptable_streaming_camera (self)
 
None _set_mjpeg_camera_state_for_camera (self, dict[str, Any] camera)
 

Private Attributes

 _auth
 
 _authentication
 
 _camera
 
 _mjpeg_url
 
 _motion_detection_enabled
 
 _password
 
 _still_image_url
 
 _surveillance_password
 
 _surveillance_username
 
 _username
 

Static Private Attributes

 _attr_brand = MOTIONEYE_MANUFACTURER
 
bool _attr_is_streaming = True
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.motioneye.entity.MotionEyeEntity
 entity_description
 
- 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

motionEye mjpeg camera.

Definition at line 140 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.motioneye.camera.MotionEyeMjpegCamera.__init__ (   self,
str  config_entry_id,
str  username,
str  password,
dict[str, Any]  camera,
MotionEyeClient  client,
DataUpdateCoordinator  coordinator,
MappingProxyType[str, str options 
)
Initialize a MJPEG camera.

Definition at line 147 of file camera.py.

Member Function Documentation

◆ _get_mjpeg_camera_properties_for_camera()

dict[str, Any] homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._get_mjpeg_camera_properties_for_camera (   self,
dict[str, Any]   camera 
)
private
Convert a motionEye camera to MjpegCamera internal properties.

Definition at line 178 of file camera.py.

◆ _handle_coordinator_update()

None homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Definition at line 240 of file camera.py.

◆ _is_acceptable_streaming_camera()

bool homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._is_acceptable_streaming_camera (   self)
private
Determine if a camera is streaming/usable.

Definition at line 228 of file camera.py.

◆ _set_mjpeg_camera_state_for_camera()

None homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._set_mjpeg_camera_state_for_camera (   self,
dict[str, Any]  camera 
)
private
Set the internal state to match the given camera.

Definition at line 210 of file camera.py.

◆ async_request_action()

None homeassistant.components.motioneye.camera.MotionEyeMjpegCamera.async_request_action (   self,
str  action 
)
Call a motionEye action on a camera.

Definition at line 282 of file camera.py.

◆ async_request_snapshot()

None homeassistant.components.motioneye.camera.MotionEyeMjpegCamera.async_request_snapshot (   self)
Request a motionEye snapshot be saved.

Definition at line 286 of file camera.py.

◆ async_set_text_overlay()

None homeassistant.components.motioneye.camera.MotionEyeMjpegCamera.async_set_text_overlay (   self,
str | None   left_text = None,
str | None   right_text = None,
str | None   custom_left_text = None,
str | None   custom_right_text = None 
)
Set text overlay for a camera.

Definition at line 255 of file camera.py.

◆ available()

bool homeassistant.components.motioneye.camera.MotionEyeMjpegCamera.available (   self)
Return if entity is available.

Reimplemented from homeassistant.components.motioneye.entity.MotionEyeEntity.

Definition at line 235 of file camera.py.

◆ motion_detection_enabled()

bool homeassistant.components.motioneye.camera.MotionEyeMjpegCamera.motion_detection_enabled (   self)
Return the camera motion detection status.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 251 of file camera.py.

Member Data Documentation

◆ _attr_brand

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._attr_brand = MOTIONEYE_MANUFACTURER
staticprivate

Definition at line 143 of file camera.py.

◆ _attr_is_streaming

bool homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._attr_is_streaming = True
staticprivate

Definition at line 145 of file camera.py.

◆ _auth

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._auth
private

Definition at line 226 of file camera.py.

◆ _authentication

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._authentication
private

Definition at line 220 of file camera.py.

◆ _camera

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._camera
private

Definition at line 242 of file camera.py.

◆ _mjpeg_url

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._mjpeg_url
private

Definition at line 218 of file camera.py.

◆ _motion_detection_enabled

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._motion_detection_enabled
private

Definition at line 245 of file camera.py.

◆ _password

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._password
private

Definition at line 217 of file camera.py.

◆ _still_image_url

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._still_image_url
private

Definition at line 219 of file camera.py.

◆ _surveillance_password

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._surveillance_password
private

Definition at line 159 of file camera.py.

◆ _surveillance_username

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._surveillance_username
private

Definition at line 158 of file camera.py.

◆ _username

homeassistant.components.motioneye.camera.MotionEyeMjpegCamera._username
private

Definition at line 216 of file camera.py.


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