iobroker.iot 3.5.2 → 4.0.1

package/lib/AlexaSmartHomeV3/Alexa/AlexaResponse.js

@@ -1,262 +0,0 @@
-'use strict';
-
-const { v4: uuidv4 } = require('uuid');
-const Utils = require('../Helpers/Utils');
-
-
-/**
- * Helper class to generate an AlexaResponse.
- * @class
- */
-class AlexaResponse {
-    static ErrorResponseName = 'ErrorResponse';
-
-    static isErrorResponse(response) {
-        return response?.event?.header?.name === AlexaResponse.ErrorResponseName;
-    }
-
-    static errorResponse(payload) {
-        return new AlexaResponse({
-            name: AlexaResponse.ErrorResponseName,
-            payload,
-        });
-    }
-
-    static endpointUnreachable() {
-        return AlexaResponse.errorResponse({
-            type: 'ENDPOINT_UNREACHABLE',
-            message: 'Unable to reach endpoint.',
-        });
-    }
-
-    static directiveNotSupportedByControl(controlName, namespace, payloadVersion) {
-        return AlexaResponse.errorResponse({
-            type: 'INTERNAL_ERROR',
-            message: `Control ${controlName} doesn't support the ${namespace} with payloadVersion ${payloadVersion}`,
-        });
-    }
-
-    static directiveNotSupportedByDevice(deviceName, namespace, payloadVersion) {
-        return AlexaResponse.errorResponse({
-            type: 'INTERNAL_ERROR',
-            message: `Device ${deviceName} doesn't support the ${namespace} with payloadVersion ${payloadVersion}`,
-        });
-    }
-
-
-    static nonExistingEndpoint(endpointId) {
-        return AlexaResponse.errorResponse({
-            type: 'INTERNAL_ERROR',
-            message: `No endpoint with id ${endpointId} found`,
-        });
-    }
-
-    /**
-     * Composes Alexa respond on a successfully processed Alexa directive to change a capability's value of a device
-     * @param {*} event
-     * @param {string} propertyName
-     * @param {*} value
-     * @returns
-     */
-    static handled(event, propertyName, value, propertyInstance) {
-        const response = new AlexaResponse({
-            correlationToken: event?.directive?.header?.correlationToken,
-            token: event?.directive?.endpoint?.scope?.token,
-            endpointId: event?.directive?.endpoint?.endpointId,
-        });
-
-        response.addContextProperty({
-            namespace: event?.directive?.header?.namespace,
-            name: propertyName,
-            instance: propertyInstance,
-            value,
-        });
-
-        return response;
-    }
-
-
-    /**
-     * Constructor for an Alexa Response.
-     * @constructor
-     * @param opts Contains initialization options for the response
-     */
-    constructor(opts) {
-        if (opts === undefined)
-            opts = {};
-
-        if (opts.context !== undefined) {
-            this.context = Utils.defaultIfNullOrEmpty(opts.context, undefined);
-        }
-
-        if (opts.event !== undefined) {
-            this.event = Utils.defaultIfNullOrEmpty(opts.event, undefined);
-        }
-        else {
-            this.event = {
-                header: {
-                    namespace: Utils.defaultIfNullOrEmpty(opts.namespace, 'Alexa'),
-                    name: Utils.defaultIfNullOrEmpty(opts.name, 'Response'),
-                    messageId: Utils.defaultIfNullOrEmpty(opts.messageId, uuidv4()),
-                    correlationToken: Utils.defaultIfNullOrEmpty(opts.correlationToken, undefined),
-                    payloadVersion: Utils.defaultIfNullOrEmpty(opts.payloadVersion, '3'),
-                },
-                endpoint: {
-                    scope: {
-                        type: 'BearerToken',
-                        token: Utils.defaultIfNullOrEmpty(opts.token, 'INVALID'),
-                    },
-                    endpointId: Utils.defaultIfNullOrEmpty(opts.endpointId, 'INVALID'),
-                },
-                payload: Utils.defaultIfNullOrEmpty(opts.payload, {}),
-            };
-
-            if (opts.changeCauseType) {
-                this.event.payload.change = {
-                    cause: {
-                        type: opts.changeCauseType,
-                    },
-                    properties: [],
-                };
-            }
-        }
-
-        // No endpoint in an AcceptGrant or Discover request
-        if (this.event.header.name === 'AcceptGrant.Response' || this.event.header.name === 'Discover.Response') {
-            delete this.event.endpoint;
-        }
-
-    }
-
-    addContext() {
-        if (this.context === undefined) {
-            this.context = { properties: [] };
-        }
-    }
-
-    /**
-     * Add a property to the context.
-     * @param opts Contains options for the property.
-     */
-    addContextProperty(opts) {
-        this.addContext();
-
-        const property = {
-            namespace: Utils.defaultIfNullOrEmpty(opts.namespace, 'Alexa.EndpointHealth'),
-            instance: Utils.defaultIfNullOrEmpty(opts.instance, undefined),
-            name: Utils.defaultIfNullOrEmpty(opts.name, 'connectivity'),
-            value: Utils.defaultIfNullOrEmpty(opts.value, { value: 'OK' }),
-            timeOfSample: Utils.defaultIfNullOrEmpty(opts.timeOfSample, new Date().toISOString()),
-            uncertaintyInMilliseconds: Utils.defaultIfNullOrEmpty(opts.uncertaintyInMilliseconds, 0),
-        }
-
-        if (!property.instance) {
-            delete property.instance;
-        }
-
-        this.context.properties.push(property);
-    }
-
-    /**
-     * Add a property to the payload.
-     * @param opts Contains options for the property.
-     */
-    addPayloadChangeProperty(opts) {
-        if (opts === undefined) {
-            opts = {};
-        }
-
-        const property = {
-            namespace: Utils.defaultIfNullOrEmpty(opts.namespace, 'Alexa.EndpointHealth'),
-            instance: Utils.defaultIfNullOrEmpty(opts.instance, undefined),
-            name: Utils.defaultIfNullOrEmpty(opts.name, 'connectivity'),
-            value: Utils.defaultIfNullOrEmpty(opts.value, { value: 'OK' }),
-            timeOfSample: Utils.defaultIfNullOrEmpty(opts.timeOfSample, new Date().toISOString()),
-            uncertaintyInMilliseconds: Utils.defaultIfNullOrEmpty(opts.uncertaintyInMilliseconds, 0),
-        };
-
-        if (!property.instance) {
-            delete property.instance;
-        }
-
-        this.event.payload.change.properties.push(property);
-    }
-
-    alexaCapability() {
-        return [{
-            type: 'AlexaInterface',
-            interface: 'Alexa',
-            version: '3',
-        }]
-    }
-
-    /**
-     * Adds an endpoint to the payload.
-     * @param opts Contains options for the endpoint.
-     */
-    addPayloadEndpoint(opts) {
-        if (this.event.payload.endpoints === undefined) {
-            this.event.payload.endpoints = [];
-        }
-
-        if (opts === undefined) {
-            opts = {};
-        }
-
-        // construct the proper structure expected for the endpoint
-        let endpoint = {
-            endpointId: Utils.defaultIfNullOrEmpty(opts.endpointId, 'dummy-endpoint-001'),
-            manufacturerName: Utils.defaultIfNullOrEmpty(opts.manufacturerName, 'ioBroker Group'),
-            description: Utils.defaultIfNullOrEmpty(opts.description, 'Device controlled by ioBroker'),
-            friendlyName: Utils.defaultIfNullOrEmpty(opts.friendlyName, 'ioBroker Stub Endpoint'),
-            displayCategories: Utils.defaultIfNullOrEmpty(opts.displayCategories, ['OTHER']),
-            capabilities: this.alexaCapability().concat(Utils.defaultIfNullOrEmpty(opts.capabilities, [])),
-        };
-
-        if (opts.hasOwnProperty('cookie')) {
-            endpoint.cookie = Utils.defaultIfNullOrEmpty('cookie', {});
-        }
-
-        this.event.payload.endpoints.push(endpoint);
-    }
-
-    /**
-     * Creates a capability for an endpoint within the payload.
-     * @param opts Contains options for the endpoint capability.
-     */
-    asEndpointCapability(opts) {
-        if (opts === undefined) {
-            opts = {};
-        }
-
-        let response = {
-            type: Utils.defaultIfNullOrEmpty(opts.type, 'AlexaInterface'),
-            interface: Utils.defaultIfNullOrEmpty(opts.interface, 'Alexa'),
-            version: Utils.defaultIfNullOrEmpty(opts.version, '3'),
-            properties: Utils.defaultIfNullOrEmpty(opts.properties, {}),
-            // not all capabilities have the following ones
-            instance: Utils.defaultIfNullOrEmpty(opts.instance, undefined),
-            configuration: Utils.defaultIfNullOrEmpty(opts.configuration, undefined),
-            semantics: Utils.defaultIfNullOrEmpty(opts.semantics, undefined),
-            capabilityResources: Utils.defaultIfNullOrEmpty(opts.capabilityResources, undefined),
-        };
-
-        for (const prop in ['instance', 'configuration', 'semantics', 'capabilityResources']) {
-            if (!opts.hasOwnProperty(prop) || !response[prop]) {
-                delete response[prop];
-            }
-        }
-
-        return response;
-    }
-
-    /**
-     * Get the composed Alexa Response.
-     * @returns {AlexaResponse}
-     */
-    get() {
-        return this;
-    }
-}
-
-module.exports = AlexaResponse;

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

@@ -1,124 +0,0 @@
-const Utils = require('../../Helpers/Utils');
-
-class Base {
-    constructor() {
-        this._properties = this.initProperties();
-    }
-
-    get name() {
-        return `${this.constructor.name}`;
-    }
-
-    get namespace() {
-        return `Alexa.${this.constructor.name}`;
-    }
-
-    reportValue(value) {
-        return value;
-    }
-
-    initProperties() {
-        return [];
-    }
-
-    /**
-     * Checks whether the capability instance matches, i.e. can handle the event Alexa sends to the skill
-     * @param event Contains the Alexa event.
-     * @returns {boolean}
-     */
-    matches(event) {
-        return event?.directive?.header?.namespace === this.namespace && event?.directive?.header?.payloadVersion === this.version;
-    }
-
-    static get namespace() {
-        return `Alexa.${Utils.className(this.toString())}`
-    }
-
-    /**
-     * Checks whether the capability object matches, i.e., can handle the event Alexa sends to the skill
-     * @param event Contains the Alexa event.
-     * @returns {boolean}
-     */
-    static matches(event) {
-        return event?.directive?.header?.namespace === this.namespace;
-    }
-
-    get properties() {
-        return this._properties;
-    }
-
-    /**
-     *
-     * @param {*} event Contains the Alexa event.
-     * @returns Property to handle on Alexa directive
-     */
-    property(event) {
-        return this.properties.find(p => p.matches(event));
-    }
-
-    /**
-     * Returns object containing all the properties of the smart device capability as it expected by Alexa during discovery
-     * @returns {object}
-     */
-    get discoverableProperties() {
-        return {
-            supported: this.properties.map(p => { return { name: p.propertyName } }),
-            proactivelyReported: this.proactivelyReported,
-            retrievable: this.retrievable,
-        };
-    }
-
-    /**
-     * Returns whether the smart device proactively reports state changes
-     * @returns {boolean}
-     */
-    get proactivelyReported() {
-        return true;
-    }
-
-    /**
-     * Returns whether the smart device handles Alexa ReportState directives
-     * @returns {boolean}
-     */
-    get retrievable() {
-        return true;
-    }
-
-    get version() {
-        return '3';
-    }
-
-    /**
-     * Returns response to Alexa Discovery directive
-     * @returns {object}
-     */
-    get alexaResponse() {
-        return {
-            interface: this.namespace,
-            version: this.version,
-            properties: this.discoverableProperties,
-        };
-    }
-
-    propertyName(event) {
-        return this.property(event).propertyName;
-    }
-
-    /**
-     * Extracts value to be set on the smart device sent in an Alexa directive
-     * @returns {object}
-     */
-    alexaValue(event) {
-        return this.property(event).alexaValue(event);
-    }
-
-    /**
-     * Extracts endpoint id sent in an Alexa directive
-     * @returns {string}
-     */
-    static endpointId(event) {
-        return event.directive.endpoint.endpointId;
-    }
-}
-
-module.exports = Base;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/BrightnessController.js

@@ -1,15 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class BrightnessController extends Base {
-    initProperties() {
-        this._brightness = new Properties.Brightness();
-        return [this._brightness];
-    }
-
-    get brightness() {
-        return this._brightness;
-    }
-}
-
-module.exports = BrightnessController;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/ColorController.js

@@ -1,10 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class ColorController extends Base {
-    initProperties() {
-        return [new Properties.Color()];
-    }
-}
-
-module.exports = ColorController;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/ColorTemperatureController.js

@@ -1,15 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class ColorTemperatureController extends Base {
-    initProperties() {
-        this._colorTemperatureInKelvin = new Properties.ColorTemperatureInKelvin();
-        return [this._colorTemperatureInKelvin];
-    }
-
-    get colorTemperatureInKelvin() {
-        return this._colorTemperatureInKelvin;
-    }
-}
-
-module.exports = ColorTemperatureController;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/ContactSensor.js

@@ -1,10 +0,0 @@
-const Base = require('./Base')
-const Properties = require('../Properties');
-
-class ContactSensor extends Base {
-    initProperties() {
-        return [new Properties.DetectionState()];
-    }
-}
-
-module.exports = ContactSensor;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/LockController.js

@@ -1,10 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class LockController extends Base {
-    initProperties() {
-        return [new Properties.LockState()];
-    }
-}
-
-module.exports = LockController;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/ModeController.js

@@ -1,69 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class ModeController extends Base {
-    initProperties() {
-        this._property = new Properties.Mode()
-        return [this._property];
-    }
-
-    /**
-     * Returns response to Alexa Discovery directive
-     * @returns {object}
-     */
-    get alexaResponse() {
-        return {
-            interface: this.namespace,
-            instance: this.instance,
-            version: this.version,
-            properties: this.discoverableProperties,
-            configuration: this.configurationAsDiscoveryResponse,
-            semantics: this.semanticsAsDiscoveryResponse,
-            capabilityResources: this.capabilityResourcesAsDiscoveryResponse
-        };
-    }
-
-    get discoverableProperties() {
-        return {
-            supported: this.properties.map(p => { return { name: p.propertyName } }),
-            proactivelyReported: this.proactivelyReported,
-            retrievable: this.retrievable,
-            nonControllable: false
-        };
-    }
-
-    get capabilityResourcesAsDiscoveryResponse() {
-        return { friendlyNames: this.friendlyNames }
-    }
-
-    get friendlyNames() {
-        return [
-            {
-                '@type': 'asset',
-                value: {
-                    assetId: 'Alexa.Setting.Mode'
-                }
-            }
-        ]
-    }
-
-    get instance() {
-        return `${this._property.instance}`
-    }
-
-    get configurationAsDiscoveryResponse() {
-        return {
-            ordered: false,
-            supportedModes: this._property.supportedModes.flatMap(mode => mode.discoveryResponse)
-        }
-    }
-
-    get semanticsAsDiscoveryResponse() {
-        return {
-            actionMappings: this._property.supportedModes.flatMap(mode => mode.actionMappings),
-            stateMappings: this._property.supportedModes.flatMap(mode => mode.stateMappings)
-        }
-    }
-}
-
-module.exports = ModeController;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/MotionSensor.js

@@ -1,10 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class MotionSensor extends Base {
-    initProperties() {
-        return [new Properties.DetectionState()];
-    }
-}
-
-module.exports = MotionSensor;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/PercentageController.js

@@ -1,10 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class PercentageController extends Base {
-    initProperties() {
-        return [new Properties.Percentage()];
-    }
-}
-
-module.exports = PercentageController;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/PowerController.js

@@ -1,15 +0,0 @@
-const Properties = require('./../Properties');
-const Base = require('./Base');
-
-class PowerController extends Base {
-    initProperties() {
-        this._powerState = new Properties.PowerState();
-        return [this._powerState];
-    }
-
-    get powerState() {
-        return this._powerState;
-    }
-}
-
-module.exports = PowerController;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/Speaker.js

@@ -1,20 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class Speaker extends Base {
-    initProperties() {
-        this._volume = new Properties.Volume();
-        this._muted = new Properties.Muted();
-        return [this._volume, this._muted];
-    }
-
-    get volume() {
-        return this._volume;
-    }
-
-    get muted() {
-        return this._muted;
-    }
-}
-
-module.exports = Speaker;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/TemperatureSensor.js

@@ -1,10 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class TemperatureSensor extends Base {
-    initProperties() {
-        return [new Properties.Temperature()];
-    }
-}
-
-module.exports = TemperatureSensor;

package/lib/AlexaSmartHomeV3/Alexa/Capabilities/ThermostatController.js

@@ -1,34 +0,0 @@
-const Properties = require('../Properties');
-const Base = require('./Base');
-
-class ThermostatController extends Base {
-    get version() {
-        return '3.2';
-    }
-
-    initProperties() {
-        this._thermostatMode = new Properties.ThermostatMode();
-        return [new Properties.TargetSetpoint(), this._thermostatMode];
-    }
-
-    get thermostatMode() {
-        return this._thermostatMode;
-    }
-
-    get alexaResponse() {
-        return {
-            interface: this.namespace,
-            version: this.version,
-            properties: this.discoverableProperties,
-            configuration: this.configuration,
-        };
-    }
-
-    get configuration() {
-        return {
-            supportedModes: this._thermostatMode.supportedModes,
-        };
-    }
-}
-
-module.exports = ThermostatController;

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

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

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

@@ -1,27 +0,0 @@
-const Logger = require('../../Helpers/Logger');
-const Utils = require('../../Helpers/Utils');
-
-class Base {
-    constructor() {
-        this.log = new Logger(this);
-    }
-
-    static get namespace() {
-        return `Alexa.${Utils.className(this.toString())}`;
-    }
-
-    /**
-     * Checks whether the directive matches, i.e., can handle the event Alexa sends to the skill
-     * @param event Contains the Alexa event.
-     * @returns {boolean}
-     */
-    static matches(event) {
-        return event?.directive?.header?.namespace === this.namespace;
-    }
-
-    async handle(event, endpointManager) {
-        return null;
-    }
-}
-
-module.exports = Base;