iobroker.loxone 3.0.0 → 4.0.0

package/src/controls/Fronius.ts

@@ -0,0 +1,217 @@
+import type { Control } from '../structure-file';
+import type { ControlType } from './control-base';
+import { ControlBase } from './control-base';
+
+/**
+ * Handler for Fronius controls.
+ */
+export class Fronius extends ControlBase {
+    /**
+     * Loads the control and sets up state objects and event handlers.
+     *
+     * @param type The type of the control ('device' or 'channel').
+     * @param uuid The unique identifier of the control.
+     * @param control The control data from the structure file.
+     */
+    async loadAsync(type: ControlType, uuid: string, control: Control): Promise<void> {
+        const systemConfig = await this.adapter.getForeignObjectAsync('system.config');
+        const currency = systemConfig?.common.currency;
+        await this.updateObjectAsync(uuid, {
+            type: type,
+            common: {
+                name: control.name,
+                role: 'sensor',
+            },
+            native: { control },
+        });
+
+        await this.loadOtherControlStatesAsync(control.name, uuid, control.states, [
+            'prodCurr',
+            'prodCurrDay',
+            'prodCurrMonth',
+            'prodCurrYear',
+            'prodTotal',
+            'consCurr',
+            'consCurrDay',
+            'consTotal',
+            'deliveryDay',
+            'earningsDay',
+            'earningsMonth',
+            'earningsYear',
+            'earningsTotal',
+            'gridCurr',
+            'batteryCurr',
+            'stateOfCharge',
+            'priceDelivery',
+            'priceConsumption',
+            'co2Factor',
+            'generatorType',
+            'mode',
+            'online',
+        ]);
+        // note: priceDelivery, priceConsumption, generatorType and mode are ignored
+        // because they represent static data that is of no use to ioBroker
+
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'prodCurr',
+            'number',
+            'value',
+            { unit: 'kW' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'prodCurrDay',
+            'number',
+            'value',
+            { unit: 'kWh' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'prodCurrMonth',
+            'number',
+            'value',
+            { unit: 'kWh' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'prodCurrYear',
+            'number',
+            'value',
+            { unit: 'kWh' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'prodTotal',
+            'number',
+            'value',
+            { unit: 'kWh' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'consCurr',
+            'number',
+            'value',
+            { unit: 'kW' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'consCurrDay',
+            'number',
+            'value.power.consumption',
+            { unit: 'kWh' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'consTotal',
+            'number',
+            'value.power.consumption',
+            { unit: 'kWh' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'gridCurr',
+            'number',
+            'value',
+            { unit: 'kW' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'batteryCurr',
+            'number',
+            'value',
+            { unit: 'kW' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'stateOfCharge',
+            'number',
+            'value',
+            { unit: '%' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'deliveryDay',
+            'number',
+            'value',
+            { unit: 'kWh' },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'earningsDay',
+            'number',
+            'value',
+            { unit: currency },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'earningsMonth',
+            'number',
+            'value',
+            { unit: currency },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'earningsYear',
+            'number',
+            'value',
+            { unit: currency },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'earningsTotal',
+            'number',
+            'value',
+            { unit: currency },
+        );
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'co2Factor',
+            'number',
+            'value',
+        );
+        await this.createBooleanControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'online',
+            'indicator.reachable',
+            {},
+            value => value != 1, // according to docs: 0 = online, 1 = offline
+        );
+    }
+}

package/src/controls/Gate.ts

@@ -0,0 +1,150 @@
+import type { CurrentStateValue, OldStateValue } from '../main';
+import type { Control } from '../structure-file';
+import type { ControlType } from './control-base';
+import { ControlBase } from './control-base';
+
+/**
+ * Handler for Gate controls.
+ */
+export class Gate extends ControlBase {
+    /**
+     * Loads the control and sets up state objects and event handlers.
+     *
+     * @param type The type of the control ('device' or 'channel').
+     * @param uuid The unique identifier of the control.
+     * @param control The control data from the structure file.
+     */
+    async loadAsync(type: ControlType, uuid: string, control: Control): Promise<void> {
+        await this.updateObjectAsync(uuid, {
+            type: type,
+            common: {
+                name: control.name,
+                role: 'blind',
+            },
+            native: { control },
+        });
+
+        await this.loadOtherControlStatesAsync(control.name, uuid, control.states, [
+            'position',
+            'active',
+            'preventOpen',
+            'preventClose',
+        ]);
+
+        const activeStates = {
+            '-1': 'close',
+            0: 'not moving',
+            1: 'open',
+        };
+        await this.createPercentageControlStateObjectAsync(control.name, uuid, control.states, 'position', 'level', {
+            write: true,
+            // TODO: re-add: smartIgnore: false,
+        });
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'active',
+            'number',
+            'value',
+            { write: true, states: activeStates },
+        );
+        await this.createBooleanControlStateObjectAsync(control.name, uuid, control.states, 'preventOpen', 'indicator');
+        await this.createBooleanControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'preventClose',
+            'indicator',
+        );
+
+        this.addStateChangeListener(
+            `${uuid}.active`,
+            (oldValue: OldStateValue, newValue: CurrentStateValue) => {
+                if (newValue === 1) {
+                    if (oldValue === -1) {
+                        // open twice because we are currently closing
+                        this.sendCommand(control.uuidAction, 'open');
+                    }
+                    this.sendCommand(control.uuidAction, 'open');
+                } else if (newValue === -1) {
+                    if (oldValue === 1) {
+                        // close twice because we are currently opening
+                        this.sendCommand(control.uuidAction, 'close');
+                    }
+                    this.sendCommand(control.uuidAction, 'close');
+                } else if (newValue === 0) {
+                    if (oldValue === 1) {
+                        this.sendCommand(control.uuidAction, 'close');
+                    } else if (oldValue === -1) {
+                        this.sendCommand(control.uuidAction, 'open');
+                    }
+                }
+            },
+            { notIfEqual: true, convertToInt: true },
+        );
+
+        await this.createButtonCommandStateObjectAsync(control.name, uuid, 'open');
+        this.addStateChangeListener(
+            `${uuid}.open`,
+            () => {
+                this.sendCommand(control.uuidAction, 'open');
+            },
+            { selfAck: true },
+        );
+        await this.createButtonCommandStateObjectAsync(control.name, uuid, 'close');
+        this.addStateChangeListener(
+            `${uuid}.close`,
+            () => {
+                this.sendCommand(control.uuidAction, 'close');
+            },
+            { selfAck: true },
+        );
+
+        // for Alexa support:
+        if (control.states.position) {
+            this.addStateChangeListener(
+                `${uuid}.position`,
+                (oldValue: OldStateValue, newValue: CurrentStateValue) => {
+                    if (typeof oldValue !== 'number' || typeof newValue !== 'number') {
+                        // This should never happen due to convertToInt flag
+                        this.adapter.log.error(`Gate position is not a number`);
+                        return;
+                    }
+
+                    let targetValue: number;
+                    let isOpening: boolean;
+                    if (oldValue < newValue) {
+                        targetValue = (newValue - 1) / 100;
+                        this.sendCommand(control.uuidAction, 'open');
+                        isOpening = true;
+                    } else {
+                        targetValue = (newValue + 1) / 100;
+                        this.sendCommand(control.uuidAction, 'close');
+                        isOpening = false;
+                    }
+
+                    if (newValue === 100 || newValue === 0) {
+                        return;
+                    }
+
+                    const listenerName = 'auto';
+                    this.addStateEventHandler(
+                        control.states.position,
+                        (value: any) => {
+                            if (isOpening && value >= targetValue) {
+                                this.removeStateEventHandler(control.states.position, listenerName);
+                                this.sendCommand(control.uuidAction, 'close');
+                            } else if (!isOpening && value <= targetValue) {
+                                this.removeStateEventHandler(control.states.position, listenerName);
+                                this.sendCommand(control.uuidAction, 'open');
+                            }
+                        },
+                        listenerName,
+                    );
+                },
+                { notIfEqual: true, convertToInt: true, minInt: 0, maxInt: 100, ackTimeoutMs: 2500 },
+            );
+        }
+    }
+}

package/src/controls/Hourcounter.ts

@@ -0,0 +1,115 @@
+import type { Control } from '../structure-file';
+import type { ControlType } from './control-base';
+import { ControlBase } from './control-base';
+
+/**
+ * Handler for Hourcounter controls.
+ */
+export class Hourcounter extends ControlBase {
+    /**
+     * Loads the control and sets up state objects and event handlers.
+     *
+     * @param type The type of the control ('device' or 'channel').
+     * @param uuid The unique identifier of the control.
+     * @param control The control data from the structure file.
+     */
+    async loadAsync(type: ControlType, uuid: string, control: Control): Promise<void> {
+        await this.updateObjectAsync(uuid, {
+            type: type,
+            common: {
+                name: control.name,
+                role: 'timer',
+            },
+            native: { control },
+        });
+
+        await this.loadOtherControlStatesAsync(control.name, uuid, control.states, [
+            'total',
+            'remaining',
+            'lastActivation',
+            'overdue',
+            'maintenanceInterval',
+            'stateUnit',
+            'active',
+            'overdueSince',
+        ]);
+        // stateUnit is ignored as it is not used by ioBroker (all states are always in seconds)
+
+        await this.createSimpleControlStateObjectAsync(control.name, uuid, control.states, 'total', 'number', 'value', {
+            unit: 'sec',
+        });
+
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'remaining',
+            'number',
+            'value',
+            { unit: 'sec' },
+        );
+
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'lastActivation',
+            'number',
+            'value.time',
+        );
+
+        await this.createBooleanControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'overdue',
+            'indicator.maintenance',
+        );
+
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'maintenanceInterval',
+            'number',
+            'value',
+            { unit: 'sec' },
+        );
+
+        await this.createBooleanControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'active',
+            'indicator.working',
+        );
+
+        await this.createSimpleControlStateObjectAsync(
+            control.name,
+            uuid,
+            control.states,
+            'overdueSince',
+            'number',
+            'value',
+            { unit: 'sec' },
+        );
+
+        await this.createButtonCommandStateObjectAsync(control.name, uuid, 'reset');
+        this.addStateChangeListener(
+            `${uuid}.reset`,
+            () => {
+                this.sendCommand(control.uuidAction, 'reset');
+            },
+            { selfAck: true },
+        );
+
+        await this.createButtonCommandStateObjectAsync(control.name, uuid, 'resetAll');
+        this.addStateChangeListener(
+            `${uuid}.resetAll`,
+            () => {
+                this.sendCommand(control.uuidAction, 'resetAll');
+            },
+            { selfAck: true },
+        );
+    }
+}

package/src/controls/IRCDaytimer.ts

@@ -0,0 +1,4 @@
+import { Daytimer } from './Daytimer';
+
+/** IRCDaytimer is a Daytimer with a few states less */
+export class IRCDaytimer extends Daytimer {}

package/src/controls/IRCV2Daytimer.ts

@@ -0,0 +1,4 @@
+import { Daytimer } from './Daytimer';
+
+/** IRCV2Daytimer is a Daytimer with a few states less */
+export class IRCV2Daytimer extends Daytimer {}