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

Public Member Functions

None __init__ (self, NetatmoDevice netatmo_device)
 
None async_added_to_hass (self)
 
bytes|None async_camera_image (self, int|None width=None, int|None height=None)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
None async_update_callback (self)
 
list[strfetch_person_ids (self, list[str|None] persons)
 
str get_video_url (self, str video_id)
 
None handle_event (self, dict event)
 
dict process_events (self, list[NaEvent] event_list)
 
str stream_source (self)
 
CameraEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.components.netatmo.entity.NetatmoModuleEntity
DeviceType device_type (self)
 
- Public Member Functions inherited from homeassistant.components.netatmo.entity.NetatmoDeviceEntity
None __init__ (self, NetatmoDataHandler data_handler, NetatmoBase device)
 
tuple[str, strdevice_description (self)
 
Home home (self)
 
- Public Member Functions inherited from homeassistant.components.netatmo.entity.NetatmoBaseEntity
None __init__ (self, NetatmoDataHandler data_handler)
 
None async_will_remove_from_hass (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)
 
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)
 
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_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_compat (self)
 
None turn_off (self)
 
None turn_on (self)
 
bool use_stream_for_stills (self)
 

Static Public Attributes

 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
 

Private Member Functions

None _service_set_camera_light (self, **Any kwargs)
 
None _service_set_person_away (self, **Any kwargs)
 
None _service_set_persons_home (self, **Any kwargs)
 

Private Attributes

 _attr_available
 
 _attr_is_on
 
 _attr_is_streaming
 
 _attr_motion_detection_enabled
 
 _attr_unique_id
 
 _light_state
 
 _monitoring
 

Static Private Attributes

 _attr_brand = MANUFACTURER
 
 _attr_configuration_url = CONF_URL_SECURITY
 
 _attr_name = None
 
 _attr_supported_features = CameraEntityFeature.STREAM
 
 _quality = DEFAULT_QUALITY
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.netatmo.entity.NetatmoDeviceEntity
 device
 
- Public Attributes inherited from homeassistant.components.netatmo.entity.NetatmoBaseEntity
 data_handler
 
- 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
 

Detailed Description

Representation of a Netatmo camera.

Definition at line 83 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.netatmo.camera.NetatmoCamera.__init__ (   self,
NetatmoDevice  netatmo_device 
)
Set up for access to the Netatmo camera images.

Reimplemented from homeassistant.components.netatmo.entity.NetatmoModuleEntity.

Definition at line 94 of file camera.py.

Member Function Documentation

◆ _service_set_camera_light()

None homeassistant.components.netatmo.camera.NetatmoCamera._service_set_camera_light (   self,
**Any  kwargs 
)
private
Service to set light mode.

Definition at line 299 of file camera.py.

◆ _service_set_person_away()

None homeassistant.components.netatmo.camera.NetatmoCamera._service_set_person_away (   self,
**Any  kwargs 
)
private
Service to mark a person as away or set the home as empty.

Definition at line 284 of file camera.py.

◆ _service_set_persons_home()

None homeassistant.components.netatmo.camera.NetatmoCamera._service_set_persons_home (   self,
**Any  kwargs 
)
private
Service to change current home schedule.

Definition at line 276 of file camera.py.

◆ async_added_to_hass()

None homeassistant.components.netatmo.camera.NetatmoCamera.async_added_to_hass (   self)
Entity created.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 120 of file camera.py.

◆ async_camera_image()

bytes | None homeassistant.components.netatmo.camera.NetatmoCamera.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 165 of file camera.py.

◆ async_turn_off()

None homeassistant.components.netatmo.camera.NetatmoCamera.async_turn_off (   self)
Turn off camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 189 of file camera.py.

◆ async_turn_on()

None homeassistant.components.netatmo.camera.NetatmoCamera.async_turn_on (   self)
Turn on camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 193 of file camera.py.

◆ async_update_callback()

None homeassistant.components.netatmo.camera.NetatmoCamera.async_update_callback (   self)
Update the entity's state.

Reimplemented from homeassistant.components.netatmo.entity.NetatmoBaseEntity.

Definition at line 207 of file camera.py.

◆ fetch_person_ids()

list[str] homeassistant.components.netatmo.camera.NetatmoCamera.fetch_person_ids (   self,
list[str | None persons 
)
Fetch matching person ids for given list of persons.

Definition at line 255 of file camera.py.

◆ get_video_url()

str homeassistant.components.netatmo.camera.NetatmoCamera.get_video_url (   self,
str  video_id 
)
Get video url.

Definition at line 249 of file camera.py.

◆ handle_event()

None homeassistant.components.netatmo.camera.NetatmoCamera.handle_event (   self,
dict  event 
)
Handle webhook events.

Definition at line 136 of file camera.py.

◆ process_events()

dict homeassistant.components.netatmo.camera.NetatmoCamera.process_events (   self,
list[NaEvent]  event_list 
)
Add meta data to events.

Definition at line 233 of file camera.py.

◆ stream_source()

str homeassistant.components.netatmo.camera.NetatmoCamera.stream_source (   self)
Return the stream source.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 197 of file camera.py.

◆ supported_features()

CameraEntityFeature homeassistant.components.netatmo.camera.NetatmoCamera.supported_features (   self)
Return supported features.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 182 of file camera.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.netatmo.camera.NetatmoCamera._attr_available
private

Definition at line 210 of file camera.py.

◆ _attr_brand

homeassistant.components.netatmo.camera.NetatmoCamera._attr_brand = MANUFACTURER
staticprivate

Definition at line 86 of file camera.py.

◆ _attr_configuration_url

homeassistant.components.netatmo.camera.NetatmoCamera._attr_configuration_url = CONF_URL_SECURITY
staticprivate

Definition at line 88 of file camera.py.

◆ _attr_is_on

homeassistant.components.netatmo.camera.NetatmoCamera._attr_is_on
private

Definition at line 209 of file camera.py.

◆ _attr_is_streaming

homeassistant.components.netatmo.camera.NetatmoCamera._attr_is_streaming
private

Definition at line 148 of file camera.py.

◆ _attr_motion_detection_enabled

homeassistant.components.netatmo.camera.NetatmoCamera._attr_motion_detection_enabled
private

Definition at line 214 of file camera.py.

◆ _attr_name

homeassistant.components.netatmo.camera.NetatmoCamera._attr_name = None
staticprivate

Definition at line 92 of file camera.py.

◆ _attr_supported_features

homeassistant.components.netatmo.camera.NetatmoCamera._attr_supported_features = CameraEntityFeature.STREAM
staticprivate

Definition at line 87 of file camera.py.

◆ _attr_unique_id

homeassistant.components.netatmo.camera.NetatmoCamera._attr_unique_id
private

Definition at line 102 of file camera.py.

◆ _light_state

homeassistant.components.netatmo.camera.NetatmoCamera._light_state
private

Definition at line 103 of file camera.py.

◆ _monitoring

homeassistant.components.netatmo.camera.NetatmoCamera._monitoring
private

Definition at line 149 of file camera.py.

◆ _quality

homeassistant.components.netatmo.camera.NetatmoCamera._quality = DEFAULT_QUALITY
staticprivate

Definition at line 90 of file camera.py.

◆ None

homeassistant.components.netatmo.camera.NetatmoCamera.None
static

Definition at line 91 of file camera.py.


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