@digital-alchemy/core 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 zoe-codez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,47 @@
+# Digital Alchemy core 🌟
+
+## Introduction
+
+`@digital-alchemy`: A TypeScript framework designed for Home Assistant, enabling dynamic entity management, service calls, and automation with minimal dependencies.
+
+## 📦 Major Exports
+
+`@digital-alchemy` framework is built on key exports, each offering unique features that complement one another:
+
+- **@digital-alchemy/core (Base Framework):** Provides caching, logging, configuration, lifecycle events, and utility types.
+
+- **@digital-alchemy/core/hass:** Facilitates base interactions with Home Assistant, including websocket connection management, entity reference checking, and a service call interface.
+
+- **@digital-alchemy/core/synapse:** Enables the generation of new entities in Home Assistant, such as buttons, sensors, and switches. Requires a socket connection and a custom component installation.
+
+- **@digital-alchemy/core/automation:** Focuses on home automation logic, offering room-based scene coordination, active state management for switches, circadian lighting, and more.
+
+- **type-writer (CLI Tool):** A helper script that customizes internal type definitions by connecting to your Home Assistant instance and generating accurate service & entity validations.
+
+## 🛠 Installation
+
+### Synapse Integration
+
+The Synapse component is essential for creating and managing entities within Home Assistant. Visit the [Synapse Repo](https://github.com/zoe-codez/synapse) for installation instructions and to understand its importance in your setup.
+
+## 📚 External Libraries and Examples
+
+Explore the full potential of `@digital-alchemy/core` with our extensions library and illustrative examples. These resources are designed to expand the framework's functionality and provide inspiration for your projects:
+
+### 📚 Extensions Library
+
+Enhance your home automation capabilities with the [Digital Alchemy Extensions Library](https://github.com/digital-alchemy-extensions), which includes:
+
+- **MQTT Bindings:** Seamlessly integrate MQTT protocols for broader IoT connectivity.
+- **Fastify Bindings:** Leverage Fastify to add efficient HTTP server functionality to your automation projects.
+
+### 🎓 Demo and Example Repositories
+
+Kickstart your development with these practical applications:
+
+- **Mock Home:** A comprehensive sandbox for experimenting with and showcasing various automation techniques. [Mock Home on GitHub](https://github.com/zoe-codez/mock-home)
+- **Automation Template:** A starter template to quickly get your projects up and running. [Automation Template on GitHub](https://github.com/zoe-codez/automation-template)
+
+## 🤝 Contribution
+
+We warmly welcome contributions. Whether you're enhancing the framework, sharing examples, or enriching documentation, your efforts significantly benefit the community.

package/dist/automation/automation.module.d.ts

@@ -0,0 +1,61 @@
+import { AggressiveScenes, CircadianLighting, LightManager, ManagedSwitch, Room, SequenceWatcher, SolarCalculator } from "./extensions";
+export declare const LIB_AUTOMATION: import("../boilerplate").LibraryDefinition<{
+    aggressive: typeof AggressiveScenes;
+    circadian: typeof CircadianLighting;
+    light: typeof LightManager;
+    managed_switch: typeof ManagedSwitch;
+    room: typeof Room;
+    sequence: typeof SequenceWatcher;
+    solar: typeof SolarCalculator;
+}, {
+    AGGRESSIVE_SCENES: {
+        default: true;
+        description: string;
+        type: "boolean";
+    };
+    CIRCADIAN_DIFF_THRESHOLD: {
+        default: number;
+        description: string;
+        type: "number";
+    };
+    CIRCADIAN_ENABLED: {
+        default: true;
+        description: string;
+        type: "boolean";
+    };
+    CIRCADIAN_MAX_TEMP: {
+        default: number;
+        description: string;
+        type: "number";
+    };
+    CIRCADIAN_MIN_TEMP: {
+        default: number;
+        description: string;
+        type: "number";
+    };
+    CIRCADIAN_RATE: {
+        default: number;
+        description: string[];
+        type: "number";
+    };
+    CIRCADIAN_SENSOR_NAME: {
+        default: string;
+        description: string;
+        type: "string";
+    };
+    CIRCADIAN_THROTTLE: {
+        default: number;
+        description: string;
+        type: "number";
+    };
+    SEQUENCE_TIMEOUT: {
+        default: number;
+        description: string;
+        type: "number";
+    };
+}>;
+declare module "../boilerplate" {
+    interface LoadedModules {
+        automation: typeof LIB_AUTOMATION;
+    }
+}

package/dist/automation/automation.module.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LIB_AUTOMATION = void 0;
+const boilerplate_1 = require("../boilerplate");
+const extensions_1 = require("./extensions");
+exports.LIB_AUTOMATION = (0, boilerplate_1.CreateLibrary)({
+    configuration: {
+        AGGRESSIVE_SCENES: {
+            default: true,
+            description: "Verify continue to match their desired state as defined by the room's current scene",
+            type: "boolean",
+        },
+        CIRCADIAN_DIFF_THRESHOLD: {
+            default: 50,
+            description: "Current light temperature must be at least this much off target in order to be eligible for adjustment",
+            type: "number",
+        },
+        CIRCADIAN_ENABLED: {
+            default: true,
+            description: "Take responsibility for generating [CIRCADIAN_SENSOR] and emitting updates",
+            type: "boolean",
+        },
+        CIRCADIAN_MAX_TEMP: {
+            default: 5500,
+            description: "Maximum color temperature for circadian lighting. Used at solar noon",
+            type: "number",
+        },
+        CIRCADIAN_MIN_TEMP: {
+            default: 2000,
+            description: "Minimum color temperature for circadian lighting. Used while it's dark out",
+            type: "number",
+        },
+        CIRCADIAN_RATE: {
+            default: 3,
+            description: [
+                "Number of entities to adjust at the same time",
+                "Higher values increase load",
+            ],
+            type: "number",
+        },
+        CIRCADIAN_SENSOR_NAME: {
+            default: "Light temperature",
+            description: "Sensor for reading / writing current light temperature to",
+            type: "string",
+        },
+        CIRCADIAN_THROTTLE: {
+            default: 300,
+            description: "Artificial delay to add",
+            type: "number",
+        },
+        SEQUENCE_TIMEOUT: {
+            default: 1500,
+            description: "When tracking state changes for a sequence event, another change must happen inside this time window",
+            type: "number",
+        },
+    },
+    name: "automation",
+    // light depends circadian
+    priorityInit: ["circadian"],
+    services: {
+        aggressive: extensions_1.AggressiveScenes,
+        circadian: extensions_1.CircadianLighting,
+        light: extensions_1.LightManager,
+        managed_switch: extensions_1.ManagedSwitch,
+        room: extensions_1.Room,
+        sequence: extensions_1.SequenceWatcher,
+        solar: extensions_1.SolarCalculator,
+    },
+});
+//# sourceMappingURL=automation.module.js.map

package/dist/automation/automation.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"automation.module.js","sourceRoot":"","sources":["../../src/automation/automation.module.ts"],"names":[],"mappings":";;;AAAA,gDAA+C;AAC/C,6CAQsB;AAET,QAAA,cAAc,GAAG,IAAA,2BAAa,EAAC;IAC1C,aAAa,EAAE;QACb,iBAAiB,EAAE;YACjB,OAAO,EAAE,IAAI;YACb,WAAW,EACT,qFAAqF;YACvF,IAAI,EAAE,SAAS;SAChB;QACD,wBAAwB,EAAE;YACxB,OAAO,EAAE,EAAE;YACX,WAAW,EACT,wGAAwG;YAC1G,IAAI,EAAE,QAAQ;SACf;QACD,iBAAiB,EAAE;YACjB,OAAO,EAAE,IAAI;YACb,WAAW,EACT,4EAA4E;YAC9E,IAAI,EAAE,SAAS;SAChB;QACD,kBAAkB,EAAE;YAClB,OAAO,EAAE,IAAI;YACb,WAAW,EACT,sEAAsE;YACxE,IAAI,EAAE,QAAQ;SACf;QACD,kBAAkB,EAAE;YAClB,OAAO,EAAE,IAAI;YACb,WAAW,EACT,4EAA4E;YAC9E,IAAI,EAAE,QAAQ;SACf;QACD,cAAc,EAAE;YACd,OAAO,EAAE,CAAC;YACV,WAAW,EAAE;gBACX,+CAA+C;gBAC/C,6BAA6B;aAC9B;YACD,IAAI,EAAE,QAAQ;SACf;QACD,qBAAqB,EAAE;YACrB,OAAO,EAAE,mBAAmB;YAC5B,WAAW,EAAE,2DAA2D;YACxE,IAAI,EAAE,QAAQ;SACf;QACD,kBAAkB,EAAE;YAClB,OAAO,EAAE,GAAG;YACZ,WAAW,EAAE,yBAAyB;YACtC,IAAI,EAAE,QAAQ;SACf;QACD,gBAAgB,EAAE;YAChB,OAAO,EAAE,IAAI;YACb,WAAW,EACT,sGAAsG;YACxG,IAAI,EAAE,QAAQ;SACf;KACF;IACD,IAAI,EAAE,YAAY;IAClB,0BAA0B;IAC1B,YAAY,EAAE,CAAC,WAAW,CAAC;IAC3B,QAAQ,EAAE;QACR,UAAU,EAAE,6BAAgB;QAC5B,SAAS,EAAE,8BAAiB;QAC5B,KAAK,EAAE,yBAAY;QACnB,cAAc,EAAE,0BAAa;QAC7B,IAAI,EAAE,iBAAI;QACV,QAAQ,EAAE,4BAAe;QACzB,KAAK,EAAE,4BAAe;KACvB;CACF,CAAC,CAAC"}

package/dist/automation/extensions/aggressive-scenes.extension.d.ts

@@ -0,0 +1,22 @@
+import { TContext, TServiceParams } from "../..";
+import { RoomScene } from "../helpers";
+type TValidateOptions = {
+    context: TContext;
+    room: string;
+    name: string;
+    scene: RoomScene;
+};
+/**
+ * # Aggressive Scenes extension
+ *
+ * Sets up opt-in functionality that allows for more active management of scene states inside the system
+ * It coordinates with rooms to know what the current state is, and periodically checks entities to ensure that are currently in the state that they are expected to be
+ *
+ * - Correct for changes made in the real world (humans turning on a switch that should be off at the moment)
+ * - Changing definitions of "correct" (like light colors for circadian lighting)
+ * - Entities that failed to change to the correct state when asked the first time
+ */
+export declare function AggressiveScenes({ logger, config, hass, event, automation, }: TServiceParams): {
+    validateRoomScene: ({ scene, room, name, context, }: TValidateOptions) => Promise<void>;
+};
+export {};

package/dist/automation/extensions/aggressive-scenes.extension.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AggressiveScenes = void 0;
+const async_1 = require("async");
+const __1 = require("../..");
+const hass_1 = require("../../hass");
+const helpers_1 = require("../helpers");
+/**
+ * # Aggressive Scenes extension
+ *
+ * Sets up opt-in functionality that allows for more active management of scene states inside the system
+ * It coordinates with rooms to know what the current state is, and periodically checks entities to ensure that are currently in the state that they are expected to be
+ *
+ * - Correct for changes made in the real world (humans turning on a switch that should be off at the moment)
+ * - Changing definitions of "correct" (like light colors for circadian lighting)
+ * - Entities that failed to change to the correct state when asked the first time
+ */
+function AggressiveScenes({ logger, config, hass, event, automation, }) {
+    // eslint-disable-next-line sonarjs/cognitive-complexity
+    async function manageSwitch(entity, scene) {
+        const entity_id = entity.entity_id;
+        const expected = scene[entity_id];
+        if (__1.is.empty(expected)) {
+            // ??
+            return;
+        }
+        if (entity.state === "unavailable") {
+            logger.warn({ name: entity_id }, `{unavailable} entity, cannot manage state`);
+            return;
+        }
+        let performedUpdate = false;
+        if (entity.state !== expected.state) {
+            await matchSwitchToScene(entity, expected);
+            performedUpdate = true;
+        }
+        if (performedUpdate) {
+            return;
+        }
+        if ("entity_id" in entity.attributes) {
+            // ? This is a group
+            const id = entity.attributes.entity_id;
+            if (__1.is.array(id) && !__1.is.empty(id)) {
+                await (0, async_1.each)(entity.attributes.entity_id, async (child_id) => {
+                    const child = hass.entity.byId(child_id);
+                    if (!child) {
+                        logger.warn(`%s => %s child entity of group cannot be found`, entity_id, child_id);
+                        return;
+                    }
+                    if (child.state === "unavailable") {
+                        logger.warn({ name: child_id }, `{unavailable} entity, cannot manage state`);
+                        return;
+                    }
+                    if (child.state !== expected.state) {
+                        await matchSwitchToScene(child, expected);
+                    }
+                });
+            }
+        }
+    }
+    async function matchSwitchToScene(entity, expected) {
+        const entity_id = entity.entity_id;
+        logger.debug({ name: entity_id, state: expected.state }, `changing state`);
+        event.emit(helpers_1.AGGRESSIVE_SCENES_ADJUSTMENT, {
+            entity_id,
+            type: "switch_on_off",
+        });
+        if (expected.state === "on") {
+            await hass.call.switch.turn_on({ entity_id });
+            return;
+        }
+        await hass.call.switch.turn_off({ entity_id });
+    }
+    /**
+     * This function should **NOT** emit logs on noop
+     *
+     * - errors
+     * - warnings
+     * - state changes
+     */
+    async function validateRoomScene({ scene, room, name, context, }) {
+        if (config.automation.AGGRESSIVE_SCENES === false ||
+            scene?.aggressive === false) {
+            // nothing to do
+            return;
+        }
+        if (!scene?.definition) {
+            logger.warn({ context, name, room, scene }, `cannot validate room scene`);
+            return;
+        }
+        if (!__1.is.object(scene.definition) || __1.is.empty(scene.definition)) {
+            // ? There currently is no use case for a scene with no entities in it
+            // Not technically an error though
+            logger.warn("no definition");
+            return;
+        }
+        const entities = Object.keys(scene.definition);
+        await (0, async_1.each)(entities, async (entity_id) => {
+            const entity = hass.entity.byId(entity_id);
+            if (!entity) {
+                // * Home assistant outright does not send an entity for this id
+                // The wrong id was probably input
+                //
+                // ? This is distinct from "unavailable" entities
+                logger.error({ name: entity_id }, `cannot find entity`);
+                return;
+            }
+            const entityDomain = (0, hass_1.domain)(entity_id);
+            switch (entityDomain) {
+                case "light":
+                    await automation.light.manageLight(entity, scene.definition);
+                    return;
+                case "switch":
+                    await manageSwitch(entity, scene.definition);
+                    return;
+                default:
+                    logger.debug({ name: entityDomain }, `no actions set for domain`);
+            }
+        });
+    }
+    return {
+        validateRoomScene,
+    };
+}
+exports.AggressiveScenes = AggressiveScenes;
+//# sourceMappingURL=aggressive-scenes.extension.js.map

package/dist/automation/extensions/aggressive-scenes.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggressive-scenes.extension.js","sourceRoot":"","sources":["../../../src/automation/extensions/aggressive-scenes.extension.ts"],"names":[],"mappings":";;;AAAA,iCAA6B;AAE7B,6BAAqD;AACrD,qCAA+D;AAC/D,wCAMoB;AASpB;;;;;;;;;GASG;AACH,SAAgB,gBAAgB,CAAC,EAC/B,MAAM,EACN,MAAM,EACN,IAAI,EACJ,KAAK,EACL,UAAU,GACK;IACf,wDAAwD;IACxD,KAAK,UAAU,YAAY,CACzB,MAA2C,EAC3C,KAAsB;QAEtB,MAAM,SAAS,GAAG,MAAM,CAAC,SAAkC,CAAC;QAC5D,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAqB,CAAC;QACtD,IAAI,MAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvB,KAAK;YACL,OAAO;QACT,CAAC;QACD,IAAI,MAAM,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;YACnC,MAAM,CAAC,IAAI,CACT,EAAE,IAAI,EAAE,SAAS,EAAE,EACnB,2CAA2C,CAC5C,CAAC;YACF,OAAO;QACT,CAAC;QACD,IAAI,eAAe,GAAG,KAAK,CAAC;QAC5B,IAAI,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;YACpC,MAAM,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC3C,eAAe,GAAG,IAAI,CAAC;QACzB,CAAC;QACD,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QAED,IAAI,WAAW,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACrC,oBAAoB;YACpB,MAAM,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC;YACvC,IAAI,MAAE,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,MAAE,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAA,YAAI,EACR,MAAM,CAAC,UAAU,CAAC,SAAoC,EACtD,KAAK,EAAC,QAAQ,EAAC,EAAE;oBACf,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACzC,IAAI,CAAC,KAAK,EAAE,CAAC;wBACX,MAAM,CAAC,IAAI,CACT,gDAAgD,EAChD,SAAS,EACT,QAAQ,CACT,CAAC;wBACF,OAAO;oBACT,CAAC;oBACD,IAAI,KAAK,CAAC,KAAK,KAAK,aAAa,EAAE,CAAC;wBAClC,MAAM,CAAC,IAAI,CACT,EAAE,IAAI,EAAE,QAAQ,EAAE,EAClB,2CAA2C,CAC5C,CAAC;wBACF,OAAO;oBACT,CAAC;oBACD,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;wBACnC,MAAM,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;oBAC5C,CAAC;gBACH,CAAC,CACF,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,UAAU,kBAAkB,CAC/B,MAA2C,EAC3C,QAA0B;QAE1B,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,EAAE,gBAAgB,CAAC,CAAC;QAC3E,KAAK,CAAC,IAAI,CAAC,sCAA4B,EAAE;YACvC,SAAS;YACT,IAAI,EAAE,eAAe;SACY,CAAC,CAAC;QACrC,IAAI,QAAQ,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC5B,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;YAC9C,OAAO;QACT,CAAC;QACD,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,UAAU,iBAAiB,CAAC,EAC/B,KAAK,EACL,IAAI,EACJ,IAAI,EACJ,OAAO,GACU;QACjB,IACE,MAAM,CAAC,UAAU,CAAC,iBAAiB,KAAK,KAAK;YAC7C,KAAK,EAAE,UAAU,KAAK,KAAK,EAC3B,CAAC;YACD,gBAAgB;YAChB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,4BAA4B,CAAC,CAAC;YAC1E,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAE,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,MAAE,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/D,sEAAsE;YACtE,kCAAkC;YAClC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAkB,CAAC;QAChE,MAAM,IAAA,YAAI,EAAC,QAAQ,EAAE,KAAK,EAAC,SAAS,EAAC,EAAE;YACrC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,gEAAgE;gBAChE,kCAAkC;gBAClC,EAAE;gBACF,iDAAiD;gBACjD,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,oBAAoB,CAAC,CAAC;gBACxD,OAAO;YACT,CAAC;YACD,MAAM,YAAY,GAAG,IAAA,aAAM,EAAC,SAAS,CAAC,CAAC;YACvC,QAAQ,YAAY,EAAE,CAAC;gBACrB,KAAK,OAAO;oBACV,MAAM,UAAU,CAAC,KAAK,CAAC,WAAW,CAChC,MAA4C,EAC5C,KAAK,CAAC,UAAU,CACjB,CAAC;oBACF,OAAO;gBACT,KAAK,QAAQ;oBACX,MAAM,YAAY,CAChB,MAA6C,EAC7C,KAAK,CAAC,UAAU,CACjB,CAAC;oBACF,OAAO;gBACT;oBACE,MAAM,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,2BAA2B,CAAC,CAAC;YACtE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO;QACL,iBAAiB;KAClB,CAAC;AACJ,CAAC;AAnJD,4CAmJC"}

package/dist/automation/extensions/circadian.extension.d.ts

@@ -0,0 +1,11 @@
+import { TServiceParams } from "../../boilerplate";
+/**
+ * # Circadian lighting
+ *
+ * Generate an entity to maintain the current color temperature target for lights
+ */
+export declare function CircadianLighting({ logger, lifecycle, scheduler, synapse, automation, config, context, event, }: TServiceParams): {
+    circadianEntity: import("../../synapse").VirtualSensor<number, object>;
+    getKelvin: () => number;
+    updateKelvin: () => void;
+};

package/dist/automation/extensions/circadian.extension.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CircadianLighting = void 0;
+const tslib_1 = require("tslib");
+const dayjs_1 = tslib_1.__importDefault(require("dayjs"));
+const utilities_1 = require("../../utilities");
+const helpers_1 = require("../helpers");
+const MIN = 0;
+const MAX = 1;
+/**
+ * # Circadian lighting
+ *
+ * Generate an entity to maintain the current color temperature target for lights
+ */
+function CircadianLighting({ logger, lifecycle, scheduler, synapse, automation, config, context, event, }) {
+    let circadianEntity;
+    lifecycle.onPostConfig(() => {
+        if (!config.automation.CIRCADIAN_ENABLED) {
+            logger.info(`circadian disabled`);
+            return;
+        }
+        circadianEntity = synapse.sensor({
+            context,
+            device_class: "temperature",
+            icon: "mdi:sun-thermometer",
+            name: config.automation.CIRCADIAN_SENSOR_NAME,
+            unit_of_measurement: "K",
+        });
+        out.circadianEntity = circadianEntity;
+        scheduler.cron({
+            context,
+            exec: () => updateKelvin(),
+            schedule: utilities_1.CronExpression.EVERY_30_SECONDS,
+        });
+    });
+    event.on(helpers_1.LOCATION_UPDATED, () => updateKelvin());
+    function updateKelvin() {
+        if (!circadianEntity) {
+            return;
+        }
+        if (!automation.solar.loaded) {
+            logger.debug(`lat/long not loaded yet`);
+            return;
+        }
+        const offset = getColorOffset();
+        circadianEntity.state = Math.floor((config.automation.CIRCADIAN_MAX_TEMP -
+            config.automation.CIRCADIAN_MIN_TEMP) *
+            offset +
+            config.automation.CIRCADIAN_MIN_TEMP);
+    }
+    /**
+     * Returns 0 when it's dark out, increasing to 1 at solar noon
+     */
+    function getColorOffset() {
+        if (!circadianEntity) {
+            return MIN;
+        }
+        if (!automation.solar.loaded) {
+            logger.debug(`lat/long not loaded yet`);
+            return MIN;
+        }
+        const now = (0, dayjs_1.default)();
+        const { solarNoon, dawn, dusk } = automation.solar;
+        if (now.isBefore(dawn)) {
+            // After midnight, but before dawn
+            return MIN;
+        }
+        if (now.isBefore(solarNoon)) {
+            // After dawn, but before solar noon
+            return Math.abs(solarNoon.diff(now, "s") / solarNoon.diff(dawn, "s") - MAX);
+        }
+        if (now.isBefore(dusk)) {
+            // Afternoon, but before dusk
+            return Math.abs(solarNoon.diff(now, "s") / solarNoon.diff(dusk, "s") - MAX);
+        }
+        // Until midnight
+        return MIN;
+    }
+    const out = {
+        circadianEntity,
+        getKelvin: () => circadianEntity?.state,
+        updateKelvin,
+    };
+    return out;
+}
+exports.CircadianLighting = CircadianLighting;
+//# sourceMappingURL=circadian.extension.js.map

package/dist/automation/extensions/circadian.extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circadian.extension.js","sourceRoot":"","sources":["../../../src/automation/extensions/circadian.extension.ts"],"names":[],"mappings":";;;;AAAA,0DAA0B;AAG1B,+CAAiD;AACjD,wCAA8C;AAE9C,MAAM,GAAG,GAAG,CAAC,CAAC;AACd,MAAM,GAAG,GAAG,CAAC,CAAC;AAEd;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,EAChC,MAAM,EACN,SAAS,EACT,SAAS,EACT,OAAO,EACP,UAAU,EACV,MAAM,EACN,OAAO,EACP,KAAK,GACU;IACf,IAAI,eAA0D,CAAC;IAE/D,SAAS,CAAC,YAAY,CAAC,GAAG,EAAE;QAC1B,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;YACzC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAClC,OAAO;QACT,CAAC;QACD,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;YAC/B,OAAO;YACP,YAAY,EAAE,aAAa;YAC3B,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,qBAAqB;YAC7C,mBAAmB,EAAE,GAAG;SACzB,CAAC,CAAC;QACH,GAAG,CAAC,eAAe,GAAG,eAAe,CAAC;QAEtC,SAAS,CAAC,IAAI,CAAC;YACb,OAAO;YACP,IAAI,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE;YAC1B,QAAQ,EAAE,0BAAc,CAAC,gBAAgB;SAC1C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,EAAE,CAAC,0BAAgB,EAAE,GAAG,EAAE,CAAC,YAAY,EAAE,CAAC,CAAC;IAEjD,SAAS,YAAY;QACnB,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC7B,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YACxC,OAAO;QACT,CAAC;QACD,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;QAChC,eAAe,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAChC,CAAC,MAAM,CAAC,UAAU,CAAC,kBAAkB;YACnC,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACrC,MAAM;YACN,MAAM,CAAC,UAAU,CAAC,kBAAkB,CACvC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,SAAS,cAAc;QACrB,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC7B,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YACxC,OAAO,GAAG,CAAC;QACb,CAAC;QACD,MAAM,GAAG,GAAG,IAAA,eAAK,GAAE,CAAC;QACpB,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC;QAEnD,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,kCAAkC;YAClC,OAAO,GAAG,CAAC;QACb,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5B,oCAAoC;YACpC,OAAO,IAAI,CAAC,GAAG,CACb,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,GAAG,CAC3D,CAAC;QACJ,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,6BAA6B;YAC7B,OAAO,IAAI,CAAC,GAAG,CACb,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,GAAG,CAC3D,CAAC;QACJ,CAAC;QACD,iBAAiB;QACjB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,GAAG,GAAG;QACV,eAAe;QACf,SAAS,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE,KAAK;QACvC,YAAY;KACb,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC;AA5FD,8CA4FC"}

package/dist/automation/extensions/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./aggressive-scenes.extension";
+export * from "./circadian.extension";
+export * from "./light-manager.extension";
+export * from "./managed-switch.extension";
+export * from "./room.extension";
+export * from "./sequence-matcher.extension";
+export * from "./solar-calc.extension";

package/dist/automation/extensions/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./aggressive-scenes.extension"), exports);
+tslib_1.__exportStar(require("./circadian.extension"), exports);
+tslib_1.__exportStar(require("./light-manager.extension"), exports);
+tslib_1.__exportStar(require("./managed-switch.extension"), exports);
+tslib_1.__exportStar(require("./room.extension"), exports);
+tslib_1.__exportStar(require("./sequence-matcher.extension"), exports);
+tslib_1.__exportStar(require("./solar-calc.extension"), exports);
+//# sourceMappingURL=index.js.map

package/dist/automation/extensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/automation/extensions/index.ts"],"names":[],"mappings":";;;AAAA,wEAA8C;AAC9C,gEAAsC;AACtC,oEAA0C;AAC1C,qEAA2C;AAC3C,2DAAiC;AACjC,uEAA6C;AAC7C,iEAAuC"}

package/dist/automation/extensions/light-manager.extension.d.ts

@@ -0,0 +1,26 @@
+import { TServiceParams } from "../../boilerplate";
+import { ENTITY_STATE, GenericEntityDTO, PICK_ENTITY } from "../../hass";
+import { RoomDefinition } from "..";
+import { SceneDefinition } from "../helpers";
+type ColorModes = "color_temp" | "xy" | "brightness";
+export type ColorLight = GenericEntityDTO<{
+    brightness: number;
+    color_mode: ColorModes;
+    color_temp: number;
+    color_temp_kelvin: number;
+    entity_id?: PICK_ENTITY<"light">[];
+    hs_color: [h: number, s: number];
+    max_color_temp_kelvin: number;
+    max_mireds: number;
+    min_color_temp_kelvin: number;
+    min_mireds: number;
+    rgb_color: [number, number, number];
+    supported_color_modes: ColorModes[];
+    supported_features: number;
+    xy_color: [x: number, y: number];
+}>;
+export declare function LightManager({ logger, hass, scheduler, lifecycle, automation, config, context, }: TServiceParams): {
+    manageLight: (entity: ENTITY_STATE<PICK_ENTITY<"light">>, scene: SceneDefinition) => Promise<void>;
+    registerRoom: (room: RoomDefinition) => Set<RoomDefinition<string>>;
+};
+export {};