From d28199045acb562e78a0c8d288884a87020c1279 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Tue, 12 Oct 2021 00:10:00 +0200 Subject: [PATCH] Tweak sensor documentation (#1081) --- docs/core/entity/sensor.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/core/entity/sensor.md b/docs/core/entity/sensor.md index 4c9ff3e5..dc30e8e9 100644 --- a/docs/core/entity/sensor.md +++ b/docs/core/entity/sensor.md @@ -24,18 +24,18 @@ Properties should always only return information from memory and not do I/O (lik If specifying a device class, your sensor entity will need to also return the correct unit of measurement. -| Type | Unit | Description +| Type | Supported units | Description | ---- | ---- | ----------- | aqi | | Air Quality Index | battery | % | % of battery that is left. | carbon_dioxide | ppm | parts per million of carbon dioxide concentration | carbon_monoxide | ppm | parts per million of carbon monoxide concentration | current | A | Current. -| date | ISO8601 | Date. +| date | | Date. Must be formatted according to ISO8601. | energy | Wh, kWh | Energy. Statistics will be stored in kWh. | gas | m³, ft³ | Volume of gas. Statistics will be stored in m³. | humidity | % | % of humidity in the air. -| illuminance | lx/lm | Light level. +| illuminance | lx, lm | Light level. | monetary | ISO 4217 | Monetary value with a currency | nitrogen_dioxide | µg/m³ | Concentration of Nitrogen Dioxide | | nitrogen_monoxide | µg/m³ | Concentration of Nitrogen Monoxide | @@ -46,11 +46,11 @@ If specifying a device class, your sensor entity will need to also return the co | pm10 | µg/m³ | Concentration of particulate matter less than 10 micrometers | | power | W, kW | Power. Statistics will be stored in W. | power_factor | % | Power Factor. -| pressure | bar, hPa, inHg, mbar, Pa, psi | Pressure. Statistics will be stored in kWh. +| pressure | bar, hPa, inHg, mbar, Pa, psi | Pressure. Statistics will be stored in Pa. | signal_strength | dB, dBm | Signal strength. | sulphur_dioxide | µg/m³ | Concentration of sulphure dioxide | | temperature | °C, °F | Temperature. Statistics will be stored in °C. -| timestamp | ISO8601 | Timestamp. +| timestamp | | Timestamp. Must be formatted according to ISO8601. | volatile_organic_compounds | µg/m³ | Concentration of volatile organic compounds. | voltage | V | Voltage.