Unit of measurement type defs (#53)

cspell.config.yaml

@@ -13,12 +13,17 @@ words:
   - homekit
   - hvac
   - macaddress
+  - gbit
+  - cbar
+  - mbar
   - quickboot
   - rgbw
   - rgbww
   - rrule
   - rtsp
   - sonarjs
+  - mbit
+  - kbit
   - ssdp
   - systype
   - tvshow

package.json

@@ -2,7 +2,7 @@
   "name": "@digital-alchemy/hass",
   "repository": "https://github.com/Digital-Alchemy-TS/hass",
   "homepage": "https://docs.digital-alchemy.app",
-  "version": "24.7.3",
+  "version": "24.7.4",
   "scripts": {
     "build": "rm -rf dist/; tsc",
     "lint": "eslint src",
@@ -36,7 +36,7 @@
   "license": "MIT",
   "devDependencies": {
     "@cspell/eslint-plugin": "^8.8.4",
-    "@digital-alchemy/core": "^24.6.6",
+    "@digital-alchemy/core": "^24.7.1",
     "@digital-alchemy/synapse": "^24.6.6",
     "@digital-alchemy/type-writer": "^24.6.6",
     "@types/figlet": "^1.5.8",

src/helpers/entity-state.helper.ts

@@ -9,6 +9,7 @@ import {
   TLabelId,
   TRawDomains,
 } from "../dynamic";
+import { SensorUnitOfMeasurement } from "./registry";
 import {
   ALL_DOMAINS,
   ALL_SERVICE_DOMAINS,
@@ -184,6 +185,7 @@ export interface Conversation {
 export interface Sensor {
   suggested_display_precision?: number;
   display_precision?: null;
+  unit_of_measurement?: SensorUnitOfMeasurement;
 }
 
 export interface SensorPrivate {

src/helpers/registry.ts

@@ -38,6 +38,111 @@ export type ToggleExpose = {
   should_expose: boolean;
 };
 
+export type SensorUnitOfMeasurement =
+  | "h"
+  | "min"
+  | "s"
+  | "d"
+  | "K"
+  | "°C"
+  | "°F"
+  | "cm"
+  | "in"
+  | "mm"
+  | "VA"
+  | "L"
+  | "gal"
+  | "m³"
+  | "ft³"
+  | "CCF"
+  | "kg"
+  | "g"
+  | "mg"
+  | "µg"
+  | "oz"
+  | "lb"
+  | "st"
+  | "ft/s"
+  | "km/h"
+  | "kn"
+  | "m/s"
+  | "mph"
+  | "in/d"
+  | "in/h"
+  | "mm/d"
+  | "V"
+  | "mV"
+  | "dB"
+  | "dBm"
+  | "mL"
+  | "fl. oz."
+  | "dBA"
+  | "cbar"
+  | "bar"
+  | "hPa"
+  | "inHg"
+  | "kPa"
+  | "mbar"
+  | "Pa"
+  | "psi"
+  | "var"
+  | "%"
+  | "None"
+  | "W"
+  | "kW"
+  | "µg/m³"
+  | "lx"
+  | "W/m²"
+  | "BTU/(h⋅ft²)"
+  | "Hz"
+  | "kHz"
+  | "MHz"
+  | "GHz"
+  | "Wh"
+  | "kWh"
+  | "MWh"
+  | "MJ"
+  | "GJ"
+  | "km"
+  | "m"
+  | "mi"
+  | "yd"
+  | "bit/s"
+  | "kbit/s"
+  | "Mbit/s"
+  | "Gbit/s"
+  | "B/s"
+  | "kB/s"
+  | "MB/s"
+  | "GB/s"
+  | "KiB/s"
+  | "MiB/s"
+  | "GiB/s"
+  | "bit"
+  | "kbit"
+  | "Mbit"
+  | "Gbit"
+  | "B"
+  | "kB"
+  | "MB"
+  | "GB"
+  | "TB"
+  | "PB"
+  | "EB"
+  | "ZB"
+  | "YB"
+  | "KiB"
+  | "MiB"
+  | "GiB"
+  | "TiB"
+  | "PiB"
+  | "EiB"
+  | "ZiB"
+  | "YiB"
+  | "A"
+  | "mA"
+  | "ppm";
+
 export type EntityRegistryItem<ENTITY extends ANY_ENTITY> = {
   area_id?: TAreaId;
   categories: object;
@@ -56,6 +161,10 @@ export type EntityRegistryItem<ENTITY extends ANY_ENTITY> = {
     conversation: {
       should_expose?: boolean;
     };
+    sensor?: {
+      display_precision?: number;
+      unit_of_measurement?: SensorUnitOfMeasurement;
+    };
   };
   original_name: string;
   platform: TPlatformId;

yarn.lock

@@ -937,7 +937,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@digital-alchemy/core@npm:^24.6.1, @digital-alchemy/core@npm:^24.6.6":
+"@digital-alchemy/core@npm:^24.6.1":
   version: 24.6.6
   resolution: "@digital-alchemy/core@npm:24.6.6"
   dependencies:
@@ -958,6 +958,27 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@digital-alchemy/core@npm:^24.7.1":
+  version: 24.7.1
+  resolution: "@digital-alchemy/core@npm:24.7.1"
+  dependencies:
+    chalk: "npm:^5.3.0"
+    dayjs: "npm:^1.11.11"
+    dotenv: "npm:^16.4.5"
+    ini: "npm:^4.1.3"
+    js-yaml: "npm:^4.1.0"
+    minimist: "npm:^1.2.8"
+    node-cache: "npm:^5.1.2"
+    node-cron: "npm:^3.0.3"
+    prom-client: "npm:^15.1.2"
+    redis: "npm:^4.6.14"
+  dependenciesMeta:
+    redis:
+      optional: true
+  checksum: 10/fd5dbdb47890c26348951a4ace7b4496b943d3271a2a50430a3456c2abf25de50192dd4e26e8d93279e040f13ba366f86d75686efadcc750d20dbaf1051189a6
+  languageName: node
+  linkType: hard
+
 "@digital-alchemy/fastify-extension@npm:*":
   version: 24.6.1
   resolution: "@digital-alchemy/fastify-extension@npm:24.6.1"
@@ -978,7 +999,7 @@ __metadata:
   resolution: "@digital-alchemy/hass@workspace:."
   dependencies:
     "@cspell/eslint-plugin": "npm:^8.8.4"
-    "@digital-alchemy/core": "npm:^24.6.6"
+    "@digital-alchemy/core": "npm:^24.7.1"
     "@digital-alchemy/synapse": "npm:^24.6.6"
     "@digital-alchemy/type-writer": "npm:^24.6.6"
     "@types/figlet": "npm:^1.5.8"