iobroker.iot 3.5.2 → 4.0.1

package/lib/AlexaSmartHomeV3/Alexa/Directives/ChangeReport.js

@@ -1,75 +0,0 @@
-const Utils = require('../../Helpers/Utils');
-const AlexaResponse = require('../AlexaResponse');
-const Base = require('./Base');
-
-/**
- * When the state of an endpoint changes for any reason, we report that change to Alexa in an Alexa.ChangeReport event.
- * Alexa can then provide the status change to the customer.
- * In the change report, we specify the state of any changed properties in the payload object.
- * For example, if a customer manually turns on a light, we send a change report event that indicates the powerState property
- * of the Alexa.PowerController interface has changed its value to ON.
- *
- * If the properties of an interface are reported as proactivelyReported during discovery,
- * we must send Alexa an Alexa.ChangeReport event whenever a property value changes.
- * If a state change happens because of a directive from Alexa, we send both a directive response and a change report event.
- * @class
- */
-class ChangeReport extends Base {
-    static matches(event) {
-        return event?.directive?.header?.name === Utils.className(this.toString());
-    }
-
-    static get(endpointId, propertyName, isPhysicalInteraction) {
-        return {
-            directive: {
-                header: {
-                    name: Utils.className(this.toString()),
-                    propertyName: propertyName,
-                    physicalInteraction: isPhysicalInteraction,
-                },
-                endpoint: {
-                    endpointId,
-                },
-            },
-        };
-    }
-
-    async handle(event, endpointManager) {
-        this.log.debug(`handling ChangeReport`);
-        this.log.silly(`${JSON.stringify(event)}`);
-
-        const endpointId = event.directive?.endpoint?.endpointId;
-        const propertyName = event.directive?.header?.propertyName;
-        const changeCauseType = event.directive?.header?.physicalInteraction ? 'PHYSICAL_INTERACTION' : 'VOICE_INTERACTION';
-
-        let response = new AlexaResponse({
-            namespace: 'Alexa',
-            name: 'ChangeReport',
-            endpointId,
-            changeCauseType,
-        });
-
-        response.addContext();
-
-        const endpoint = endpointManager.endpointById(endpointId);
-
-        if (endpoint) {
-            const properties = await endpoint.reportState();
-            for (const property of properties) {
-                if (propertyName === property.name) {
-                    response.addPayloadChangeProperty(property);
-                } else {
-                    response.addContextProperty(property);
-                }
-            }
-        } else {
-            response = AlexaResponse.nonExistingEndpoint(endpointId);
-        }
-
-        this.log.debug(`${JSON.stringify(response.get())}`);
-
-        return response.get();
-    }
-}
-
-module.exports = ChangeReport;

package/lib/AlexaSmartHomeV3/Alexa/Directives/Discovery.js

@@ -1,39 +0,0 @@
-const AlexaResponse = require('../AlexaResponse');
-const Base = require('./Base');
-
-class Discovery extends Base {
-    async handle(event, endpointManager) {
-        this.log.debug(`handling Discovery`);
-        this.log.silly(`${JSON.stringify(event)}`);
-
-        const endpoints = endpointManager.endpoints;
-
-        const response = new AlexaResponse({
-            namespace: Discovery.namespace,
-            name: 'Discover.Response',
-        });
-
-        let count = 0;
-
-        endpoints.forEach(endpoint => {
-            count++;
-            if (count > 300) {
-                this.log.warn(`Too many devices. Alexa supports up to 300 devices. ${endpoint.friendlyName} will not be discovered.`);
-                return;
-            }
-            response.addPayloadEndpoint({
-                endpointId: endpoint.id,
-                description: endpoint.description,
-                friendlyName: endpoint.friendlyName,
-                displayCategories: endpoint.displayCategories,
-                capabilities: endpoint.capabilities.map(capability => response.asEndpointCapability(capability.alexaResponse)),
-            });
-        });
-
-        this.log.silly(`${JSON.stringify(response.get())}`);
-
-        return response.get();
-    }
-}
-
-module.exports = Discovery;

package/lib/AlexaSmartHomeV3/Alexa/Directives/ReportState.js

@@ -1,50 +0,0 @@
-const Utils = require('../../Helpers/Utils');
-const AlexaResponse = require('../AlexaResponse');
-const Base = require('./Base');
-
-/**
- * When Alexa sends an Alexa.ReportState directive to request the state of an endpoint, the skill sends an Alexa.StateReport response.
- * This response contains the current state of all the properties that are retrievable.
- * The following information in the Alexa.StateReport response:
- * - the state of all the retrievable properties in the context object
- * - endpoint for the report is identified in the endpoint object
- * - the payload is set to an empty object
- * - correlationToken set to the value from the Alexa.ReportState request
- * @class
- */
-class ReportState extends Base {
-    static matches(event) {
-        return event?.directive?.header?.name === Utils.className(this.toString());
-    }
-
-    async handle(event, endpointManager) {
-
-        this.log.debug(`handling ReportState`);
-        this.log.silly(`${JSON.stringify(event)}`);
-
-        const endpointId = event.directive?.endpoint?.endpointId;
-
-        let response = new AlexaResponse({
-            namespace: 'Alexa',
-            name: 'StateReport',
-            correlationToken: event.directive?.header?.correlationToken,
-            token: event.directive?.endpoint?.scope?.token,
-            endpointId,
-        });
-
-        const endpoint = endpointManager.endpointById(endpointId);
-
-        if (endpoint) {
-            const properties = await endpoint.reportState();
-            properties.forEach(property => response.addContextProperty(property));
-        } else {
-            response = AlexaResponse.nonExistingEndpoint(endpointId);
-        }
-
-        this.log.silly(`${JSON.stringify(response.get())}`);
-
-        return response.get();
-    }
-}
-
-module.exports = ReportState;

package/lib/AlexaSmartHomeV3/Alexa/Directives/index.js

@@ -1,13 +0,0 @@
-const directives = {};
-const directivesPath = require('path').join(__dirname);
-
-require('fs')
-    .readdirSync(directivesPath)
-    .forEach((file) => {
-        const name = file.replace(/\.js$/, '');
-        if (name !== 'index' && name !== 'Base') {
-            directives[name] = require(`./${file}`);
-        }
-    });
-
-module.exports = directives;

package/lib/AlexaSmartHomeV3/Alexa/ModeValues/Base.js

@@ -1,38 +0,0 @@
-const Utils = require("../../Helpers/Utils");
-
-class Base {
-    constructor(mode) {
-        this._mode = mode;
-    }
-
-    static get value() {
-        return Utils.className(this.toString());
-    }
-
-    get value() {
-        return `${this._mode}.${this.constructor.name}`
-    }
-
-    get friendlyNames() {
-        return []
-    }
-
-    get discoveryResponse() {
-        return {
-            value: this.value,
-            modeResources: {
-                friendlyNames: this.friendlyNames
-            }
-        }
-    }
-
-    get actionMappings() {
-        return []
-    }
-
-    get stateMappings() {
-        return []
-    }
-}
-
-module.exports = Base;

package/lib/AlexaSmartHomeV3/Alexa/ModeValues/Closed.js

@@ -1,55 +0,0 @@
-const Base = require("./Base");
-
-class Closed extends Base {
-    get friendlyNames() {
-        return [
-            {
-                '@type': 'asset',
-                'value': {
-                    assetId: 'Alexa.Value.Close'
-                }
-            },
-            {
-                '@type': 'text',
-                value: {
-                    text: 'Closed',
-                    locale: 'en-US'
-                }
-            },
-            {
-                '@type': 'text',
-                value: {
-                    text: 'Geschloßen',
-                    locale: 'de-DE'
-                }
-            }
-        ]
-    }
-
-    get actionMappings() {
-        return [
-            {
-                '@type': 'ActionsToDirective',
-                actions: ['Alexa.Actions.Close'],
-                directive: {
-                    name: 'SetMode',
-                    payload: {
-                        mode: this.value
-                    }
-                }
-            }
-        ]
-    }
-
-    get stateMappings() {
-        return [
-            {
-                '@type': 'StatesToValue',
-                states: ['Alexa.States.Closed'],
-                value: this.value
-            }
-        ]
-    }
-}
-
-module.exports = Closed;

package/lib/AlexaSmartHomeV3/Alexa/ModeValues/Open.js

@@ -1,56 +0,0 @@
-const Base = require("./Base");
-
-class Open extends Base {
-    get friendlyNames() {
-        return [
-            {
-                '@type': 'asset',
-                value: {
-                    assetId: 'Alexa.Value.Open'
-                }
-            },
-            {
-                '@type': 'text',
-                value: {
-                    text: 'Open',
-                    locale: 'en-US'
-                }
-            },
-            {
-                '@type': 'text',
-                value: {
-                    text: 'Geöffnet',
-                    locale: 'de-DE'
-                }
-            }
-
-        ]
-    }
-
-    get actionMappings() {
-        return [
-            {
-                '@type': 'ActionsToDirective',
-                actions: ['Alexa.Actions.Open'],
-                directive: {
-                    name: 'SetMode',
-                    payload: {
-                        mode: this.value
-                    }
-                }
-            }
-        ]
-    }
-
-    get stateMappings() {
-        return [
-            {
-                '@type': 'StatesToValue',
-                states: ['Alexa.States.Open'],
-                value: this.value
-            }
-        ]
-    }
-}
-
-module.exports = Open;

package/lib/AlexaSmartHomeV3/Alexa/ModeValues/index.js

@@ -1,14 +0,0 @@
-const modes = {};
-const modesPath = require('path').join(__dirname);
-const excludedNames = ['index', 'Base'];
-
-require('fs')
-    .readdirSync(modesPath)
-    .forEach((file) => {
-        const name = file.replace(/\.js$/, '');
-        if (!excludedNames.includes(name)) {
-            modes[name] = require(`./${file}`);
-        }
-    });
-
-module.exports = modes;

package/lib/AlexaSmartHomeV3/Alexa/Properties/AdjustableProperty.js

@@ -1,11 +0,0 @@
-const Utils = require('../../Helpers/Utils');
-const Base = require('./Base');
-
-class AdjustableProperty extends Base {
-
-    static directive(event) {
-        return event.directive.header.name === 'Adjust' + Utils.className(this.toString()) ? AdjustableProperty.ADJUST : AdjustableProperty.SET;
-    }
-}
-
-module.exports = AdjustableProperty;

package/lib/AlexaSmartHomeV3/Alexa/Properties/Base.js

@@ -1,108 +0,0 @@
-const Utils = require('../../Helpers/Utils');
-
-class Base {
-
-    /**
-     * @param {Object} opts - The object to initialize the corresponding ioBroker state.
-     * @param {Object} opts.setState - The iobroker state to write values to.
-     * @param {Object} [opts.getState] - The iobroker state to read values from.
-     * @param {function} [opts.alexaSetter] - The function to apply to an Alexa value to transform it to the iobroker's one
-     * @param {function} [opts.alexaGetter] - The function to apply to an iobroker value to transform it to the Alexa's one
-     */
-    init(opts) {
-        this._setState = opts.setState;
-        this._setId = opts.setState.id;
-        this._getId = opts.getState?.id || this._setId;
-        this._valuesRange = Utils.configuredRangeOrDefault(this._setState);
-
-        if (opts.alexaSetter) {
-            this._alexaSetter = opts.alexaSetter;
-        }
-        if (opts.alexaGetter) {
-            this._alexaGetter = opts.alexaGetter;
-        }
-    }
-
-    get propertyName() {
-        return Utils.firstLower(`${this.constructor.name}`);
-    }
-
-    static get propertyName() {
-        return Utils.firstLower(Utils.className(this.toString()));
-    }
-
-    get valuesRangeMin() {
-        return this._valuesRange.min
-    }
-
-    get valuesRangeMax() {
-        return this._valuesRange.max;
-    }
-
-    get setId() {
-        return this._setId;
-    }
-
-    get getId() {
-        return this._getId;
-    }
-    /**
-     * returns last known iobroker value
-     */
-    get currentValue() {
-        return this._currentValue;
-    }
-
-    set currentValue(value) {
-        this._currentValue = value;
-    }
-
-    /**
-    * @param {any} alexaValue
-    */
-    value(alexaValue) {
-        return this._alexaSetter ? this._alexaSetter(alexaValue) : alexaValue;
-    }
-
-    /**
-     * @param {any} value
-     */
-    alexaValue(value) {
-        return this._alexaGetter ? this._alexaGetter(value) : value;
-    }
-
-    /**
-     * Checks whether a directive refers to the property
-     * @param event Contains the Alexa event.
-     * @returns {boolean}
-     */
-    static matches(event) {
-        return event?.directive?.header?.namespace === `Alexa.${Utils.className(this.toString())}Controller`;
-        // return event?.directive?.header?.name === this.propertyName;
-    }
-
-    matches(event) {
-        return event?.directive?.header?.name === this.propertyName;
-    }
-
-    /**
-     * Extracts value to be set on the smart device sent in an Alexa directive
-     * @returns {object}
-     */
-    alexaDirectiveValue(event) {
-        return event.directive.payload[this.propertyName];
-    }
-
-    reportValue(value) {
-        return value;
-    }
-
-    static get ADJUST() { return 'ADJUST'; }
-
-    static get SET() { return 'SET'; }
-
-    static get CELSIUS_SCALE() { return 'CELSIUS'; }
-
-}
-
-module.exports = Base;

package/lib/AlexaSmartHomeV3/Alexa/Properties/Brightness.js

@@ -1,14 +0,0 @@
-const AdjustableProperty = require('./AdjustableProperty');
-
-class Brightness extends AdjustableProperty {
-
-    matches(event) {
-        return Brightness.matches(event);
-    }
-
-    alexaDirectiveValue(event) {
-        return Brightness.directive(event) === Brightness.SET ? super.alexaDirectiveValue(event) : event.directive.payload['brightnessDelta'];
-    }
-}
-
-module.exports = Brightness;

package/lib/AlexaSmartHomeV3/Alexa/Properties/Color.js

@@ -1,40 +0,0 @@
-const Base = require('./Base');
-
-class Color extends Base {
-
-    constructor() {
-        super();
-        this.hal = {
-            hue: 0,
-            saturation: 0,
-            brightness: 0,
-        };
-    }
-
-    init(opts) {
-        this.hal = opts.hal;
-        this._setId = opts.hal.hue;
-        this._getId = opts.hal.hue;
-
-        if (opts.alexaSetter) {
-            this._alexaSetter = opts.alexaSetter;
-        }
-        if (opts.alexaGetter) {
-            this._alexaGetter = opts.alexaGetter;
-        }
-    }
-
-    matches(event) {
-        return Color.matches(event) && event?.directive?.header?.name === 'SetColor';
-    }
-
-    set hal(value) {
-        this._hal = value;
-    }
-
-    get hal() {
-        return this._hal;
-    }
-}
-
-module.exports = Color;

package/lib/AlexaSmartHomeV3/Alexa/Properties/ColorTemperatureInKelvin.js

@@ -1,62 +0,0 @@
-const AdjustableProperty = require('./AdjustableProperty');
-
-class ColorTemperatureInKelvin extends AdjustableProperty {
-
-    constructor() {
-        super();
-        this._colorTemperatureTable = [2200, 2700, 4000, 5500, 7000];
-    }
-
-    static matches(event) {
-        return event?.directive?.header?.namespace === 'Alexa.ColorTemperatureController';
-    }
-
-    static directive(event) {
-        return [
-            ColorTemperatureInKelvin.INCREASE_COLOR_TEMPERATURE,
-            ColorTemperatureInKelvin.DECREASE_COLOR_TEMPERATURE]
-            .includes(event?.directive?.header?.name) ? AdjustableProperty.ADJUST : AdjustableProperty.SET;
-    }
-
-    matches(event) {
-        return ColorTemperatureInKelvin.matches(event)
-            && [
-                ColorTemperatureInKelvin.SET_COLOR_TEMPERATURE,
-                ColorTemperatureInKelvin.INCREASE_COLOR_TEMPERATURE,
-                ColorTemperatureInKelvin.DECREASE_COLOR_TEMPERATURE
-            ].includes(event?.directive?.header?.name);
-    }
-
-    get colorTemperatureTable() {
-        return this._colorTemperatureTable;
-    }
-
-    alexaDirectiveValue(event) {
-        if (ColorTemperatureInKelvin.SET_COLOR_TEMPERATURE === event?.directive?.header?.name) {
-            return event.directive.payload[this.propertyName];
-        }
-
-        if (ColorTemperatureInKelvin.INCREASE_COLOR_TEMPERATURE === event?.directive?.header?.name) {
-            return 1;
-        }
-
-        if (ColorTemperatureInKelvin.DECREASE_COLOR_TEMPERATURE === event?.directive?.header?.name) {
-            return -1;
-        }
-    }
-
-    static get SET_COLOR_TEMPERATURE() {
-        return 'SetColorTemperature';
-    }
-
-    static get INCREASE_COLOR_TEMPERATURE() {
-        return 'IncreaseColorTemperature';
-    }
-
-    static get DECREASE_COLOR_TEMPERATURE() {
-        return 'DecreaseColorTemperature';
-    }
-
-}
-
-module.exports = ColorTemperatureInKelvin;

package/lib/AlexaSmartHomeV3/Alexa/Properties/DetectionState.js

@@ -1,22 +0,0 @@
-const Base = require('./Base');
-
-class DetectionState extends Base {
-    static matches(event) {
-        return event?.directive?.header?.namespace === 'Alexa.MotionSensor' ||
-            event?.directive?.header?.namespace === 'Alexa.ContactSensor';
-    }
-
-    matches(event) {
-        return DetectionState.matches(event);
-    }
-
-    static get DETECTED() {
-        return 'DETECTED';
-    }
-
-    static get NOT_DETECTED() {
-        return 'NOT_DETECTED';
-    }
-}
-
-module.exports = DetectionState;

package/lib/AlexaSmartHomeV3/Alexa/Properties/LockState.js

@@ -1,40 +0,0 @@
-const Base = require('./Base');
-
-class LockState extends Base {
-    static matches(event) {
-        return event?.directive?.header?.namespace === 'Alexa.LockController';
-    }
-
-    matches(event) {
-        return LockState.matches(event);
-    }
-
-    alexaDirectiveValue(event) {
-        return event.directive.header.name;
-    }
-
-    static get LOCK() {
-        return 'Lock';
-    }
-
-    static get LOCKED() {
-        return 'LOCKED';
-    }
-
-    static get UNLOCK() {
-        return 'Unlock';
-    }
-
-    static get UNLOCKED() {
-        return 'UNLOCKED';
-    }
-
-    /**
-     * The lock can't transition to `locked` or `unlocked` because the locking mechanism is jammed.
-     */
-    static get JAMMED() {
-        return 'JAMMED';
-    }
-}
-
-module.exports = LockState;

package/lib/AlexaSmartHomeV3/Alexa/Properties/Mode.js

@@ -1,32 +0,0 @@
-const Base = require('./Base');
-
-class Mode extends Base {
-
-    init(opts) {
-        super.init(opts);
-        this._supportedModes = opts.supportedModes;
-        this._instance = opts.instance;
-    }
-
-    matches(event) {
-        return Mode.matches(event)
-            // non-adjustable mode controller
-            && 'SetMode' === event?.directive?.header?.name
-            && this.instance === event?.directive?.header?.instance
-            && this.supportedModes.map(mode => mode.value).includes(event?.directive?.payload?.mode);
-    }
-
-    alexaDirectiveValue(event) {
-        return event.directive.payload.mode;
-    }
-
-    get supportedModes() {
-        return this._supportedModes;
-    }
-
-    get instance() {
-        return this._instance;
-    }
-}
-
-module.exports = Mode;