homeassistant.components.buienradar.camera.BuienradarCam Class Reference

Inheritance diagram for homeassistant.components.buienradar.camera.BuienradarCam:

Collaboration diagram for homeassistant.components.buienradar.camera.BuienradarCam:

Public Member Functions
None	__init__ (self, float latitude, float longitude, float delta, str country)
bytes|None	async_camera_image (self, int|None width=None, int|None height=None)
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|None]	state_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_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, str]	translation_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
bool	__needs_refresh (self)
bool	__retrieve_radar_image (self)

Private Attributes
	_attr_unique_id
	_condition
	_country
	_deadline
	_delta
	_dimension
	_last_image
	_last_modified
	_loading

Static Private Attributes
bool	_attr_entity_registry_enabled_default = False
string	_attr_name = "Buienradar"

Additional Inherited Members
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

A camera component producing animated buienradar radar-imagery GIFs.

Rain radar imagery camera based on image URL taken from [0].

[0]: https://www.buienradar.nl/overbuienradar/gratis-weerdata

Definition at line 52 of file camera.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.buienradar.camera.BuienradarCam.__init__	(		self,
		float	latitude,
		float	longitude,
		float	delta,
		str	country
	)

Initialize the component.

This constructor must be run in the event loop.

Definition at line 63 of file camera.py.

Member Function Documentation

__needs_refresh()

bool homeassistant.components.buienradar.camera.BuienradarCam.__needs_refresh (   self )

private

Definition at line 99 of file camera.py.

__retrieve_radar_image()

bool homeassistant.components.buienradar.camera.BuienradarCam.__retrieve_radar_image (   self )

private

Retrieve new radar image and return whether this succeeded.

Definition at line 105 of file camera.py.

async_camera_image()

bytes | None homeassistant.components.buienradar.camera.BuienradarCam.async_camera_image	(		self,
		int | None	width = None,
		int | None	height = None
	)

Return a still image response from the camera.

Uses asyncio conditions to make sure only one task enters the critical
section at the same time. Otherwise, two http requests would start
when two tabs with Home Assistant are open.

The condition is entered in two sections because otherwise the lock
would be held while doing the http request.

A boolean (_loading) is used to indicate the loading status instead of
_last_image since that is initialized to None.

For reference:
  * :func:`asyncio.Condition.wait` releases the lock and acquires it
    again before continuing.
  * :func:`asyncio.Condition.notify_all` requires the lock to be held.

Reimplemented from homeassistant.components.camera.Camera.

Definition at line 140 of file camera.py.

Member Data Documentation

_attr_entity_registry_enabled_default

bool homeassistant.components.buienradar.camera.BuienradarCam._attr_entity_registry_enabled_default = False

staticprivate

Definition at line 60 of file camera.py.

_attr_name

string homeassistant.components.buienradar.camera.BuienradarCam._attr_name = "Buienradar"

staticprivate

Definition at line 61 of file camera.py.

_attr_unique_id

homeassistant.components.buienradar.camera.BuienradarCam._attr_unique_id

private

Definition at line 97 of file camera.py.

_condition

homeassistant.components.buienradar.camera.BuienradarCam._condition

private

Definition at line 87 of file camera.py.

_country

homeassistant.components.buienradar.camera.BuienradarCam._country

private

Definition at line 79 of file camera.py.

_deadline

homeassistant.components.buienradar.camera.BuienradarCam._deadline

private

Definition at line 179 of file camera.py.

_delta

homeassistant.components.buienradar.camera.BuienradarCam._delta

private

Definition at line 76 of file camera.py.

_dimension

homeassistant.components.buienradar.camera.BuienradarCam._dimension

private

Definition at line 73 of file camera.py.

_last_image

homeassistant.components.buienradar.camera.BuienradarCam._last_image

private

Definition at line 132 of file camera.py.

_last_modified

homeassistant.components.buienradar.camera.BuienradarCam._last_modified

private

Definition at line 130 of file camera.py.

_loading

homeassistant.components.buienradar.camera.BuienradarCam._loading

private

Definition at line 93 of file camera.py.

---

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

• core/homeassistant/components/buienradar/camera.py