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

Public Member Functions

None __init__ (self, FoscamCoordinator coordinator, ConfigEntry config_entry)
 
None async_added_to_hass (self)
 
def async_perform_ptz (self, movement, travel_time)
 
def async_perform_ptz_preset (self, preset_name)
 
bytes|None camera_image (self, int|None width=None, int|None height=None)
 
None disable_motion_detection (self)
 
None enable_motion_detection (self)
 
str|None stream_source (self)
 
- Public Member Functions inherited from homeassistant.components.foscam.entity.FoscamEntity
None __init__ (self, FoscamCoordinator coordinator, str entry_id)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.foscam.coordinator.FoscamCoordinator
None __init__ (self, HomeAssistant hass, FoscamCamera session)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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_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)
 
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)
 
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 Attributes

 _attr_motion_detection_enabled
 
 _attr_supported_features
 
 _attr_unique_id
 
 _foscam_session
 
 _password
 
 _rtsp_port
 
 _stream
 
 _username
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.foscam.coordinator.FoscamCoordinator
 session
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- 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

An implementation of a Foscam IP camera.

Definition at line 97 of file camera.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.foscam.camera.HassFoscamCamera.__init__ (   self,
FoscamCoordinator  coordinator,
ConfigEntry  config_entry 
)
Initialize a Foscam camera.

Definition at line 103 of file camera.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.foscam.camera.HassFoscamCamera.async_added_to_hass (   self)
Handle entity addition to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 121 of file camera.py.

◆ async_perform_ptz()

def homeassistant.components.foscam.camera.HassFoscamCamera.async_perform_ptz (   self,
  movement,
  travel_time 
)
Perform a PTZ action on the camera.

Definition at line 219 of file camera.py.

◆ async_perform_ptz_preset()

def homeassistant.components.foscam.camera.HassFoscamCamera.async_perform_ptz_preset (   self,
  preset_name 
)
Perform a PTZ preset action on the camera.

Definition at line 241 of file camera.py.

◆ camera_image()

bytes | None homeassistant.components.foscam.camera.HassFoscamCamera.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 148 of file camera.py.

◆ disable_motion_detection()

None homeassistant.components.foscam.camera.HassFoscamCamera.disable_motion_detection (   self)
Disable motion detection.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 193 of file camera.py.

◆ enable_motion_detection()

None homeassistant.components.foscam.camera.HassFoscamCamera.enable_motion_detection (   self)
Enable motion detection in camera.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 167 of file camera.py.

◆ stream_source()

str | None homeassistant.components.foscam.camera.HassFoscamCamera.stream_source (   self)
Return the stream source.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 160 of file camera.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.foscam.camera.HassFoscamCamera._attr_has_entity_name = True
staticprivate

Definition at line 100 of file camera.py.

◆ _attr_motion_detection_enabled

homeassistant.components.foscam.camera.HassFoscamCamera._attr_motion_detection_enabled
private

Definition at line 146 of file camera.py.

◆ _attr_name

homeassistant.components.foscam.camera.HassFoscamCamera._attr_name = None
staticprivate

Definition at line 101 of file camera.py.

◆ _attr_supported_features

homeassistant.components.foscam.camera.HassFoscamCamera._attr_supported_features
private

Definition at line 119 of file camera.py.

◆ _attr_unique_id

homeassistant.components.foscam.camera.HassFoscamCamera._attr_unique_id
private

Definition at line 116 of file camera.py.

◆ _foscam_session

homeassistant.components.foscam.camera.HassFoscamCamera._foscam_session
private

Definition at line 112 of file camera.py.

◆ _password

homeassistant.components.foscam.camera.HassFoscamCamera._password
private

Definition at line 114 of file camera.py.

◆ _rtsp_port

homeassistant.components.foscam.camera.HassFoscamCamera._rtsp_port
private

Definition at line 117 of file camera.py.

◆ _stream

homeassistant.components.foscam.camera.HassFoscamCamera._stream
private

Definition at line 115 of file camera.py.

◆ _username

homeassistant.components.foscam.camera.HassFoscamCamera._username
private

Definition at line 113 of file camera.py.


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