homeassistant.components.roomba.binary_sensor.RoombaBinStatus Class Reference

Inheritance diagram for homeassistant.components.roomba.binary_sensor.RoombaBinStatus:

Collaboration diagram for homeassistant.components.roomba.binary_sensor.RoombaBinStatus:

Public Member Functions
def	is_on (self)
def	new_state_filter (self, new_state)
def	unique_id (self)
Public Member Functions inherited from homeassistant.components.roomba.entity.IRobotEntity
def	__init__ (self, roomba, blid)
def	async_added_to_hass (self)
def	battery_level (self)
def	battery_stats (self)
def	last_mission (self)
def	mission_stats (self)
def	on_message (self, json_data)
def	robot_unique_id (self)
def	run_stats (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)
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)
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, str]	translation_placeholders (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)
Public Member Functions inherited from homeassistant.components.binary_sensor.BinarySensorEntity
None	async_internal_added_to_hass (self)

Static Private Attributes
string	_attr_translation_key = "bin_full"

Additional Inherited Members
Public Attributes inherited from homeassistant.components.roomba.entity.IRobotEntity
	vacuum
	vacuum_state
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
	entity_category
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
	None

Detailed Description

Class to hold Roomba Sensor basic info.

Definition at line 29 of file binary_sensor.py.

Member Function Documentation

is_on()

def homeassistant.components.roomba.binary_sensor.RoombaBinStatus.is_on

(

self

)

Return the state of the sensor.

Definition at line 40 of file binary_sensor.py.

new_state_filter()

def homeassistant.components.roomba.binary_sensor.RoombaBinStatus.new_state_filter	(		self,
			new_state
	)

Filter the new state.

Reimplemented from homeassistant.components.roomba.entity.IRobotEntity.

Definition at line 44 of file binary_sensor.py.

unique_id()

def homeassistant.components.roomba.binary_sensor.RoombaBinStatus.unique_id

(

self

)

Return the ID of this sensor.

Reimplemented from homeassistant.components.roomba.entity.IRobotEntity.

Definition at line 35 of file binary_sensor.py.

Member Data Documentation

_attr_translation_key

string homeassistant.components.roomba.binary_sensor.RoombaBinStatus._attr_translation_key = "bin_full"

staticprivate

Definition at line 32 of file binary_sensor.py.

---

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

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