add: set_thermostat_override action and global tokens for manager

mskg · mskg · commit 0bee89475c19 · 2019-02-22T11:18:36.000+01:00
change: add startup method for manager
change: token for flow due to circular dependency
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -4,4 +4,9 @@
     "files.trimTrailingWhitespace": true,
     "editor.tabSize": 4,
     "editor.useTabStops": true,
+
+    "editor.codeActionsOnSave": {
+		// "source.organizeImports": true,
+        "source.fixAll": true
+    },
 }
diff --git a/package.json b/package.json
@@ -75,7 +75,7 @@
     "homey:install": "npm run build:app:prod && npm run build:web:prod && athom -p ../homey-heating-dist app install",
     "dist": "npm run build:app:prod && npm run build:web:prod && athom -p ../homey-heating-dist app validate --level publish",
     "tag": "npm run lint:app && npm run lint:web && npm run test && git tag",
-    "test": "tsc -p ./src/test/tsconfig.json && mocha",
+    "test": "rimraf tmp && tsc -p ./src/test/tsconfig.json && mocha",
     "release:install": "node scripts/install.js",
     "travis:setversion": "node scripts/update-version.js",
     "travis:sentry": "sentry-cli",
diff --git a/src/app.json b/src/app.json
@@ -171,6 +171,47 @@
             ]
           }
         ]
+      },
+      {
+        "id": "set_thermostat_override",
+        "title": {
+          "en": "Set thermostat mode",
+          "nl": "Activeer thermostaatmodus"
+        },
+        "args": [
+          {
+            "type": "dropdown",
+            "name": "mode",
+            "values": [
+              {
+                "id": "0",
+                "label": {
+                  "en": "Heating plan (automatic)",
+                  "nl": "Verwarmingsschema (automatisch)"
+                }
+              },
+              {
+                "id": "6",
+                "label": {
+                  "en": "Manual until midnight",
+                  "nl": "Handmatig tot middernacht"
+                }
+              },
+              {
+                "id": "7",
+                "label": {
+                  "en": "Fully manual",
+                  "nl": "Volledig handmatig"
+                }
+              }
+            ]
+          },
+          {
+            "name": "my_device",
+            "type": "device",
+            "filter": "driver_id=virtual-thermostat"
+          }
+        ]
       }
     ],
     "triggers": [
@@ -308,4 +349,4 @@
       }
     }
   ]
-}
+}
diff --git a/src/app/app.ts b/src/app/app.ts
@@ -7,7 +7,7 @@ import {
     HeatingSchedulerService, ILogger, LoggerFactory, LogService,
 } from "@app/services";
 import { App as HomeyApp } from "homey";
-import { container, injectable } from "tsyringe";
+import { container, inject, injectable } from "tsyringe";
 
 @injectable()
 export class HeatingSchedulerApp {
@@ -17,7 +17,7 @@ export class HeatingSchedulerApp {
         private loggerFactory: LoggerFactory,
         private heatingScheduler: HeatingSchedulerService,
         private heatingManager: HeatingManagerService,
-        private flowService: FlowService) {
+        @inject("FlowService") private flowService: FlowService) {
 
         this.logger = this.loggerFactory.createLogger("App");
     }
@@ -39,7 +39,7 @@ export class HeatingSchedulerApp {
         await this.flowService.init();
 
         // apply what we have
-        await this.heatingManager.applyPlans();
+        await this.heatingManager.init();
 
         // startup scheduler
         await this.heatingScheduler.start();
diff --git a/src/app/services/flow-service/FlowService.ts b/src/app/services/flow-service/FlowService.ts
@@ -1,5 +1,5 @@
-import { FlowCardTrigger, FlowCardTriggerDevice } from "homey";
-import { container, singleton } from "tsyringe";
+import { __, FlowCardTrigger, FlowCardTriggerDevice, FlowToken } from "homey";
+import { container, registry, singleton } from "tsyringe";
 import { HeatingManagerService } from "../heating-manager";
 import { HeatingPlanRepositoryService } from "../heating-plan-repository";
 import { HeatingSchedulerService } from "../heating-scheduler";
@@ -11,14 +11,30 @@ import { ModeChangedTrigger, ModeChangedTriggerTokens } from "./ModeChanged";
 import { SetLogStateAction } from "./SetLogState";
 import { SetModeAction } from "./SetMode";
 import { SetPlanStateAction } from "./SetPlanState";
+import { SetThermostatOverrideAction } from "./SetThermostatOverride";
 import { ThermostatModeChangedTrigger, ThermostatModeChangedTriggerTokens } from "./ThermostatModeChanged";
 
+const FLOWSERVICE_TOKEN = "FlowService";
+
+// to break the cycling dependency
 @singleton()
+@registry([{ token: FLOWSERVICE_TOKEN, useToken: FlowService }])
 export class FlowService {
     private logger: ILogger;
     private modeChangedTrigger!: FlowCardTrigger<ModeChangedTriggerTokens, void>;
     private thermostatModeChangedTrigger!: FlowCardTriggerDevice<ThermostatModeChangedTriggerTokens, void>;
 
+    private modeToken!: FlowToken<string>;
+    private nextDateToken!: FlowToken<string>;
+
+    public get nextDate(): FlowToken<string> {
+        return this.nextDateToken;
+    }
+
+    public get mode(): FlowToken<string> {
+        return this.modeToken;
+    }
+
     public get modeChanged(): FlowCardTrigger<ModeChangedTriggerTokens, void> {
         return this.modeChangedTrigger;
     }
@@ -43,10 +59,27 @@ export class FlowService {
             settings: container.resolve<SettingsManagerService>(SettingsManagerService),
         };
 
-        [ApplyAllAction, ApplyPlanAction, SetLogStateAction, SetModeAction, SetPlanStateAction]
-            .forEach((action) => action(ctx));
+        [
+            ApplyAllAction,
+            ApplyPlanAction,
+            SetLogStateAction,
+            SetModeAction,
+            SetPlanStateAction,
+            SetThermostatOverrideAction,
+        ].forEach((action) => {
+            // tslint:disable-next-line: no-empty
+            try { action(ctx); } catch { }
+        });
 
         this.modeChangedTrigger = ModeChangedTrigger(ctx);
         this.thermostatModeChangedTrigger = ThermostatModeChangedTrigger(ctx);
+
+        this.logger.information(`Registering token mode`);
+        this.modeToken = new FlowToken<string>("mode", { type: "string", title: __("plans.heatingmode.label") });
+        await this.modeToken.register();
+
+        this.logger.information(`Registering token next_schedule`);
+        this.nextDateToken = new FlowToken<string>("next_schedule", { type: "string", title: __("temperatures.next") });
+        await this.nextDateToken.register();
     }
 }
diff --git a/src/app/services/flow-service/SetThermostatOverride.ts b/src/app/services/flow-service/SetThermostatOverride.ts
@@ -0,0 +1,17 @@
+
+import { NormalOperationMode, ThermostatMode } from "@app/model";
+import { IVirtualThermostat } from "../../../drivers/types";
+import { flowCardActionFactory, IFlowContext } from "./args";
+
+type ChangeModeArgs = {
+    mode: string;
+    my_device: IVirtualThermostat;
+};
+
+export function SetThermostatOverrideAction({ logger }: IFlowContext) {
+    return flowCardActionFactory<ChangeModeArgs>("set_thermostat_override", logger, async (args, _state) => {
+        await args.my_device.changeThermostatMode(
+            parseInt(args.mode, 10) as (ThermostatMode | NormalOperationMode));
+        return true;
+    });
+}
diff --git a/src/app/services/heating-manager/HeatingManagerService.ts b/src/app/services/heating-manager/HeatingManagerService.ts
@@ -2,7 +2,7 @@ import { ICalculatedTemperature, IGroupedCalculatedTemperature, IHeatingPlan, No
 import { __, Notification } from "homey";
 import { forEach, groupBy, isEmpty, map } from "lodash";
 import { EventDispatcher, IEvent } from "ste-events";
-import { container, singleton } from "tsyringe";
+import { container, inject, singleton } from "tsyringe";
 import { HeatingPlanCalculator } from "../calculator";
 import { AuditedDevice, DeviceManagerService } from "../device-manager";
 import { FlowService } from "../flow-service";
@@ -44,7 +44,7 @@ export class HeatingManagerService {
         private calc: HeatingPlanCalculator,
         private deviceManager: DeviceManagerService,
         private settings: SettingsManagerService,
-        private flow: FlowService,
+        @inject("FlowService") private flow: FlowService,
         loggerFactory: LoggerFactory) {
         this.logger = loggerFactory.createLogger("Manager");
         this.isRunning = false;
@@ -94,13 +94,19 @@ export class HeatingManagerService {
         this.mode = mode;
         this.settings.set<number>(InternalSettings.OperationMode, mode);
 
+        if (this.flow.mode != null) { this.flow.mode.setValue(__(`Modes.${mode}`)); }
+        this.onModeDispatcher.dispatch(this, mode);
+
         if (this.settings.get(Settings.NotifyModeChange, true)) {
             this.sendNotification("set_operation_mode", {
                 mode: __(`Modes.${mode}`),
             });
         }
+    }
 
-        this.onModeDispatcher.dispatch(this, mode);
+    public async init() {
+        this.flow.mode.setValue(__(`Modes.${this.mode}`));
+        await this.applyPlans();
     }
 
     // erors handled by all callers
diff --git a/src/app/services/heating-scheduler/HeatingSchedulerService.ts b/src/app/services/heating-scheduler/HeatingSchedulerService.ts
@@ -3,8 +3,9 @@ import { Mutex, slotTime } from "@app/helper";
 import { IHeatingPlan, NormalOperationMode, OverrideMode, ThermostatMode } from "@app/model";
 import { ManagerCron } from "homey";
 import { first, groupBy, map, sortBy, unionBy } from "lodash";
-import { singleton } from "tsyringe";
+import { inject, singleton } from "tsyringe";
 import { HeatingPlanCalculator } from "../calculator";
+import { FlowService } from "../flow-service";
 import { HeatingManagerService } from "../heating-manager";
 import { HeatingPlanRepositoryService } from "../heating-plan-repository";
 import { asynctrycatchlog, ICategoryLogger, LoggerFactory, trycatchlog } from "../log";
@@ -29,6 +30,7 @@ export class HeatingSchedulerService {
         private calculator: HeatingPlanCalculator,
         private repository: HeatingPlanRepositoryService,
         private settings: SettingsManagerService,
+        @inject("FlowService") private flow: FlowService,
 
         loggerFactory: LoggerFactory) {
         this.logger = loggerFactory.createLogger("Scheduler");
@@ -211,6 +213,10 @@ export class HeatingSchedulerService {
         this.logger.information(`Next execution is at ${this.next.toLocaleString()}`, plansToExecute.map((p) => `${p.name} (${p.id})`));
         const task = await ManagerCron.registerTask(taskName, this.next, plansToExecute);
 
+        if (this.flow.nextDate != null) {
+            this.flow.nextDate.setValue(this.next.toLocaleString());
+        }
+
         if (this.next === END_OF_DAY) {
             task.once("run", this.clearOverrides.bind(this));
         } else {
diff --git a/src/app/services/index.ts b/src/app/services/index.ts
@@ -1,12 +1,12 @@
 // Order is important for dependency injection!
 export * from "./settings-manager";
 export * from "./log";
+
 export * from "./homey-api";
 export * from "./calculator";
 export * from "./heating-scheduler";
 export * from "./device-manager";
 export * from "./heating-plan-repository";
-export * from "./heating-manager";
 export * from "./flow-service";
-
+export * from "./heating-manager";
 export * from "./bootstrapper";
diff --git a/src/drivers/types.ts b/src/drivers/types.ts
@@ -0,0 +1,6 @@
+import { NormalOperationMode, ThermostatMode } from "@app/model";
+import { Device } from "homey";
+
+export interface IVirtualThermostat extends Device {
+    changeThermostatMode(mode: ThermostatMode | NormalOperationMode): Promise<void>;
+}
diff --git a/src/drivers/virtual-thermostat/device.ts b/src/drivers/virtual-thermostat/device.ts
@@ -6,20 +6,21 @@ import { AsyncDebounce } from "@app/helper";
 import { ICalculatedTemperature, IHeatingPlan, NormalOperationMode, ThermostatMode } from "@app/model";
 import {
     asynctrycatchlog, AuditedDevice, BootStrapper, CapabilityChangedEventArgs, CapabilityType,
-    DeviceManagerService, FlowService, HeatingManagerService, HeatingPlanRepositoryService,
-    HeatingSchedulerService, ILogger, InternalSettings, LoggerFactory, PlanChangeEventType,
-    PlansAppliedEventArgs, PlansChangedEventArgs, SettingsManagerService,
+    DeviceManagerService, FlowService, HeatingManagerService,
+    HeatingPlanRepositoryService, HeatingSchedulerService, ILogger, InternalSettings, LoggerFactory,
+    PlanChangeEventType, PlansAppliedEventArgs, PlansChangedEventArgs, SettingsManagerService,
 } from "@app/services";
 import { __, Device } from "homey";
 import { filter, find } from "lodash";
 import { IEventHandler } from "ste-events";
 import { container } from "tsyringe";
+import { IVirtualThermostat } from "../types";
 
 type Data = {
     id: string;
 };
 
-class VirtualThermostat extends Device {
+class VirtualThermostat extends Device implements IVirtualThermostat {
     private devices!: DeviceManagerService;
     private repository!: HeatingPlanRepositoryService;
     private manager!: HeatingManagerService;
@@ -47,7 +48,7 @@ class VirtualThermostat extends Device {
         this.repository = container.resolve<HeatingPlanRepositoryService>(HeatingPlanRepositoryService);
         this.manager = container.resolve<HeatingManagerService>(HeatingManagerService);
         this.devices = container.resolve<DeviceManagerService>(DeviceManagerService);
-        this.flow = container.resolve<FlowService>(FlowService);
+        this.flow = container.resolve<FlowService>("FlowService");
 
         const settings = container.resolve<SettingsManagerService>(SettingsManagerService);
 
@@ -87,6 +88,11 @@ class VirtualThermostat extends Device {
         this.logger.information(`was removed`);
     }
 
+    public async changeThermostatMode(mode: ThermostatMode | NormalOperationMode) {
+        // conversion forward, backward, ...
+        await this.onThermostatModeChanged(mode.toString(), null);
+    }
+
     /**
      * Plans in the repository changed
      */
diff --git a/src/test/setup.ts b/src/test/setup.ts
@@ -1,7 +1,8 @@
+import "reflect-metadata";
+
 import { flatten, keyBy } from "lodash";
 import "mocha";
 import * as mock from "mock-require";
-import "reflect-metadata";
 
 (global as any).__PRODUCTION__ = false;
 // @ts-ignore
diff --git a/src/test/tsconfig.json b/src/test/tsconfig.json
@@ -9,6 +9,7 @@
   "include": [
     "../types/global.d.ts",
     "setup.ts",
+    "../drivers/types.ts",
     "../app/model/**/*.ts",
     "../services/**/*.ts",
     "../app/helper/**/*.ts",
diff --git a/src/types/homey/index.d.ts b/src/types/homey/index.d.ts
@@ -35,6 +35,17 @@ declare module "homey" {
         on(s: "update", cb: EventHandler<void>): void
     }
 
+    export class Image {
+
+    }
+
+    export class FlowToken<T extends string | boolean | number | Image> {
+        constructor(id: string, args: { type: "string" | "boolean" | "number" | "Image", title: string});
+        public register(): Promise<void>;
+        public setValue(arg: T): void;
+    }
+
+
     export class FlowCardTrigger<T, S> extends FlowCard {
         trigger(tokens: T, state: S): Promise<void>;
     }
