Show Rain Delay Stop Time if rain delay is active

README.md

@@ -38,6 +38,8 @@ Otherwise, make sure:
 - The ids of program running binary sensors end with `_running`
 - The id of the OpenSprinkler controller enabled switch ends with `_enabled`
 - The ids of program & station enabled switches end with `_enabled`
+- The id of the rain delay active binary sensor ends with `_rain_delay_active`
+- The id of the rain delay stop time sensor ends with `_rain_delay_stop_time`
 
 ## Extra entities and duration control
 

package.json

@@ -14,8 +14,9 @@
   "repository": "[email protected]:rianadon/opensprinkler-card.git",
   "license": "Apache-2.0",
   "dependencies": {
+    "@formatjs/intl-utils": "^3.8.4",
     "@mdi/js": "^6.5.95",
-    "custom-card-helpers": "^1.8.0",
+    "custom-card-helpers": "1.8.0",
     "home-assistant-js-websocket": "^5.12.0",
     "lit": "^2.0.2",
     "lovelace-timer-bar-card": "^1.15.0"

src/helpers.ts

@@ -25,13 +25,22 @@ export const isStationProgEnable = (entity: HassEntity) =>
     entity.entity_id.startsWith('switch.');
 export const isPlayPausable = (entity: HassEntity) =>
     isStation(entity) || isProgram(entity) || isRunOnce(entity)
+export const isRainDelayActiveSensor = (entity: HassEntity) =>
+    entity.entity_id.startsWith('binary_sensor.') &&
+    entity.entity_id.endsWith('rain_delay_active')
+export const isRainDelayStopTime = (entity: HassEntity) =>
+    entity.entity_id.startsWith('sensor.') &&
+    entity.entity_id.endsWith('rain_delay_stop_time')
 
 export function hasRunOnce(entities: EntitiesFunc) {
     return entities(isStation).some(e => e.attributes.running_program_id === RUN_ONCE_ID);
 }
 export function hasManual(entities: EntitiesFunc) {
     return entities(isStation).some(e => e.attributes.running_program_id === MANUAL_ID);
 }
+export function hasRainDelayActive(entities: EntitiesFunc) {
+    return entities(isRainDelayActiveSensor).some(e => e.state === 'on');
+}
 
 export const stateWaiting   = (entity: HassEntity) => WAITING_STATES.includes(entity.state);
 export const stateStoppable = (entity: HassEntity) => STOPPABLE_STATES.includes(entity.state);

src/opensprinkler-card.ts

@@ -13,9 +13,10 @@ import "./opensprinkler-generic-entity-row";
 import "./opensprinkler-more-info-dialog";
 import "./opensprinkler-control";
 import { MoreInfoDialog } from './opensprinkler-more-info-dialog';
-import { EntitiesFunc, hasManual, hasRunOnce, isPlayPausable, isProgram, isStation, lineHeight, osName, stateActivated, stateWaiting } from './helpers';
+import { EntitiesFunc, hasManual, hasRainDelayActive, hasRunOnce, isPlayPausable, isProgram, isRainDelayStopTime, isStation, lineHeight, osName, stateActivated, stateWaiting } from './helpers';
 import { renderState } from './opensprinkler-state';
 import { styleMap } from 'lit/directives/style-map';
+import { relativeTime } from './relative_time';
 
 // This puts your card into the UI card picker dialog
 (window as any).customCards = (window as any).customCards || [];
@@ -209,6 +210,11 @@ export class OpensprinklerCard extends LitElement {
   private _secondaryText() {
     const entities: EntitiesFunc = p => this._matchingEntities(p)
 
+    if (hasRainDelayActive(entities)) {
+      const stop_time = entities(isRainDelayStopTime).find(_ => true)?.state;
+      return `Rain delay${ stop_time ? ` ends ${relativeTime(new Date(stop_time), this.hass!.locale!)}` : ''}`;
+    }
+
     const programs = entities(isProgram).filter(stateActivated).map(osName);
     if (hasRunOnce(entities)) programs.splice(0, 0, 'Once Program');
     if (hasManual(entities)) programs.push('Stations Manually');

src/relative_time.ts

@@ -0,0 +1,52 @@
+//REF: https://github.com/custom-cards/custom-card-helpers/blob/master/src/datetime/relative_time.ts
+//REF: https://github.com/home-assistant/frontend/blob/dev/src/common/datetime/relative_time.ts
+
+import { selectUnit } from "@formatjs/intl-utils";
+
+// REF: https://github.com/custom-cards/custom-card-helpers/blob/master/src/types.ts
+// REF: https://github.com/home-assistant/frontend/blob/dev/src/data/translation.ts
+enum NumberFormat {
+    language = "language",
+    system = "system",
+    comma_decimal = "comma_decimal",
+    decimal_comma = "decimal_comma",
+    space_comma = "space_comma",
+    none = "none",
+}
+
+export enum TimeFormat {
+    language = "language",
+    system = "system",
+    am_pm = "12",
+    twenty_four = "24",
+}
+
+interface MinBarFrontendLocaleData {
+    language: string;
+}
+
+ const formatRelTimeMem =
+  (locale: MinBarFrontendLocaleData) =>
+    new Intl.RelativeTimeFormat(locale.language, { numeric: "auto" });
+
+/**
+ * Calculate a string representing a date object as relative time from now.
+ *
+ * Example output: 5 minutes ago, in 3 days.
+ */
+ export const relativeTime = (
+  from: Date,
+  locale: MinBarFrontendLocaleData,
+  to?: Date,
+  includeTense = true
+): string => {
+  const diff = selectUnit(from, to);
+  if (includeTense) {
+    return formatRelTimeMem(locale).format(diff.value, diff.unit);
+  }
+  return Intl.NumberFormat(locale.language, {
+    style: "unit",
+    unit: diff.unit,
+    unitDisplay: "long",
+  }).format(Math.abs(diff.value));
+};