Updated external content (Jenkins build 755)

pull/1839/head
openHAB Build Server 2022-01-23 03:35:42 +00:00
parent e9413b0903
commit 1a55ffdb19
13 changed files with 1011 additions and 432 deletions

File diff suppressed because one or more lines are too long

View File

@ -99,6 +99,8 @@ The Kodi thing supports the following channels:
| inputtext | String | Sends a generic input (unicode) text to Kodi. |
| inputaction | String | Sends a predefined action to Kodi to control the UI and/or perform other tasks. Valid commands are: `left`, `right`, `up`, `down`, `pageup`, `pagedown`, `select`, `highlight`, `parentdir`, `parentfolder`, `back`, `menu`, `previousmenu`, `info`, `pause`, `stop`, `skipnext`, `skipprevious`, `fullscreen`, `aspectratio`, `stepforward`, `stepback`, `bigstepforward`, `bigstepback`, `chapterorbigstepforward`, `chapterorbigstepback`, `osd`, `showsubtitles`, `nextsubtitle`, `cyclesubtitle`, `playerdebug`, `codecinfo`, `playerprocessinfo`, `nextpicture`, `previouspicture`, `zoomout`, `zoomin`, `playlist`, `queue`, `zoomnormal`, `zoomlevel1`, `zoomlevel2`, `zoomlevel3`, `zoomlevel4`, `zoomlevel5`, `zoomlevel6`, `zoomlevel7`, `zoomlevel8`, `zoomlevel9`, `nextcalibration`, `resetcalibration`, `analogmove`, `analogmovex`, `analogmovey`, `rotate`, `rotateccw`, `close`, `subtitledelayminus`, `subtitledelay`, `subtitledelayplus`, `audiodelayminus`, `audiodelay`, `audiodelayplus`, `subtitleshiftup`, `subtitleshiftdown`, `subtitlealign`, `audionextlanguage`, `verticalshiftup`, `verticalshiftdown`, `nextresolution`, `audiotoggledigital`, `number0`, `number1`, `number2`, `number3`, `number4`, `number5`, `number6`, `number7`, `number8`, `number9`, `smallstepback`, `fastforward`, `rewind`, `play`, `playpause`, `switchplayer`, `delete`, `copy`, `move`, `screenshot`, `rename`, `togglewatched`, `scanitem`, `reloadkeymaps`, `volumeup`, `volumedown`, `mute`, `backspace`, `scrollup`, `scrolldown`, `analogfastforward`, `analogrewind`, `moveitemup`, `moveitemdown`, `contextmenu`, `shift`, `symbols`, `cursorleft`, `cursorright`, `showtime`, `analogseekforward`, `analogseekback`, `showpreset`, `nextpreset`, `previouspreset`, `lockpreset`, `randompreset`, `increasevisrating`, `decreasevisrating`, `showvideomenu`, `enter`, `increaserating`, `decreaserating`, `setrating`, `togglefullscreen`, `nextscene`, `previousscene`, `nextletter`, `prevletter`, `jumpsms2`, `jumpsms3`, `jumpsms4`, `jumpsms5`, `jumpsms6`, `jumpsms7`, `jumpsms8`, `jumpsms9`, `filter`, `filterclear`, `filtersms2`, `filtersms3`, `filtersms4`, `filtersms5`, `filtersms6`, `filtersms7`, `filtersms8`, `filtersms9`, `firstpage`, `lastpage`, `guiprofile`, `red`, `green`, `yellow`, `blue`, `increasepar`, `decreasepar`, `volampup`, `volampdown`, `volumeamplification`, `createbookmark`, `createepisodebookmark`, `settingsreset`, `settingslevelchange`, `stereomode`, `nextstereomode`, `previousstereomode`, `togglestereomode`, `stereomodetomono`, `channelup`, `channeldown`, `previouschannelgroup`, `nextchannelgroup`, `playpvr`, `playpvrtv`, `playpvrradio`, `record`, `togglecommskip`, `showtimerrule`, `leftclick`, `rightclick`, `middleclick`, `doubleclick`, `longclick`, `wheelup`, `wheeldown`, `mousedrag`, `mousemove`, `tap`, `longpress`, `pangesture`, `zoomgesture`, `rotategesture`, `swipeleft`, `swiperight`, `swipeup`, `swipedown`, `error`, `noop`. |
| inputbuttonevent | String | Send a button press event. The parameter can have the format "`<button>`", "`<button>;<keymap>`" or "`<button>;<keymap>;<holdtime>`". For details see https://kodi.wiki/view/JSON-RPC_API/v12#Input.ButtonEvent |
| inputrequested | Switch | Indicates whether Kodi is currently asking the user for input |
| screensaver | Switch | Current state of the Screensaver |
| systemcommand | String | This channel allows to send system commands to `Shutdown`, `Suspend`, `Hibernate`, `Reboot` or `Quit` Kodi (channel's state options contains available system commands) |
| mediatype | String | The media type of the current file. Valid return values are: `unknown`, `channel`, `episode`, `movie`, `musicvideo`, `picture`, `radio`, `song`, `video` |
| mediaid | Number | The media_id in database of Kodi |

File diff suppressed because it is too large Load Diff

View File

@ -297,6 +297,7 @@ The following devices have been tested by openHAB users with the binding. This l
| Xiaomi Aqara Wireless Mini Switch | _[Known issues](#xiaomi-devices)_ |
| Xiaomi Aqara Wired Wall Switch | _[Known issues](#xiaomi-devices)_ |
| Xiaomi Aqara Wireless Remote Switch | Double Rocker variant _[Known issues](#xiaomi-devices)_ |
| Xiaomi Mijia Smart Switch | Round Button _[Known issues](#xiaomi-devices)_ |
<a name="note1"></a> _Note 1: Some devices may not work with the Telegesis dongle._

View File

@ -312,6 +312,7 @@ The following devices have been tested by openHAB users with the binding. This l
| Xiaomi Aqara Wireless Mini Switch | _[Known issues](#xiaomi-devices)_ |
| Xiaomi Aqara Wired Wall Switch | _[Known issues](#xiaomi-devices)_ |
| Xiaomi Aqara Wireless Remote Switch | Double Rocker variant _[Known issues](#xiaomi-devices)_ |
| Xiaomi Mijia Smart Switch | Round Button _[Known issues](#xiaomi-devices)_ |
<a name="note1"></a> _Note 1: Some devices may not work with the Telegesis dongle._

View File

@ -27,7 +27,7 @@ You can find pricing information on the [documentation page](https://cloud.googl
<!-- MarkdownTOC -->
* [Obtaining Credentials](#obtaining-credentials)
* [Service Configuration](#service-configuration)
* [Configuration](#configuration)
* [Voice Configuration](#voice-configuration)
<!-- /MarkdownTOC -->
@ -45,7 +45,7 @@ Before you can integrate this service with your Google Cloud Text-to-Speech, you
* Select application type "TV and Limited Input" and enter a name into the "Name" field.
* Click Create. A pop-up appears, showing your "client ID" and "client secret".
## Service Configuration
## Configuration
Using your favorite configuration UI to edit **Settings / Other Services - Google Cloud Text-to-Speech** and set:
@ -65,6 +65,20 @@ It is recommended to clear this configuration parameter afterwards.
When enabled the cache is purged once.
Make sure to disable this setting again so the cache is maintained after restarts.
In case you would like to setup the service via a text file, create a new file in `$OPENHAB_ROOT/conf/services` named `googletts.cfg`
Its contents should look similar to:
```
org.openhab.voice.googletts:clientId=ID
org.openhab.voice.googletts:clientSecret=SECRET
org.openhab.voice.googletts:authcode=XXXXX
org.openhab.voice.googletts:pitch=0
org.openhab.voice.googletts:volumeGain=0
org.openhab.voice.googletts:speakingRate=1
org.openhab.voice.googletts:purgeCache=false
```
## Voice Configuration
Using your favorite configuration UI:

View File

@ -28,6 +28,10 @@ sudo apt-get install libttspico-utils
In Arch Linux the pico2wave binaries are available in an Arch User repository (AUR) under
https://aur.archlinux.org/packages/svox-pico-bin/
## Configuration
There is no need to configure anything for this service.
## Voices
The following list are the only supported languages (as these are the languages supported by

View File

@ -36,7 +36,7 @@ Within the AWS console, you can create access keys for your AWS account to acces
To use the service you will need the **access key**, **secret key** and **server region**.
## Service Configuration
## Configuration
The following configurations can be edited using the "Polly Text-to-Speech" settings in the UI:
@ -44,11 +44,10 @@ The following configurations can be edited using the "Polly Text-to-Speech" sett
* **Secret Key** - The AWS credentials secret key (required).
* **Service Region** - The service region used for accessing Polly (required). To reduce latency select the region closest to you. E.g. "eu-west-1" (see [regions](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region))
The PollyTTS service caches audio files from previous requests.
This reduces traffic, improves performance, reduces the number of requests and provides offline functionality.
* **Cache Expiration** - Cache expiration in days.
The PollyTTS service caches audio files from previous requests.
This reduces traffic, improves performance, reduces the number of requests and provides offline functionality.
When cache files are used their time stamps are updated, unused files are purged if their time stamp exceeds the specified age.
The default value of 0 disables this functionality.
A value of 365 removes files that have been unused for a year.
@ -59,21 +58,18 @@ Use "default" to select the system default audio format.
The default audio format can be overriden with the value "mp3" or "ogg".
### Service Configuration via Text files
In case you would like to setup the service via a text file, create a new file in `$OPENHAB_ROOT/conf/services` named `pollytts.cfg`
Create a new file in `$OPENHAB_ROOT/conf/services` named `pollytts.cfg`
It's contents should look similar to:
Its contents should look similar to:
```
org.openhab.voice.pollytts:accessKey=ACCESS_KEY_ID
org.openhab.voice.pollytts:accessKey=ACCESS_KEY
org.openhab.voice.pollytts:secretKey=SECRET_KEY
org.openhab.voice.pollytts:serviceRegion=SERVICE_REGION
org.openhab.voice.pollytts:cacheExpiration=EXPIRATION_IN_DAYS
org.openhab.voice.pollytts:serviceRegion=eu-west-1
org.openhab.voice.pollytts:cacheExpiration=0
org.openhab.voice.pollytts:audioFormat=default
```
These have the same meanings as described in the **Service Configuration** block above.
## Rule Examples
```

View File

@ -0,0 +1,72 @@
---
id: porcupineks
label: Porcupine Keyword Spotter
title: Porcupine Keyword Spotter - Voices
type: voice
description: "This voice service allows you to use the PicoVoice product Porcupine as your keyword spotter in openHAB."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Porcupine Keyword Spotter
This voice service allows you to use the PicoVoice product Porcupine as your keyword spotter in openHAB.
Porcupine provides on-device wake word detection powered by deep learning.
This add-on should work on all the platforms supported by Porcupine, if you encounter a problem you can try to run one of the Porcupine java demos on your machine.
Important: No voice data listened by this service will be uploaded to the Cloud.
The voice data is processed offline, locally on your openHAB server by Porcupine.
Once in a while, access keys are validated to stay active and this requires an Internet connection.
## How to use it
After installing, you will be able to access the addon options through the openHAB configuration page under the 'Other Services' section.
There you will need to provide your PicoVoice Api Key.
After that, you can select Porcupine as your default Keyword Spotter in your 'Voice' settings.
## Magic Word Configuration
The magic word to spot is gathered from your 'Voice' configuration.
The default english keyword models are loaded in the addon (also the english language model) so you can use those without adding anything else.
Note that you can use the pico voice platform to generate your own keyword models.
To use them, you should place the generated file under '\<openHAB userdata\>/porcupine' and configure your magic word to match the file name replacing spaces with '_' and adding the extension '.ppn'.
As an example, the file generated for the keyword "ok openhab" will be named 'ok_openhab.ppn'.
The service will only work if it's able to find the correct ppn for your magic word configuration.
#### Build-in keywords
Remember that they only work with the English language model. (read bellow section)
* alexa
* americano
* blueberry
* bumblebee
* computer
* grapefruits
* grasshopper
* hey google
* hey siri
* jarvis
* ok google
* picovoice
* porcupine
* terminator
## Language support
This service currently supports English, German, French and Spanish.
Only the English model binary is included with the addon and will be used if the one for your configured language is not found under '\<openHAB userdata\>/porcupine'.
To get the language model files, go to the [Porcupine repo](https://github.com/Picovoice/porcupine/tree/v2.0/lib/common).
Note that the keyword model you use should match the language model.

View File

@ -110,6 +110,8 @@
<channel id="userrating" typeId="rating">
<label>User Rating</label>
</channel>
<channel id="screensaver" typeId="screensaver"/>
<channel id="inputrequested" typeId="inputrequested"/>
</channels>
<properties>
@ -560,4 +562,16 @@
<description>Profile of Kodi</description>
<state pattern="%s"/>
</channel-type>
<channel-type id="screensaver">
<item-type>Switch</item-type>
<label>Screensaver</label>
<description>Status of the screensaver</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="inputrequested">
<item-type>Switch</item-type>
<label>Input requested</label>
<description>Status that shows if Kodi is asking for user input.</description>
<state readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

View File

@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="miio"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<bridge-type id="gateway">
<label>Xiaomi Mi Gateway</label>
<channel-groups>
<channel-group id="network" typeId="network"/>
<channel-group id="actions" typeId="basicactions"/>
</channel-groups>
<properties>
<property name="vendor">Xiaomi</property>
</properties>
<config-description-ref uri="thing-type:miio:config"/>
</bridge-type>
<channel-group-type id="basicactions">
<label>Actions</label>
<channels>
<channel id="commands" typeId="commands"/>
<channel id="rpc" typeId="rpc"/>
</channels>
</channel-group-type>
</thing:thing-descriptions>

View File

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="miio"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="lumi">
<supported-bridge-type-refs>
<bridge-type-ref id="gateway"/>
</supported-bridge-type-refs>
<label>Xiaomi Mi Lumi Device</label>
<channel-groups>
<channel-group id="actions" typeId="basicactions"/>
</channel-groups>
<properties>
<property name="vendor">Xiaomi</property>
</properties>
<config-description-ref uri="thing-type:miio:configGatewayDevices"/>
</thing-type>
<channel-group-type id="basicactions">
<label>Actions</label>
<channels>
<channel id="commands" typeId="commands"/>
<channel id="rpc" typeId="rpc"/>
</channels>
</channel-group-type>
</thing:thing-descriptions>

View File

@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="zigbee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<!-- These devices do not correctly report their clusters, so they need a static thing definition for the binding to inject the correct clusters into the ZigBeeNode
They will detect as a generic zigbee:device quickly on scan but remain unusable in that state
because they will not have gotten endpoint/channel/cluster linkaages.
This thing description takes effect when the modelId is detected as lumi.sensor_switch.
At that time sufficient details have been passed thru the binding to allow you to stop
the pairing attempts when coupled with this static channel definition.
To pair just keep pairing and pressing the link button until the device detects as lumi:sensor_switch
instead of as a generic zigbee:device. Then add the device in openhab and wait a bit for it to come online. -->
<thing-type id="xiaomi_lumisensor-switch" listed="false">
<label>Xiaomi LUMI Mijia Button</label>
<description>Single battery operated button (round model)</description>
<channels>
<channel id="switch" typeId="switch_onoff">
<properties>
<property name="zigbee_endpoint">1</property>
<property name="zigbee_inputclusters">6</property>
</properties>
</channel>
</channels>
<representation-property>zigbee_macaddress</representation-property>
<config-description>
<parameter name="zigbee_macaddress" type="text" readOnly="true" required="true">
<label>MAC Address</label>
</parameter>
</config-description>
</thing-type>
</thing:thing-descriptions>