Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity Class Reference
Inheritance diagram for homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity:
[legend]
Collaboration diagram for homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity:
[legend]

Public Member Functions

None __init__ (self, Device device, ConfigEntry entry, str unique_id, DataUpdateCoordinator coordinator, XiaomiMiioNumberDescription description)
 
bool async_set_delay_off_countdown (self, int delay_off_countdown)
 
bool async_set_fan_level (self, int level=1)
 
bool async_set_favorite_level (self, int level=1)
 
bool async_set_favorite_rpm (self, int rpm)
 
bool async_set_led_brightness (self, int level)
 
bool async_set_led_brightness_level (self, int level)
 
bool async_set_motor_speed (self, int motor_speed=400)
 
None async_set_native_value (self, float value)
 
bool async_set_oscillation_angle (self, int angle)
 
bool async_set_volume (self, int volume=50)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.number.NumberEntity
None __init_subclass__ (cls, **Any kwargs)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
None async_set_value (self, float value)
 
dict[str, Any] capability_attributes (self)
 
float convert_to_native_value (self, float value)
 
NumberDeviceClass|None device_class (self)
 
float max_value (self)
 
float min_value (self)
 
NumberMode mode (self)
 
float native_max_value (self)
 
float native_min_value (self)
 
float|None native_step (self)
 
str|None native_unit_of_measurement (self)
 
float|None native_value (self)
 
None set_native_value (self, float value)
 
None set_value (self, float value)
 
float|None state (self)
 
float step (self)
 
str|None unit_of_measurement (self)
 
float|None value (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
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_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)
 
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)
 
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)
 
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 Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.components.number.NumberEntity
 device_class
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _handle_coordinator_update (self)
 

Private Attributes

 _attr_native_value
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.number.NumberEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a generic Xiaomi attribute selector.

Definition at line 354 of file number.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.__init__ (   self,
Device  device,
ConfigEntry  entry,
str  unique_id,
DataUpdateCoordinator  coordinator,
XiaomiMiioNumberDescription  description 
)
Initialize the generic Xiaomi attribute selector.

Definition at line 359 of file number.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity._handle_coordinator_update (   self)
private
Fetch state from the device.

Definition at line 394 of file number.py.

◆ async_set_delay_off_countdown()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_delay_off_countdown (   self,
int  delay_off_countdown 
)
Set the delay off countdown.

Definition at line 440 of file number.py.

◆ async_set_fan_level()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_fan_level (   self,
int   level = 1 
)
Set the fan level.

Definition at line 418 of file number.py.

◆ async_set_favorite_level()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_favorite_level (   self,
int   level = 1 
)
Set the favorite level.

Definition at line 410 of file number.py.

◆ async_set_favorite_rpm()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_favorite_rpm (   self,
int  rpm 
)
Set the target motor speed.

Definition at line 464 of file number.py.

◆ async_set_led_brightness()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_led_brightness (   self,
int  level 
)
Set the led brightness level.

Definition at line 456 of file number.py.

◆ async_set_led_brightness_level()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_led_brightness_level (   self,
int  level 
)
Set the led brightness level.

Definition at line 448 of file number.py.

◆ async_set_motor_speed()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_motor_speed (   self,
int   motor_speed = 400 
)
Set the target motor speed.

Definition at line 402 of file number.py.

◆ async_set_native_value()

None homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_native_value (   self,
float  value 
)
Set an option of the miio device.

Reimplemented from homeassistant.components.number.NumberEntity.

Definition at line 386 of file number.py.

◆ async_set_oscillation_angle()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_oscillation_angle (   self,
int  angle 
)
Set the volume.

Definition at line 434 of file number.py.

◆ async_set_volume()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.async_set_volume (   self,
int   volume = 50 
)
Set the volume.

Definition at line 426 of file number.py.

◆ available()

bool homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.available (   self)
Return the number controller availability.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 376 of file number.py.

Member Data Documentation

◆ _attr_native_value

homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity._attr_native_value
private

Definition at line 370 of file number.py.

◆ entity_description

homeassistant.components.xiaomi_miio.number.XiaomiNumberEntity.entity_description

Definition at line 373 of file number.py.


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