Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.canary.sensor.CanarySensor Class Reference
Inheritance diagram for homeassistant.components.canary.sensor.CanarySensor:
[legend]
Collaboration diagram for homeassistant.components.canary.sensor.CanarySensor:
[legend]

Public Member Functions

None __init__ (self, CanaryDataUpdateCoordinator coordinator, SensorTypeItem sensor_type, Location location, Device device)
 
dict[str, str]|None extra_state_attributes (self)
 
float|None native_value (self)
 
float|None reading (self)
 
- 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.canary.coordinator.CanaryDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, *Api api)
 
- 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.sensor.SensorEntity
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
dict[str, Any]|None capability_attributes (self)
 
SensorDeviceClass|None device_class (self)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
datetime|None last_reset (self)
 
str|None native_unit_of_measurement (self)
 
list[str]|None options (self)
 
Any state (self)
 
dict[str, Any]|None state_attributes (self)
 
SensorStateClass|str|None state_class (self)
 
int|None suggested_display_precision (self)
 
str|None suggested_unit_of_measurement (self)
 
str|None unit_of_measurement (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)
 
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_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)
 
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)
 
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)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (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_device_class
 
 _attr_device_info
 
 _attr_icon
 
 _attr_name
 
 _attr_native_unit_of_measurement
 
 _attr_unique_id
 
 _canary_type
 
 _device_id
 
 _sensor_type
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.canary.coordinator.CanaryDataUpdateCoordinator
 canary
 
- 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.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 
- 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.sensor.SensorEntity
 Decimal
 
 None
 
 UndefinedType
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Canary sensor.

Definition at line 89 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.canary.sensor.CanarySensor.__init__ (   self,
CanaryDataUpdateCoordinator  coordinator,
SensorTypeItem  sensor_type,
Location  location,
Device  device 
)
Initialize the sensor.

Definition at line 92 of file sensor.py.

Member Function Documentation

◆ extra_state_attributes()

dict[str, str] | None homeassistant.components.canary.sensor.CanarySensor.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 157 of file sensor.py.

◆ native_value()

float | None homeassistant.components.canary.sensor.CanarySensor.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 152 of file sensor.py.

◆ reading()

float | None homeassistant.components.canary.sensor.CanarySensor.reading (   self)
Return the device sensor reading.

Definition at line 133 of file sensor.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.canary.sensor.CanarySensor._attr_device_class
private

Definition at line 129 of file sensor.py.

◆ _attr_device_info

homeassistant.components.canary.sensor.CanarySensor._attr_device_info
private

Definition at line 122 of file sensor.py.

◆ _attr_icon

homeassistant.components.canary.sensor.CanarySensor._attr_icon
private

Definition at line 130 of file sensor.py.

◆ _attr_name

homeassistant.components.canary.sensor.CanarySensor._attr_name
private

Definition at line 106 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.canary.sensor.CanarySensor._attr_native_unit_of_measurement
private

Definition at line 128 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.canary.sensor.CanarySensor._attr_unique_id
private

Definition at line 121 of file sensor.py.

◆ _canary_type

homeassistant.components.canary.sensor.CanarySensor._canary_type
private

Definition at line 120 of file sensor.py.

◆ _device_id

homeassistant.components.canary.sensor.CanarySensor._device_id
private

Definition at line 103 of file sensor.py.

◆ _sensor_type

homeassistant.components.canary.sensor.CanarySensor._sensor_type
private

Definition at line 102 of file sensor.py.


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