diff --git a/_addons_automation/jsscripting/readme.md b/_addons_automation/jsscripting/readme.md index 90b602c28..6402b1a95 100644 --- a/_addons_automation/jsscripting/readme.md +++ b/_addons_automation/jsscripting/readme.md @@ -3,7 +3,7 @@ id: jsscripting label: JavaScript Scripting title: JavaScript Scripting - Automation type: automation -description: "This add-on provides support for JavaScript (ECMAScript 2021+) that can be used as a scripting language within automation rules." +description: "This add-on provides support for JavaScript (ECMAScript 2022+) that can be used as a scripting language within automation rules." since: 3x logo: images/addons/jsscripting.png install: manual @@ -15,7 +15,7 @@ install: manual # JavaScript Scripting -This add-on provides support for JavaScript (ECMAScript 2021+) that can be used as a scripting language within automation rules. +This add-on provides support for JavaScript (ECMAScript 2022+) that can be used as a scripting language within automation rules. Also included is [openhab-js](https://github.com/openhab/openhab-js/), a fairly high-level ES6 library to support automation in openHAB. It provides convenient access to common openHAB functionality within rules including items, things, actions, logging and more. diff --git a/_addons_bindings/shelly/readme.md b/_addons_bindings/shelly/readme.md index fcb2a53c1..178b7651c 100644 --- a/_addons_bindings/shelly/readme.md +++ b/_addons_bindings/shelly/readme.md @@ -241,7 +241,7 @@ The period is computed depending on the device type and configuration: - else, if CoIoT or WebSocket is enabled: 3*<update Period from device settings>+10sec, usually3*15+10=45sec - else 2*60+10sec = 130sec -Once the timer expires the device switches to OFFFLINE and the bindings starts to re-initialize the device periodically. +Once the timer expires the device switches to OFFLINE and the bindings starts to re-initialize the device periodically. You could also create a rule to catch those status changes or device alarms (see rule examples). diff --git a/_addons_ios/alexa-skill/images/metadata_attributes_multiple.png b/_addons_ios/alexa-skill/images/metadata_attributes_multiple.png new file mode 100644 index 000000000..91e181c08 Binary files /dev/null and b/_addons_ios/alexa-skill/images/metadata_attributes_multiple.png differ diff --git a/_addons_ios/alexa-skill/images/metadata_attributes_single.png b/_addons_ios/alexa-skill/images/metadata_attributes_single.png new file mode 100644 index 000000000..4c3076681 Binary files /dev/null and b/_addons_ios/alexa-skill/images/metadata_attributes_single.png differ diff --git a/_addons_ios/alexa-skill/images/metadata_config_group_endpoint.png b/_addons_ios/alexa-skill/images/metadata_config_group_endpoint.png new file mode 100644 index 000000000..a01f1e081 Binary files /dev/null and b/_addons_ios/alexa-skill/images/metadata_config_group_endpoint.png differ diff --git a/_addons_ios/alexa-skill/images/metadata_config_group_member.png b/_addons_ios/alexa-skill/images/metadata_config_group_member.png new file mode 100644 index 000000000..4731e1760 Binary files /dev/null and b/_addons_ios/alexa-skill/images/metadata_config_group_member.png differ diff --git a/_addons_ios/alexa-skill/images/metadata_config_single_endpoint.png b/_addons_ios/alexa-skill/images/metadata_config_single_endpoint.png new file mode 100644 index 000000000..a9b0a4f37 Binary files /dev/null and b/_addons_ios/alexa-skill/images/metadata_config_single_endpoint.png differ diff --git a/_addons_ios/alexa-skill/images/metadata_config_undefined.png b/_addons_ios/alexa-skill/images/metadata_config_undefined.png new file mode 100644 index 000000000..86ea1acc4 Binary files /dev/null and b/_addons_ios/alexa-skill/images/metadata_config_undefined.png differ diff --git a/_addons_ios/alexa-skill/images/metadata_namespace.png b/_addons_ios/alexa-skill/images/metadata_namespace.png new file mode 100644 index 000000000..d3e326fd7 Binary files /dev/null and b/_addons_ios/alexa-skill/images/metadata_namespace.png differ diff --git a/_addons_ios/alexa-skill/images/skill-logo.png b/_addons_ios/alexa-skill/images/skill_logo.png similarity index 100% rename from _addons_ios/alexa-skill/images/skill-logo.png rename to _addons_ios/alexa-skill/images/skill_logo.png diff --git a/_addons_ios/alexa-skill/readme.md b/_addons_ios/alexa-skill/readme.md index b13ce0d18..a8656ac14 100644 --- a/_addons_ios/alexa-skill/readme.md +++ b/_addons_ios/alexa-skill/readme.md @@ -7,7 +7,7 @@ description: "Alexa is an intelligent personal assistant developed by Amazon and # Amazon Alexa Smart Home Skill - + Alexa is an intelligent personal assistant developed by Amazon and designed to run on smart speakers and devices such as the Amazon Echo and Dot. @@ -31,6 +31,8 @@ The skill connects your openHAB setup through the [myopenHAB.org](http://myopenH * [Generic Capabilities](#generic-capabilities) * [Semantic Extensions](#semantic-extensions) * [Item Configuration](#item-configuration) + * [Textual Configuration](#textual-configuration) + * [UI Configuration](#ui-configuration) * [Device Types](#device-types) * [Device Attributes](#device-attributes) * [Troubleshooting](#troubleshooting) @@ -429,7 +431,11 @@ String VacuumCleaner "Vacuum Cleaner" {alexa="VacuumCleaner.Mode" [capabilityNam # Item Configuration -In order to configure an Alexa endpoint, one or more device configuration, composed of a [type](#device-types) and an [attribute](#device-attributes) `{alexa="."}`, must be defined in the "Alexa" item metadata settings. Depending on the type of endpoint being configured, the device type or attribute can be omitted. +In order to configure an Alexa endpoint, one or more device configuration, composed of a [type](#device-types) and an [attribute](#device-attributes) `{alexa="."}`, must be defined in the `Alexa` item metadata settings. Depending on the type of endpoint being configured, the device type or attribute can be omitted. + +The metadata settings can be configured using [textual files](#textual-configuration) or the [graphical UI](#ui-configuration). Using both methods on the same item may result in some UI integration incompatibility. It is highly recommended to use either-or. + +## Textual Configuration For [single endpoints](#single-endpoint), when a device is only composed of a type, the default attribute(s) of that type are used. Using the single dimmer light shorthand example from above, the `Light` device type default attributes for a "Dimmer" item are [`PowerState`](#powerstate) and [`Brightness`](#brightness). The fully qualified definition would be: @@ -459,6 +465,36 @@ Color Color "Color" (Bulb) {alexa="Light"} // Equivalent to {alexa Dimmer Temperature "Temperature" (Bulb) {alexa="ColorTemperature"} ``` +## UI Configuration + +To add the metadata settings to an item in MainUI, click on `Settings` and then `Items` from the sidebar logged in as an administrator, and select the item to configure from the list. Click on `Add Metadata` and select the `Amazon Alexa` namespace. + +![metadata_namespace](images/metadata_namespace.png) + +Click on `Alexa Device Type/Attribute`. + +![metadata_config_undefined](images/metadata_config_undefined.png) + +Select the attribute to configure the item as. + +![metadata_attributes_single](images/metadata_attributes_single.png) + +To select multiple attributes, click the `Multiple` checkbox in the top right corner of the metadata configuration page. + +![metadata_attributes_multiple](images/metadata_attributes_multiple.png) + +Once the attribute(s) are selected, configure the associated metadata parameters if necessary. Some parameters may only be visible when the `Show Advanced` checkbox is enabled. When finished, click `Save` located in the top right corner to save the metadata settings. + +![metadata_config_single_endpoint](images/metadata_config_single_endpoint.png) + +For group items, click on `Alexa Device Type` instead and select the [device type](#device-types). Each group member with Alexa metadata settings will show under the `Group Endpoint Capabilities` section. Any invalid capability part of the group will show as ignored. + +![metadata_config_group_endpoint](images/metadata_config_group_endpoint.png) + +Click on any of the active group capabilities to access the associated item metadata settings directly. Each of them will display the [group endpoint(s)](#group-endpoint) they are part of, and their attribute selection menu will be filtered based on the group supported and already configured capabilities. + +![metadata_config_group_member](images/metadata_config_group_member.png) +