Tweak sensor documentation (#1081)

This commit is contained in:
Erik Montnemery 2021-10-12 00:10:00 +02:00 committed by GitHub
parent 26d427f396
commit d28199045a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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. 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 | aqi | | Air Quality Index
| battery | % | % of battery that is left. | battery | % | % of battery that is left.
| carbon_dioxide | ppm | parts per million of carbon dioxide concentration | carbon_dioxide | ppm | parts per million of carbon dioxide concentration
| carbon_monoxide | ppm | parts per million of carbon monoxide concentration | carbon_monoxide | ppm | parts per million of carbon monoxide concentration
| current | A | Current. | current | A | Current.
| date | ISO8601 | Date. | date | | Date. Must be formatted according to ISO8601.
| energy | Wh, kWh | Energy. Statistics will be stored in kWh. | energy | Wh, kWh | Energy. Statistics will be stored in kWh.
| gas | m³, ft³ | Volume of gas. Statistics will be stored in m³. | gas | m³, ft³ | Volume of gas. Statistics will be stored in m³.
| humidity | % | % of humidity in the air. | humidity | % | % of humidity in the air.
| illuminance | lx/lm | Light level. | illuminance | lx, lm | Light level.
| monetary | ISO 4217 | Monetary value with a currency | monetary | ISO 4217 | Monetary value with a currency
| nitrogen_dioxide | µg/m³ | Concentration of Nitrogen Dioxide | | nitrogen_dioxide | µg/m³ | Concentration of Nitrogen Dioxide |
| nitrogen_monoxide | µg/m³ | Concentration of Nitrogen Monoxide | | 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 | | pm10 | µg/m³ | Concentration of particulate matter less than 10 micrometers |
| power | W, kW | Power. Statistics will be stored in W. | power | W, kW | Power. Statistics will be stored in W.
| power_factor | % | Power Factor. | 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. | signal_strength | dB, dBm | Signal strength.
| sulphur_dioxide | µg/m³ | Concentration of sulphure dioxide | | sulphur_dioxide | µg/m³ | Concentration of sulphure dioxide |
| temperature | °C, °F | Temperature. Statistics will be stored in °C. | 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. | volatile_organic_compounds | µg/m³ | Concentration of volatile organic compounds.
| voltage | V | Voltage. | voltage | V | Voltage.