From 21e63c3b752fd13c52ad5ca10b3b89de378c5ab1 Mon Sep 17 00:00:00 2001 From: Steven Vondruska Date: Mon, 2 Jan 2023 06:15:58 -0500 Subject: [PATCH] Updating native_unit_of_measurement documentation (#1586) --- docs/core/entity/number.md | 2 +- docs/core/entity/sensor.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/core/entity/number.md b/docs/core/entity/number.md index 4417f5aa..37e49e57 100644 --- a/docs/core/entity/number.md +++ b/docs/core/entity/number.md @@ -19,7 +19,7 @@ Properties should always only return information from memory and not do I/O (lik | native_min_value | float | 0 | The minimum accepted value in the number's `native_unit_of_measurement` (inclusive) | native_step | float | **See below** | Defines the resolution of the values, i.e. the smallest increment or decrement in the number's | native_unit_of_measurement | string | `None` | The unit of measurement that the number's value is expressed in. If the `native_unit_of_measurement` is °C or °F, and its `device_class` is temperature, the number's `unit_of_measurement` will be the preferred temperature unit configured by the user and the number's `state` will be the `native_value` after an optional unit conversion. | native_value | float | **Required** | The value of the number in the number's `native_unit_of_measurement`. -`native_unit_of_measurement` +| native_unit_of_measurement | string | None | The unit of measurement that the sensor's value is expressed in. If the `native_unit_of_measurement` is °C or °F, and its `device_class` is temperature, the sensor's `unit_of_measurement` will be the preferred temperature unit configured by the user and the sensor's `state` will be the `native_value` after an optional unit conversion. Other properties that are common to all entities such as `icon`, `name` etc are also applicable. diff --git a/docs/core/entity/sensor.md b/docs/core/entity/sensor.md index ff3091e2..2efa5c7a 100644 --- a/docs/core/entity/sensor.md +++ b/docs/core/entity/sensor.md @@ -16,7 +16,7 @@ Properties should always only return information from memory and not do I/O (lik | device_class | string | `None` | Type of sensor. | last_reset | `datetime.datetime` | `None` | The time when an accumulating sensor such as an electricity usage meter, gas meter, water meter etc. was initialized. If the time of initialization is unknown, set it to `None`. Note that the `datetime.datetime` returned by the `last_reset` property will be converted to an ISO 8601-formatted string when the entity's state attributes are updated. When changing `last_reset`, the `state` must be a valid number. | native_value | `None`, `datetime.date`, `datetime.datetime`, `decimal.Decimal`, float, int, string | **Required** | The value of the sensor in the sensor's `native_unit_of_measurement`. Using a `device_class` may restrict the types that can be returned by this property. -| native_unit_of_measurement | string | `None` | The unit of measurement that the sensor's value is expressed in. If the `native_unit_of_measurement` is °C or °F, and its `device_class` is temperature, the sensor's `unit_of_measurement` will be the preferred temperature unit configured by the user and the sensor's `state` will be the `native_value` after an optional unit conversion. If not `None`, the sensor is assumed to be numerical and will be displayed as a line-chart in the frontend instead of as discrete values. +| native_unit_of_measurement | string | `None` | The unit of measurement that the sensor's value is expressed in. If the `native_unit_of_measurement` is °C or °F, and its `device_class` is temperature, the sensor's `unit_of_measurement` will be the preferred temperature unit configured by the user and the sensor's `state` will be the `native_value` after an optional unit conversion. | state_class | string | `None` | Type of state. If not `None`, the sensor is assumed to be numerical and will be displayed as a line-chart in the frontend instead of as discrete values. | suggested_unit_of_measurement | string | `None` | The unit of measurement to be used for the sensor's state. For sensors with a `unique_id`, this will be used as the initial unit of measurement, which users can then override. For sensors without a `unique_id`, this will be the unit of measurement for the sensor's state. This property is intended to be used by integrations to override automatic unit conversion rules, for example, to make a temperature sensor always display in `°C` regardless of whether the configured unit system prefers `°C` or `°F`, or to make a distance sensor always display in miles even if the configured unit system is metric. | options | list | `None` | In case this sensor provides a textual state, this property can be used to provide a list of possible states. Requires the `enum` device class to be set. Cannot be combined with `state_class` or `native_unit_of_measurement`.