Number Entity
A number
is an entity that allows the user to input an arbitrary value to an integration. Derive entity platforms from homeassistant.components.number.NumberEntity
#
PropertiesProperties should always only return information from memory and not do I/O (like network requests). Implement
update()
orasync_update()
to fetch data.
Name | Type | Default | Description |
---|---|---|---|
value | float | Required | Current value of the entity |
min_value | float | 0 | The minimum accepted value (inclusive) |
max_value | float | 100 | The maximum accepted value (inclusive) |
step | float | See below | Defines the resolution of the values, i.e. the smallest increment or decrement |
Other properties that are common to all entities such as icon
, unit_of_measurement
, name
etc are also applicable.
The default step value is dynamically chosen based on the range (max - min) values. If the difference between max_value and min_value is greater than 1.0, then the default step is 1.0. If however the range is smaller, then the step is iteratively devided by 10 until it becomes lower than the range.
#
Methods#
Set valueCalled when the user or automation wants to update the value.