hoffmation-base 3.0.2 → 3.1.0

package/lib/interfaces/baseDevices/iTemperatureCollector.d.ts

@@ -0,0 +1,37 @@
+import { iRoomDevice } from './iRoomDevice';
+import { TemperatureSensorChangeAction } from '../../action';
+import { iTemperatureSensor } from './iTemperatureSensor';
+export declare const UNDEFINED_TEMP_VALUE = -99;
+/**
+ * This interface represents a temperature sensor device.
+ *
+ * For devices with {@link DeviceCapability.temperatureSensor} capability.
+ */
+export interface iTemperatureCollector extends iRoomDevice {
+    /**
+     * Service which handles common aspects of the temperature sensor like persisting
+     */
+    readonly temperatureSensor: iTemperatureSensor;
+    /**
+     * The current room temperature as a number in Celsius
+     */
+    roomTemperature: number;
+    /**
+     * The devices measured Temperature as a number in Celsius
+     */
+    readonly iTemperature: number;
+    /**
+     * Formatted Temperature as a string in Celsius
+     */
+    sTemperature: string;
+    /**
+     * Adds a callback to be called when the temperature changes
+     * @param pCallback - The callback to be called
+     */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    /**
+     * Inform the temperature sensor that the temperature in the room has changed
+     * @param newTemperatur - The new temperature in the room in Celsius
+     */
+    onTemperaturChange(newTemperatur: number): void;
+}

package/lib/interfaces/baseDevices/iTemperatureSensor.d.ts

@@ -0,0 +1,40 @@
+import { iJsonOmitKeys } from '../iJsonOmitKeys';
+import { TemperatureSensorChangeAction } from '../../action';
+/**
+ *
+ */
+export interface iTemperatureSensor extends iJsonOmitKeys {
+    /**
+     *
+     */
+    roomTemperature: number;
+    /**
+     *
+     */
+    outdoorTemperatureCorrectionCoefficient: number;
+    /**
+     *
+     */
+    lastSeen: number;
+    /**
+     *
+     */
+    temperature: number;
+    /**
+     * Persists the current temperature sensor information to the database
+     */
+    persist(): void;
+    /**
+     * Adds a callback to be called when the temperature changes
+     * @param pCallback - The callback to be called
+     */
+    addTempChangeCallback(pCallback: (action: TemperatureSensorChangeAction) => void): void;
+    /**
+     *
+     */
+    dispose(): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iTemperatureSensor>;
+}

package/lib/interfaces/baseDevices/iTemporaryDisableAutomatic.d.ts

@@ -0,0 +1,20 @@
+import { iBaseDevice } from './iBaseDevice';
+import { RestoreTargetAutomaticValueCommand } from '../../command';
+import { iBlockAutomaticHandler } from '../iBlockAutomaticHandler';
+/**
+ * This interface represents a device which automatic action can be temporarily disabled.
+ * E.g. Forcing a lamp to stay on, even if the automatic would turn it off.
+ *
+ * For devices with {@link DeviceCapability.blockAutomatic} capability.
+ */
+export interface iTemporaryDisableAutomatic extends iBaseDevice {
+    /**
+     * The block automation handler containing the current block state/time, etc.
+     */
+    readonly blockAutomationHandler: iBlockAutomaticHandler;
+    /**
+     * Restores the automatic value/state of the device
+     * @param command - The command to restore the automatic value/state
+     */
+    restoreTargetAutomaticValue(command: RestoreTargetAutomaticValueCommand): void;
+}

package/lib/interfaces/baseDevices/iWaterSensor.d.ts

@@ -0,0 +1,13 @@
+/**
+ *
+ */
+export interface iWaterSensor {
+    /**
+     *
+     */
+    water: boolean;
+    /**
+     *
+     */
+    stopAlarm(quiet: boolean, timeout: number): void;
+}

package/lib/interfaces/baseDevices/iWledDevice.d.ts

@@ -0,0 +1,11 @@
+import { iDimmableLamp } from './iDimmableLamp';
+import { WledSetLightCommand } from '../../command';
+/**
+ *
+ */
+export interface iWledDevice extends iDimmableLamp {
+    /**
+     *
+     */
+    setWled(c: WledSetLightCommand): void;
+}

package/lib/interfaces/baseDevices/index.d.ts

@@ -0,0 +1,34 @@
+export { iAcDevice } from './iAcDevice';
+export * from './iActuator';
+export * from './iBaseDevice';
+export * from './iBattery';
+export * from './iBatteryDevice';
+export * from './iButtonSwitch';
+export * from './iButton';
+export * from './iCameraDevice';
+export * from './iDimmableLamp';
+export * from './iEnergyManager';
+export * from './iExcessEnergyConsumer';
+export * from './iGarageDoorOpener';
+export * from './iHandle';
+export * from './iHeater';
+export * from './iHumidityCollector';
+export * from './iIlluminationSensor';
+export * from './iLamp';
+export * from './iMotionSensor';
+export * from './iRoomDevice';
+export * from './iScene';
+export * from './iShutter';
+export * from './iSmokeDetectorDevice';
+export * from './iSpeaker';
+export * from './iTemperatureCollector';
+export * from './iTemporaryDisableAutomatic';
+export * from './iTvDevice';
+export * from './iVibrationSensor';
+export { iMagnetSensor } from './iMagnetSensor';
+export * from './IZigbeeDevice';
+export { iHandleSensor } from './iHandleSensor';
+export { iWaterSensor } from './iWaterSensor';
+export { iWledDevice } from './iWledDevice';
+export { iTemperatureSensor } from './iTemperatureSensor';
+export { iHumiditySensor } from './iHumiditySensor';

package/lib/interfaces/baseDevices/index.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./iActuator"), exports);
+__exportStar(require("./iBaseDevice"), exports);
+__exportStar(require("./iBattery"), exports);
+__exportStar(require("./iBatteryDevice"), exports);
+__exportStar(require("./iButtonSwitch"), exports);
+__exportStar(require("./iButton"), exports);
+__exportStar(require("./iCameraDevice"), exports);
+__exportStar(require("./iDimmableLamp"), exports);
+__exportStar(require("./iEnergyManager"), exports);
+__exportStar(require("./iExcessEnergyConsumer"), exports);
+__exportStar(require("./iGarageDoorOpener"), exports);
+__exportStar(require("./iHandle"), exports);
+__exportStar(require("./iHeater"), exports);
+__exportStar(require("./iHumidityCollector"), exports);
+__exportStar(require("./iIlluminationSensor"), exports);
+__exportStar(require("./iLamp"), exports);
+__exportStar(require("./iMotionSensor"), exports);
+__exportStar(require("./iRoomDevice"), exports);
+__exportStar(require("./iScene"), exports);
+__exportStar(require("./iShutter"), exports);
+__exportStar(require("./iSmokeDetectorDevice"), exports);
+__exportStar(require("./iSpeaker"), exports);
+__exportStar(require("./iTemperatureCollector"), exports);
+__exportStar(require("./iTemporaryDisableAutomatic"), exports);
+__exportStar(require("./iTvDevice"), exports);
+__exportStar(require("./iVibrationSensor"), exports);
+__exportStar(require("./IZigbeeDevice"), exports);

package/lib/interfaces/dachs/IWriteKeyList.js

@@ -0,0 +1,3 @@
+"use strict";
+/* eslint-disable jsdoc/require-jsdoc */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/interfaces/deviceSettings/IDimmerSettings.d.ts

@@ -0,0 +1,39 @@
+import { iActuatorSettings } from './iActuatorSettings';
+import { DimmerSetLightCommand, LampSetTimeBasedCommand } from '../../command';
+/**
+ *
+ */
+export interface iDimmerSettings extends iActuatorSettings {
+    /**
+     *
+     */
+    nightBrightness: number;
+    /**
+     *
+     */
+    dawnBrightness: number;
+    /**
+     *
+     */
+    duskBrightness: number;
+    /**
+     *
+     */
+    dayBrightness: number;
+    /**
+     *
+     */
+    turnOnThreshhold: number;
+    /**
+     *
+     */
+    fromPartialObject(data: Partial<iDimmerSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iDimmerSettings>;
+    /**
+     *
+     */
+    buildDimmerSetLightCommand(c: LampSetTimeBasedCommand): DimmerSetLightCommand;
+}

package/lib/interfaces/deviceSettings/iAcSettings.d.ts

@@ -0,0 +1,59 @@
+import { iExcessEnergyConsumerSettings } from '../settings';
+import { iDeviceSettings } from './iDeviceSettings';
+/**
+ *
+ */
+export interface iAcSettings extends iDeviceSettings {
+    /**
+     *
+     */
+    energySettings: iExcessEnergyConsumerSettings;
+    /**
+     *
+     */
+    minimumHours: number;
+    /**
+     *
+     */
+    minimumMinutes: number;
+    /**
+     *
+     */
+    maximumHours: number;
+    /**
+     *
+     */
+    maximumMinutes: number;
+    /**
+     *
+     */
+    heatingAllowed: boolean;
+    /**
+     *
+     */
+    useOwnTemperature: boolean;
+    /**
+     *
+     */
+    useAutomatic: boolean;
+    /**
+     *
+     */
+    noCoolingOnMovement: boolean;
+    /**
+     *
+     */
+    manualDisabled: boolean;
+    /**
+     *
+     */
+    minOutdoorTempForCooling: number;
+    /**
+     *
+     */
+    fromPartialObject(data: Partial<iAcSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iAcSettings>;
+}

package/lib/interfaces/deviceSettings/iActuatorSettings.d.ts

@@ -0,0 +1,46 @@
+import { iDeviceSettings } from './iDeviceSettings';
+/**
+ *
+ */
+export interface iActuatorSettings extends iDeviceSettings {
+    /**
+     *
+     */
+    dawnOn: boolean;
+    /**
+     *
+     */
+    duskOn: boolean;
+    /**
+     *
+     */
+    nightOn: boolean;
+    /**
+     *
+     */
+    dayOn: boolean;
+    /**
+     *
+     */
+    isStromStoss: boolean;
+    /**
+     *
+     */
+    resetToAutomaticOnForceOffAfterForceOn: boolean;
+    /**
+     *
+     */
+    stromStossResendTime: number;
+    /**
+     *
+     */
+    includeInAmbientLight: boolean;
+    /**
+     *
+     */
+    fromPartialObject(data: Partial<iActuatorSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iActuatorSettings>;
+}

package/lib/interfaces/deviceSettings/iCameraSettings.d.ts

@@ -0,0 +1,34 @@
+import { iMotionSensorSettings } from './iMotionSensorSettings';
+/**
+ *
+ */
+export interface iCameraSettings extends iMotionSensorSettings {
+    /**
+     *
+     */
+    alertPersonOnTelegram: boolean;
+    /**
+     *
+     */
+    movementDetectionOnPersonOnly: boolean;
+    /**
+     *
+     */
+    movementDetectionOnDogsToo: boolean;
+    /**
+     *
+     */
+    hasAudio: boolean;
+    /**
+     *
+     */
+    hasSpeaker: boolean;
+    /**
+     *
+     */
+    fromPartialObject(data: Partial<iCameraSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iCameraSettings>;
+}

package/lib/interfaces/deviceSettings/iDachsDeviceSettings.d.ts

@@ -0,0 +1,50 @@
+import { iActuatorSettings } from './iActuatorSettings';
+/**
+ *
+ */
+export interface iDachsDeviceSettings extends iActuatorSettings {
+    /**
+     *
+     */
+    refreshIntervalTime: number;
+    /**
+     *
+     */
+    batteryLevelTurnOnThreshold: number;
+    /**
+     *
+     */
+    batteryLevelBeforeNightTurnOnThreshold: number;
+    /**
+     *
+     */
+    batteryLevelAllowStartThreshold: number;
+    /**
+     *
+     */
+    batteryLevelPreventStartThreshold: number;
+    /**
+     *
+     */
+    batteryLevelHeatingRodThreshold: number;
+    /**
+     *
+     */
+    warmWaterDesiredMinTemp: number;
+    /**
+     *
+     */
+    winterMinimumHeatStorageTemp: number;
+    /**
+     *
+     */
+    winterMinimumPreNightHeatStorageTemp: number;
+    /**
+     *
+     */
+    fromPartialObject(data: Partial<iDachsDeviceSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iDachsDeviceSettings>;
+}

package/lib/interfaces/deviceSettings/iDeviceSettings.d.ts

@@ -0,0 +1,31 @@
+import { iBlockAutomaticSettings, iExcessEnergyConsumerSettings, iObjectSettings } from '../settings';
+import { ActuatorSetStateCommand, BlockAutomaticCommand } from '../../command';
+/**
+ *
+ */
+export interface iDeviceSettings extends iObjectSettings {
+    /**
+     *
+     */
+    energySettings: iExcessEnergyConsumerSettings | undefined;
+    /**
+     *
+     */
+    blockAutomaticSettings: iBlockAutomaticSettings | undefined;
+    /**
+     *
+     */
+    skipInHomebridge: boolean;
+    /**
+     *
+     */
+    fromPartialObject(_obj: Partial<iDeviceSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iDeviceSettings>;
+    /**
+     *
+     */
+    buildBlockAutomaticCommand(c: ActuatorSetStateCommand): BlockAutomaticCommand | null | undefined;
+}

package/lib/interfaces/deviceSettings/iGarageDoorOpenerSettings.d.ts

@@ -0,0 +1,18 @@
+import { iDeviceSettings } from './iDeviceSettings';
+/**
+ *
+ */
+export interface iGarageDoorOpenerSettings extends iDeviceSettings {
+    /**
+     *
+     */
+    invertSensor: boolean;
+    /**
+     *
+     */
+    fromPartialObject(data: Partial<iGarageDoorOpenerSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iGarageDoorOpenerSettings>;
+}

package/lib/interfaces/deviceSettings/iMotionSensorSettings.d.ts

@@ -0,0 +1,22 @@
+import { iDeviceSettings } from './iDeviceSettings';
+/**
+ *
+ */
+export interface iMotionSensorSettings extends iDeviceSettings {
+    /**
+     *
+     */
+    seesWindow: boolean;
+    /**
+     *
+     */
+    excludeFromNightAlarm: boolean;
+    /**
+     *
+     */
+    fromPartialObject(data: Partial<iMotionSensorSettings>): void;
+    /**
+     *
+     */
+    toJSON(): Partial<iMotionSensorSettings>;
+}

package/lib/interfaces/deviceSettings/index.d.ts

@@ -0,0 +1,8 @@
+export * from './iAcSettings';
+export * from './iActuatorSettings';
+export * from './iCameraSettings';
+export * from './iDachsDeviceSettings';
+export * from './iDeviceSettings';
+export * from './IDimmerSettings';
+export * from './iGarageDoorOpenerSettings';
+export * from './iMotionSensorSettings';

package/lib/interfaces/deviceSettings/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./iAcSettings"), exports);
+__exportStar(require("./iActuatorSettings"), exports);
+__exportStar(require("./iCameraSettings"), exports);
+__exportStar(require("./iDachsDeviceSettings"), exports);
+__exportStar(require("./iDeviceSettings"), exports);
+__exportStar(require("./IDimmerSettings"), exports);
+__exportStar(require("./iGarageDoorOpenerSettings"), exports);
+__exportStar(require("./iMotionSensorSettings"), exports);

package/lib/interfaces/groups/IPresenceGroup.d.ts

@@ -0,0 +1,69 @@
+import { MotionSensorAction, PresenceGroupAnyMovementAction, PresenceGroupFirstEnterAction, PresenceGroupLastLeftAction } from '../../action';
+import { iBaseGroup, iMotionSensor } from '../index';
+/**
+ *
+ */
+export interface iPresenceGroup extends iBaseGroup {
+    /**
+     *
+     */
+    readonly lastLeftDelayActive: boolean;
+    /**
+     *
+     */
+    getMotionDetector(): Array<iMotionSensor>;
+    /**
+     *
+     */
+    initCallbacks(): void;
+    /**
+     *
+     */
+    anyPresent(includeMovementResetDelayCheck?: boolean): boolean;
+    /**
+     *
+     */
+    addLastLeftCallback(cb: (action: PresenceGroupLastLeftAction) => void): void;
+    /**
+     *
+     */
+    addAnyMovementCallback(cb: (action: PresenceGroupAnyMovementAction) => void): void;
+    /**
+     *
+     */
+    presentAmount(): number;
+    /**
+     *
+     */
+    fireFistEnterCBs(action: MotionSensorAction): void;
+    /**
+     *
+     */
+    addFirstEnterCallback(cb: (action: PresenceGroupFirstEnterAction) => void): void;
+    /**
+     *
+     */
+    motionSensorOnAnyMovement(action: MotionSensorAction): void;
+    /**
+     *
+     */
+    motionSensorOnLastLeft(action: MotionSensorAction): void;
+    /**
+     * Calculates whether we are after (negative if before) the time the movement
+     * reset timer should have reset the movement.
+     * @returns The time in milliseconds after the reset time.
+     */
+    getTimeAfterReset(): number;
+    /**
+     * In case of an existing delayed last left callback timeout, this removes it.
+     */
+    resetLastLeftTimeout(): void;
+    /**
+     *
+     */
+    executeAnyMovementCbs(action: PresenceGroupAnyMovementAction): void;
+    /**
+     *
+     */
+    executeLastLeftCbs(action: PresenceGroupLastLeftAction): void;
+}

package/lib/interfaces/groups/iBaseGroup.d.ts

@@ -0,0 +1,38 @@
+import { iIdHolder } from '../iIdHolder';
+import { iGroupSettings } from '../settings';
+import { GroupType, LogDebugType, LogLevel } from '../../enums';
+import { iDeviceCluster } from '../iDevicecluster';
+import { iRoomBase } from '../iRoomBase';
+/**
+ *
+ */
+export interface iBaseGroup extends iIdHolder {
+    /**
+     *
+     */
+    settings: iGroupSettings | undefined;
+    /**
+     *
+     */
+    readonly customName: string;
+    /**
+     *
+     */
+    roomName: string;
+    /**
+     *
+     */
+    type: GroupType;
+    /**
+     *
+     */
+    readonly deviceCluster: iDeviceCluster;
+    /**
+     *
+     */
+    getRoom(): iRoomBase;
+    /**
+     *
+     */
+    log(level: LogLevel, message: string, debugType: LogDebugType): void;
+}