Skip to content

Commit

Permalink
Add blog and update number and sensor entity docs (#2448)
Browse files Browse the repository at this point in the history
* add blog and update number and sensor entity docs

* Update docs/core/entity/sensor.md

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Update blog/2024-12-04-area-squared-units.md

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* remove space

* add number and sensor changes to the blog

* Update blog/2024-12-04-area-squared-units.md

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Update blog/2024-12-04-area-squared-units.md

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Update blog/2024-12-04-area-squared-units.md

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* remove example

* Update blog/2024-12-04-area-squared-units.md

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Update blog/2024-12-04-area-squared-units.md

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>

* Rename 2024-12-04-area-squared-units.md to 2024-12-26-area-squared-units.md

---------

Co-authored-by: epenet <6771947+epenet@users.noreply.github.com>
  • Loading branch information
mikey0000 and epenet authored Dec 26, 2024
1 parent 979cd62 commit 80935d4
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
15 changes: 15 additions & 0 deletions blog/2024-12-26-area-squared-units.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
author: mikey0000
authorURL: https://github.com/mikey0000
title: "New area device class"
---

### Summary of changes
A new `AREA` device class is now available for number and sensor entities, together with automatic unit conversion based on the unit system.
A corresponding `UnitOfArea` unit enumerator, and `AreaConverter` converter class have been added to support the new device class.

### Backward compatibility
The `AREA_SQUARE_METERS` constant has been deprecated and will be removed in Home Assistant `2025.12`.
Custom integrations should be adjusted to use `UnitOfArea.SQUARE_METERS`.

More details can be found in the [Number documentation](/docs/core/entity/number#available-device-classes) and [Sensor documentation](/docs/core/entity/sensor#available-device-classes)
1 change: 1 addition & 0 deletions docs/core/entity/number.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ If specifying a device class, your number entity will need to also return the co
| ---- | ---- | -----------
| `NumberDeviceClass.APPARENT_POWER` | VA | Apparent power |
| `NumberDeviceClass.AQI` | None | Air Quality Index
| `NumberDeviceClass.AREA` | m², cm², km², mm², in², ft², yd², mi², ac, ha | Area |
| `NumberDeviceClass.ATMOSPHERIC_PRESSURE` | cbar, bar, hPa, inHg, kPa, mbar, Pa, psi | Atmospheric pressure, statistics will be stored in Pa.
| `NumberDeviceClass.BATTERY` | % | Percentage of battery that is left
| `NumberDeviceClass.BLOOD_GLUCOSE_CONCENTRATION` | mg/dL, mmol/L | Blood glucose concentration```
Expand Down
3 changes: 2 additions & 1 deletion docs/core/entity/sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ If specifying a device class, your sensor entity will need to also return the co
| ---- | ---- | -----------
| `SensorDeviceClass.APPARENT_POWER` | VA | Apparent power
| `SensorDeviceClass.AQI` | None | Air Quality Index
| `SensorDeviceClass.ATMOSPHERIC_PRESSURE` | cbar, bar, hPa, mmHG, inHg, kPa, mbar, Pa, psi | Atmospheric pressure.
| `SensorDeviceClass.AREA` | m², cm², km², mm², in², ft², yd², mi², ac, ha | Area
| `SensorDeviceClass.ATMOSPHERIC_PRESSURE` | cbar, bar, hPa, mmHG, inHg, kPa, mbar, Pa, psi | Atmospheric pressure
| `SensorDeviceClass.BATTERY` | % | Percentage of battery that is left
| `SensorDeviceClass.BLOOD_GLUCOSE_CONCENTRATION` | mg/dL, mmol/L | Blood glucose concentration```
| `SensorDeviceClass.CO2` | ppm | Concentration of carbon dioxide.
Expand Down

0 comments on commit 80935d4

Please sign in to comment.