homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor Class Reference

Inheritance diagram for homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor:

Collaboration diagram for homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor:

Public Member Functions
dict[str, Any]	extra_state_attributes (self)
str	icon (self)
bool|None	is_on (self)
Public Member Functions inherited from homeassistant.components.amberelectric.binary_sensor.AmberPriceGridSensor
None	__init__ (self, AmberUpdateCoordinator coordinator, BinarySensorEntityDescription description)
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.amberelectric.coordinator.AmberUpdateCoordinator
None	__init__ (self, HomeAssistant hass, amberelectric.AmberApi api, str site_id)
dict[str, dict[str, Any]]	update_price_data (self)
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.binary_sensor.BinarySensorEntity
None	async_internal_added_to_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_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)
None	async_write_ha_state (self)
str|None	attribution (self)
bool	available (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)
str|None	entity_picture (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|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
bool	should_poll (self)
StateType	state (self)
dict[str, Any]|None	state_attributes (self)
str|None	suggested_object_id (self)
int|None	supported_features (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)

Additional Inherited Members
Public Attributes inherited from homeassistant.components.amberelectric.binary_sensor.AmberPriceGridSensor
	entity_description
	site_id
Public Attributes inherited from homeassistant.components.amberelectric.coordinator.AmberUpdateCoordinator
	site_id
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.binary_sensor.BinarySensorEntity
	entity_category
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.binary_sensor.BinarySensorEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Sensor to show single grid binary values.

Definition at line 50 of file binary_sensor.py.

Member Function Documentation

extra_state_attributes()

dict[str, Any] homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor.extra_state_attributes

(

self

)

Return additional pieces of information about the price spike.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 65 of file binary_sensor.py.

icon()

str homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor.icon

(

self

)

Return the sensor icon.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 54 of file binary_sensor.py.

is_on()

bool | None homeassistant.components.amberelectric.binary_sensor.AmberPriceSpikeBinarySensor.is_on

(

self

)

Return true if the binary sensor is on.

Reimplemented from homeassistant.components.amberelectric.binary_sensor.AmberPriceGridSensor.

Definition at line 60 of file binary_sensor.py.

---

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

• core/homeassistant/components/amberelectric/binary_sensor.py