iobroker.iot 3.6.0 → 4.0.2

package/lib/AlexaSmartHomeV3/Controls/Dimmer.js

@@ -1,124 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const AdjustableControl = require('./AdjustableControl');
-const Utils = require('../Helpers/Utils');
-const Properties = require('../Alexa/Properties');
-const AdapterProvider = require('../Helpers/AdapterProvider');
-
-/**
- * @class
- */
-class Dimmer extends AdjustableControl {
-    get categories() {
-        return ['LIGHT'];
-    }
-
-    adjustableProperties() {
-        return [Properties.Brightness];
-    }
-
-    initCapabilities() {
-        this._powerControllerCapability = new Capabilities.PowerController();
-        this._powerState = this._powerControllerCapability.powerState;
-
-        this._brightnessCapability = new Capabilities.BrightnessController();
-        this._brightness = this._brightnessCapability.brightness;
-
-        let result = [this._powerControllerCapability, this._brightnessCapability];
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.composeInitObject(property))
-        }
-
-        return result;
-    }
-
-    async setState(property, value) {
-        // set the property itself
-        await AdapterProvider.setState(property.setId, value);
-        property.currentValue = value;
-        const valuesRange = Utils.configuredRangeOrDefault(this.states[this.statesMap.set]);
-
-        // todo: use adapter.config.deviceOffLevel
-        // If
-
-        if (property.propertyName === Properties.PowerState.propertyName) {
-            // set brightness
-            if (value) {
-                // set byOn to the configured value or 100 otherwise
-                let byOn = this.states[this.statesMap.set].smartName?.byON;
-                byOn = isNaN(byOn) ? valuesRange.max : parseInt(byOn);
-                await AdapterProvider.setState(this._brightness.setId, byOn);
-                this._brightness.currentValue = byOn;
-            } else { // set brightness to 0 on power OFF
-                await AdapterProvider.setState(this._brightness.setId, valuesRange.min);
-                this._brightness.currentValue = valuesRange.min;
-            }
-        } else {
-            // set power
-            const powerValue = value !== valuesRange.min;
-
-            // only do this on different IDs for brightness and power
-            if (this._brightness.setId !== this._powerState.setId) {
-                await AdapterProvider.setState(this._powerState.setId, powerValue);
-            }
-            this._powerState.currentValue = powerValue;
-        }
-    }
-
-    async getOrRetrieveCurrentValue(property) {
-        if (property.currentValue === undefined) {
-            property.currentValue = await AdapterProvider.getState(property.getId);
-
-            const valuesRange = Utils.configuredRangeOrDefault(this.states[this.statesMap.set]);
-            // convert non-zero brightness to power = true
-            if (property.propertyName === this._powerState.propertyName && property.getId === this._brightness.getId) {
-                property.currentValue = property.currentValue !== valuesRange.min;
-            }
-        }
-
-        if (property.currentValue === undefined) {
-            throw new Error(`unable to retrieve ${property.getId}`);
-        }
-
-        return property.currentValue;
-    }
-
-    composeInitObject(property) {
-        /*
-            Device of type 'dimmer' can be switched 'ON'/'OFF' and its brightness can be set to a value between 0 and 100.
-
-            If there is no 'ON_SET' state available:
-            - switching control 'OFF' is done via setting its brightness to 0
-            - switching control 'ON' is done via setting its brightness to the configured 'byOn' value or to the last known brightness.
-        */
-
-        const map = this.statesMap;
-
-        if (property.propertyName === Properties.PowerState.propertyName) {
-            return {
-                setState: this.states[map.on_set] || this.states[map.set],
-                getState: this.states[map.on_actual] || this.states[map.on_set] || this.states[map.set],
-                alexaSetter: function (alexaValue) {
-                    return alexaValue === Properties.PowerState.ON;
-                },
-                alexaGetter: function (value) {
-                    return value ? Properties.PowerState.ON : Properties.PowerState.OFF;
-                },
-            }
-        }
-
-        if (property.propertyName === Properties.Brightness.propertyName) {
-            return {
-                setState: this.states[map.set],
-                getState: this.states[map.actual],
-                alexaSetter: function (alexaValue) {
-                    return Utils.denormalize_0_100(alexaValue, this.valuesRangeMin, this.valuesRangeMax);
-                },
-                alexaGetter: function (value) {
-                    return Utils.normalize_0_100(value, this.valuesRangeMin, this.valuesRangeMax);
-                },
-            };
-        }
-    }
-}
-
-module.exports = Dimmer;

package/lib/AlexaSmartHomeV3/Controls/Door.js

@@ -1,9 +0,0 @@
-const ContactSensor = require('./ContactSensor');
-
-/**
- * @class
- */
-class Door extends ContactSensor {
-}
-
-module.exports = Door;

package/lib/AlexaSmartHomeV3/Controls/Gate.js

@@ -1,42 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const Modes = require('../Alexa/ModeValues');
-const Control = require('./Control');
-
-/**
- * @class
- */
-class Gate extends Control {
-    get categories() {
-        return ['GARAGE_DOOR'];
-    }
-
-    initCapabilities() {
-        let result = [new Capabilities.ModeController()];
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.modeInitObject());
-        }
-        return result;
-    }
-
-    modeInitObject() {
-        const map = this.statesMap;
-        const mode = 'Gate.Position';
-        return {
-            setState: this.states[map.set],
-            getState: this.states[map.set],
-            alexaSetter: function (alexaValue) {
-                return alexaValue === `${mode}.${Modes.Open.value}`;
-            },
-            alexaGetter: function (value) {
-                return value ? `${mode}.${Modes.Open.value}` : `${mode}.${Modes.Closed.value}`;
-            },
-            instance: mode,
-            supportedModes: [
-                new Modes.Open(mode),
-                new Modes.Closed(mode)
-            ]
-        }
-    }
-}
-
-module.exports = Gate;

package/lib/AlexaSmartHomeV3/Controls/Hue.js

@@ -1,207 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const Utils = require('../Helpers/Utils');
-const Properties = require('../Alexa/Properties');
-const AdapterProvider = require('../Helpers/AdapterProvider');
-const AdjustableControl = require('./AdjustableControl');
-
-/**
- * @class
- */
-class Hue extends AdjustableControl {
-    get categories() {
-        return ['LIGHT'];
-    }
-
-    adjustableProperties() {
-        return [Properties.ColorTemperatureInKelvin];
-    }
-
-    initCapabilities() {
-        const map = this.statesMap;
-        const result = [new Capabilities.ColorController()];
-
-        // if the state DIMMER or BRIGHTNESS configured
-        if (this.states[map.dimmer] || this.states[map.brightness]) {
-            this._brightnessCapability = new Capabilities.BrightnessController();
-            this._brightness = this._brightnessCapability.brightness;
-            result.push(this._brightnessCapability);
-        }
-
-        // if the state TEMPERATURE configured
-        if (this.states[map.temperature]) {
-            this._colorTemperatureCapability = new Capabilities.ColorTemperatureController();
-            result.push(this._colorTemperatureCapability);
-        }
-
-        // if the state ON, DIMMER or BRIGHTNESS configured
-        if (this.states[map.on] || this._brightness) {
-            this._powerControllerCapability = new Capabilities.PowerController();
-            this._powerState = this._powerControllerCapability.powerState;
-            result.push(this._powerControllerCapability);
-        }
-
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.composeInitObject(property))
-        }
-
-        return result;
-    }
-
-    async getOrRetrieveCurrentValue(property) {
-        const map = this.statesMap;
-
-        if (property.currentValue === undefined) {
-            property.currentValue = await AdapterProvider.getState(property.getId);
-            // convert the non-zero brightness to power = true
-            if (property.propertyName === Properties.PowerState.propertyName && !this.states[map.on]) {
-                property.currentValue = property.currentValue !== 0;
-            }
-
-            if (property.propertyName === Properties.Color.propertyName) {
-                property.currentValue = {
-                    hue: property.currentValue,
-                    saturation: property.hal.saturation,
-                    brightness: property.hal.brightness
-                };
-            }
-        }
-
-        if (property.currentValue === undefined) {
-            throw new Error(`unable to retrieve ${property.getId}`);
-        }
-
-        return property.currentValue;
-    }
-
-    async setState(property, value) {
-        const map = this.statesMap;
-
-        if (property.propertyName === Properties.PowerState.propertyName) {
-            if (this.states[map.on]) {
-                await AdapterProvider.setState(property.setId, value);
-                property.currentValue = value;
-            } else {
-                if (value) { // set brightness
-                    // set byOn to the configured value or range.max otherwise
-                    const range = Utils.configuredRangeOrDefault(this.states[map.dimmer] || this.states[map.brightness]);
-                    let byOn = (this.states[map.dimmer] || this.states[map.brightness])?.smartName?.byON;
-                    byOn = isNaN(byOn) ? range.max : parseInt(byOn);
-                    await AdapterProvider.setState(this._brightness.setId, byOn);
-                    this._brightness.currentValue = byOn;
-                    this._powerState.currentValue = true;
-                } else { // set brightness to 0 on power OFF
-                    await AdapterProvider.setState(this._brightness.setId, 0);
-                    this._brightness.currentValue = 0;
-                    this._powerState.currentValue = false;
-                }
-            }
-        } else
-        if (property.propertyName === Properties.Brightness.propertyName
-            || property.propertyName === Properties.ColorTemperatureInKelvin.propertyName) {
-            await AdapterProvider.setState(property.setId, value);
-            property.currentValue = value;
-        } else
-        if (property.propertyName === Properties.Color.propertyName) {
-            await AdapterProvider.setState(property.hal.hue, value.hue);
-            if (property.hal.saturation) {
-                await AdapterProvider.setState(property.hal.saturation, value.saturation);
-            }
-            
-            // do not set brightness
-            
-            // https://developer.amazon.com/en-US/docs/alexa/device-apis/alexa-colorcontroller.html
-            // Important: For the best user experience, when you make a color change, maintain the current brightness setting of the endpoint. 
-            // For example, if a light bulb is currently set to white at 0.5 brightness, and a user requests a color change to red, 
-            // the SetColor directive specifies hue = 0, saturation = 1, and brightness = 1. Here, set the hue to 0, the saturation to 1, 
-            // and ignore the brightness value of 1 in the directive. Instead, maintain the current brightness value of 0.5.
-            
-            property.currentValue = value;
-        } else
-        if (property.propertyName === Properties.ColorTemperatureInKelvin.propertyName) {
-            // TODO: Check with gh_got
-            await AdapterProvider.setState(property.setId, value.colorTemperatureInKelvin);
-            property.currentValue = value;
-        }
-    }
-
-    async adjustValue(event, property) {
-        // extract Alexa delta value from event
-        const delta = property.alexaDirectiveValue(event);
-        
-        // convert delta to iobroker value
-        const value = property.value(delta);
-
-        // set iobroker state
-        await this.setState(property, value);
-
-        return value;
-    }
-
-    composeInitObject(property) {
-        const map = this.statesMap;
-
-        if (property.propertyName === Properties.PowerState.propertyName) {
-            return {
-                setState: this.states[map.on] || this.states[map.dimmer] || this.states[map.brightness],
-                getState: this.states[map.on] || this.states[map.dimmer] || this.states[map.brightness],
-                alexaSetter: function (alexaValue) {
-                    return alexaValue === Properties.PowerState.ON;
-                },
-                alexaGetter: function (value) {
-                    return value ? Properties.PowerState.ON : Properties.PowerState.OFF;
-                },
-            };
-        }
-
-        if (property.propertyName === Properties.Brightness.propertyName) {
-            return {
-                setState: this.states[map.dimmer] || this.states[map.brightness],
-                getState: this.states[map.dimmer] || this.states[map.brightness],
-                alexaSetter: function (alexaValue) {
-                    return Utils.denormalize_0_100(alexaValue, this.valuesRangeMin, this.valuesRangeMax);
-                },
-                alexaGetter: function (value) {
-                    return Utils.normalize_0_100(value, this.valuesRangeMin, this.valuesRangeMax);
-                },
-            };
-        }
-
-        if (property.propertyName === Properties.Color.propertyName) {
-            return {
-                hal: {
-                    hue: this.states[map.hue].id,
-                    saturation: this.states[map.saturation]?.id,
-                    brightness: (this.states[map.dimmer] || this.states[map.brightness])?.id
-                },
-            };
-        }
-
-        if (property.propertyName === Properties.ColorTemperatureInKelvin.propertyName) {
-            return {
-                setState: this.states[map.temperature],
-                getState: this.states[map.temperature],
-                alexaSetter: function (alexaValue) {
-                    if (alexaValue === 1) { // increase directive
-                        const closest = Utils.closestFromList(this.currentValue || this.colorTemperatureTable[0], this.colorTemperatureTable);
-                        let index = this.colorTemperatureTable.indexOf(closest) + 1;
-                        index = index >= this.colorTemperatureTable.length ? this.colorTemperatureTable.length - 1 : index;
-                        return this.colorTemperatureTable[index];
-                    }
-                    if (alexaValue === -1) { // decrease directive
-                        const closest = Utils.closestFromList(this.currentValue || this.colorTemperatureTable[0], this.colorTemperatureTable);
-                        let index = this.colorTemperatureTable.indexOf(closest) - 1;
-                        index = index < 0 ? 0 : index;
-                        return this.colorTemperatureTable[index];
-                    }
-                    
-                    return alexaValue;
-                },
-                alexaGetter: function (value) {
-                    return value;
-                },
-            };
-        }
-    }
-}
-
-module.exports = Hue;

package/lib/AlexaSmartHomeV3/Controls/Lock.js

@@ -1,36 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const Properties = require('../Alexa/Properties');
-const Control = require('./Control');
-
-/**
- * @class
- */
-class Lock extends Control {
-    get categories() {
-        return ['SMARTLOCK'];
-    }
-
-    initCapabilities() {
-        let result = [new Capabilities.LockController()];
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.lockStateInitObject());
-        }
-        return result;
-    }
-
-    lockStateInitObject() {
-        const map = this.statesMap;
-        return {
-            setState: this.states[map.set],
-            getState: this.states[map.actual],
-            alexaSetter: function (alexaValue) {
-                return alexaValue === Properties.LockState.UNLOCK;
-            },
-            alexaGetter: function (value) {
-                return value ? Properties.LockState.UNLOCKED : Properties.LockState.LOCKED;
-            },
-        };
-    }
-}
-
-module.exports = Lock;

package/lib/AlexaSmartHomeV3/Controls/Motion.js

@@ -1,17 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const ReadOnlyDetector = require('./ReadOnlyDetector');
-
-/**
- * @class
- */
-class Motion extends ReadOnlyDetector {
-    get capability() {
-        return new Capabilities.MotionSensor();
-    }
-
-    get categories() {
-        return ['MOTION_SENSOR'];
-    }
-}
-
-module.exports = Motion;

package/lib/AlexaSmartHomeV3/Controls/ReadOnlyDetector.js

@@ -1,25 +0,0 @@
-const AlexaResponse = require('../Alexa/AlexaResponse');
-const Control = require('./Control');
-
-/**
- * @class
- */
-class ReadOnlyDetector extends Control {
-    get capability() {
-        return undefined;
-    }
-
-    initCapabilities() {
-        let result = [this.capability];
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.detectedStateInitObject())
-        }
-        return result;
-    }
-    async handle(event) {
-        this.log.error(`Setting value is not supported by ${this.name} control`);
-        return Promise.reject(AlexaResponse.directiveNotSupportedByControl(this.name, event?.directive?.header?.namespace, event?.directive?.header?.payloadVersion).get());
-    }
-}
-
-module.exports = ReadOnlyDetector;

package/lib/AlexaSmartHomeV3/Controls/Slider.js

@@ -1,10 +0,0 @@
-const AdjustablePercentageControl = require('./AdjustablePercentageControl');
-
-/**
- * @class
- */
-class Slider extends AdjustablePercentageControl {
-
-}
-
-module.exports = Slider;

package/lib/AlexaSmartHomeV3/Controls/Socket.js

@@ -1,21 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const Control = require('./Control');
-
-/**
- * @class
- */
-class Socket extends Control {
-    get categories() {
-        return ['SMARTPLUG'];
-    }
-
-    initCapabilities() {
-        let result = [new Capabilities.PowerController()];
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.powerStateInitObject());
-        }
-        return result;
-    }
-}
-
-module.exports = Socket;

package/lib/AlexaSmartHomeV3/Controls/Temperature.js

@@ -1,22 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const Control = require('./Control');
-
-/**
- * @class
- */
-class Temperature extends Control {
-    get categories() {
-        return ['TEMPERATURE_SENSOR'];
-    }
-
-    initCapabilities() {
-        let result = [new Capabilities.TemperatureSensor()];
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.blankInitObject())
-        }
-
-        return result;
-    }
-}
-
-module.exports = Temperature;

package/lib/AlexaSmartHomeV3/Controls/Thermostat.js

@@ -1,86 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const AdjustableControl = require('./AdjustableControl');
-const Utils = require('../Helpers/Utils');
-const Properties = require('../Alexa/Properties');
-
-/**
- * @class
- */
-class Thermostat extends AdjustableControl {
-    get categories() {
-        return ['THERMOSTAT', 'TEMPERATURE_SENSOR']
-    }
-
-    adjustableProperties() {
-        return [Properties.TargetSetpoint];
-    }
-
-    initCapabilities() {
-        let result = [new Capabilities.TemperatureSensor(), new Capabilities.ThermostatController()];
-        const map = this.statesMap;
-        // if the state POWER is present, then we can switch it ON/OFF
-        if (this.states[map.power]) {
-            result.push(new Capabilities.PowerController());
-        }
-
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.composeInitObject(property));
-        }
-
-        return result;
-    }
-
-    composeInitObject(property) {
-        const map = this.statesMap;
-
-        if (property.propertyName === Properties.PowerState.propertyName) {
-            return {
-                setState: this.states[map.power] || this.states[map.set],
-                getState: this.states[map.power] || this.states[map.set],
-                alexaSetter: function (alexaValue) {
-                    return alexaValue === Properties.PowerState.ON;
-                },
-                alexaGetter: function (value) {
-                    return value ? Properties.PowerState.ON : Properties.PowerState.OFF;
-                },
-            };
-        }
-
-        if (property.propertyName === Properties.Temperature.propertyName) {
-            return {
-                setState: this.states[map.set],
-                getState: this.states[map.actual] || this.states[map.set],
-            };
-        }
-
-        if (property.propertyName === Properties.TargetSetpoint.propertyName) {
-            return {
-                setState: this.states[map.set],
-                getState: this.states[map.actual] || this.states[map.set],
-                alexaSetter: function (alexaValue) {
-                    return Utils.ensureValueInRange(alexaValue, this.valuesRangeMin, this.valuesRangeMax);
-                },
-                alexaGetter: function (value) {
-                    return value;
-                },
-            };
-        }
-
-        if (property.propertyName === Properties.ThermostatMode.propertyName) {
-            const initObject = {
-                setState: this.states[map.mode] || { id: undefined },
-                getState: this.states[map.mode] || { id: undefined },
-                alexaSetter: function (alexaValue) {
-                    return 0;
-                },
-                alexaGetter: function (value) {
-                    return Properties.ThermostatMode.AUTO;
-                },
-                supportedModes: [Properties.ThermostatMode.AUTO]
-            };
-            return initObject;
-        }
-    }
-}
-
-module.exports = Thermostat;

package/lib/AlexaSmartHomeV3/Controls/VacuumCleaner.js

@@ -1,28 +0,0 @@
-const Capabilities = require('../Alexa/Capabilities');
-const Control = require('./Control');
-
-/**
- * @class
- */
-class VacuumCleaner extends Control {
-    get categories() {
-        return ['VACUUM_CLEANER'];
-    }
-
-    initCapabilities() {
-        let result = [new Capabilities.PowerController()];
-        for (const property of result.flatMap(item => item.properties)) {
-            property.init(this.powerStateInitObject());
-        }
-        return result;
-    }
-
-    get statesMap() {
-        return {
-            'set': 'POWER',
-            'actual': undefined
-        };
-    }
-}
-
-module.exports = VacuumCleaner;