Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase Class Reference
Inheritance diagram for homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase:
[legend]
Collaboration diagram for homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase:
[legend]

Public Member Functions

None __init__ (self, OctoprintDataUpdateCoordinator coordinator, str sensor_type, str device_id)
 
bool available (self)
 
def is_on (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- 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)
 
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)
 
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)
 
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, 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 Member Functions

bool|None _get_flag_state (self, OctoprintPrinterInfo printer_info)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 
 _device_id
 

Additional Inherited Members

- 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

Representation an OctoPrint binary sensor.

Definition at line 40 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase.__init__ (   self,
OctoprintDataUpdateCoordinator  coordinator,
str  sensor_type,
str  device_id 
)
Initialize a new OctoPrint sensor.

Definition at line 45 of file binary_sensor.py.

Member Function Documentation

◆ _get_flag_state()

bool | None homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase._get_flag_state (   self,
OctoprintPrinterInfo  printer_info 
)
private

◆ available()

bool homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase.available (   self)
Return if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 67 of file binary_sensor.py.

◆ is_on()

def homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase.is_on (   self)
Return true if binary sensor is on.

Definition at line 59 of file binary_sensor.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase._attr_device_info
private

Definition at line 56 of file binary_sensor.py.

◆ _attr_name

homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase._attr_name
private

Definition at line 54 of file binary_sensor.py.

◆ _attr_unique_id

homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase._attr_unique_id
private

Definition at line 55 of file binary_sensor.py.

◆ _device_id

homeassistant.components.octoprint.binary_sensor.OctoPrintBinarySensorBase._device_id
private
Initialize a new OctoPrint sensor.

Definition at line 53 of file binary_sensor.py.


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