Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.number Namespace Reference

Namespaces

 const
 
 device_action
 
 reproduce_state
 
 significant_change
 
 websocket_api
 

Classes

class  NumberEntity
 
class  NumberEntityDescription
 
class  NumberExtraStoredData
 
class  RestoreNumber
 

Functions

None async_set_value (NumberEntity entity, ServiceCall service_call)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
float ceil_decimal (float value, float precision=0)
 
float floor_decimal (float value, float precision=0)
 

Variables

 __all__
 
 CACHED_PROPERTIES_WITH_ATTR_
 
 ENTITY_ID_FORMAT
 
 MIN_TIME_BETWEEN_SCANS
 
 PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE
 
 SCAN_INTERVAL
 
 seconds
 

Detailed Description

Component to allow numeric input for platforms.

Function Documentation

◆ async_set_value()

None homeassistant.components.number.async_set_value ( NumberEntity  entity,
ServiceCall  service_call 
)
Service call wrapper to set a new value.

Definition at line 101 of file __init__.py.

◆ async_setup()

bool homeassistant.components.number.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up Number entities.

Definition at line 84 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.number.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up a config entry.

Definition at line 127 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.number.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 132 of file __init__.py.

◆ ceil_decimal()

float homeassistant.components.number.ceil_decimal ( float  value,
float   precision = 0 
)
Return the ceiling of f with d decimals.

This is a simple implementation which ignores floating point inexactness.

Definition at line 152 of file __init__.py.

◆ floor_decimal()

float homeassistant.components.number.floor_decimal ( float  value,
float   precision = 0 
)
Return the floor of f with d decimals.

This is a simple implementation which ignores floating point inexactness.

Definition at line 161 of file __init__.py.

Variable Documentation

◆ __all__

homeassistant.components.number.__all__
private

Definition at line 62 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

homeassistant.components.number.CACHED_PROPERTIES_WITH_ATTR_

Definition at line 170 of file __init__.py.

◆ ENTITY_ID_FORMAT

homeassistant.components.number.ENTITY_ID_FORMAT

Definition at line 54 of file __init__.py.

◆ MIN_TIME_BETWEEN_SCANS

homeassistant.components.number.MIN_TIME_BETWEEN_SCANS

Definition at line 59 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.number.PLATFORM_SCHEMA

Definition at line 55 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.number.PLATFORM_SCHEMA_BASE

Definition at line 56 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.number.SCAN_INTERVAL

Definition at line 57 of file __init__.py.

◆ seconds

homeassistant.components.number.seconds

Definition at line 57 of file __init__.py.