OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated external content (Jenkins build 1593)

pull/2109/head
openHAB Build Server 2023-07-13 05:34:26 +00:00
parent 518a6c24be
commit f96af794dd
7 changed files with 73 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_addons_bindings/astro/readme.md
View File

@ -71,7 +71,7 @@ This is done by setting `useMeteorologicalSeason` to true in the advanced settin
- `totalElevation, partialElevation, ringElevation` (Number:Angle)
- **group** `phase`
- **channel**
- `name` (String), values: `SUN_RISE, ASTRO_DAWN, NAUTIC_DAWN, CIVIL_DAWN, CIVIL_DUSK, NAUTIC_DUSK, ASTRO_DUSK, SUN_SET, DAYLIGHT, NIGHT`
- `name` (String), values: `SUN_RISE, ASTRO_DAWN, NAUTIC_DAWN, CIVIL_DAWN, CIVIL_DUSK, NAUTIC_DUSK, ASTRO_DUSK, SUN_SET, DAYLIGHT, NOON, NIGHT`
- **thing** `moon`
- **group** `rise, set`
- **channel**

15
_addons_bindings/freeboxos/readme.md
View File

@ -68,13 +68,14 @@ FreeboxOS binding has the following configuration parameters:
### API bridge
| Parameter Label | Parameter ID | Description | Required | Default |
|--------------------------|-------------------|--------------------------------------------------------|----------|----------------------|
| Freebox Server Address | apiDomain | The domain to use in place of hardcoded Freebox ip | No | mafreebox.freebox.fr |
| Application Token | appToken | Token generated by the Freebox Server. | Yes | |
| Network Device Discovery | discoverNetDevice | Enable the discovery of network device things. | No | false |
| HTTPS Available | httpsAvailable | Tells if https has been configured on the Freebox | No | false |
| HTTPS port | httpsPort | Port to use for remote https access to the Freebox Api | No | 15682 |
| Parameter Label | Parameter ID | Description | Required | Default |
|-------------------------------|-------------------|--------------------------------------------------------|----------|----------------------|
| Freebox Server Address | apiDomain | The domain to use in place of hardcoded Freebox ip | No | mafreebox.freebox.fr |
| Application Token | appToken | Token generated by the Freebox Server. | Yes | |
| Network Device Discovery | discoverNetDevice | Enable the discovery of network device things. | No | false |
| Background Discovery Interval | discoveryInterval | Interval in minutes - 0 disables background discovery | No | 10 |
| HTTPS Available | httpsAvailable | Tells if https has been configured on the Freebox | No | false |
| HTTPS port | httpsPort | Port to use for remote https access to the Freebox Api | No | 15682 |
If the parameter *apiDomain* is not set, the binding will use the default address used by Free to access your Freebox Server (mafreebox.freebox.fr).
The bridge thing will initialize only if a valid application token (parameter *appToken*) is filled.

13
_addons_bindings/mynice/readme.md
View File

@ -61,14 +61,18 @@ Channels available for the gates are :
| Channel | Type | Read/Write | Description |
|-----------|--------|------------|----------------------------------------------------------|
| status | String | R | Description of the current status of the door (1) |
| status | String | R/W (1) | Description of the current status of the door (2) |
| obstruct | Switch | R | Flags an obstruction, blocking the door |
| moving | Switch | R | Indicates if the device is currently operating a command |
| command | String | W | Send a given command to the gate (2) |
| command | String | W | Send a given command to the gate (3) |
| t4command | String | W | Send a T4 Command to the gate |
| courtesy | Switch | R/W | Status of the courtesy light (4) |
(1) : can be open, closed, opening, closing, stopped.
(2) : must be "stop","open","close"
(1) : Accepted commands are : STOP, MOVE
(2) : Valid status are : OPEN, CLOSED, OPENING, CLOSING, STOPPED
(3) : Accepted commands are : "stop","open","close"
(4) : There is no way to retrieve the current status of the courtesy light. It is supposed to be ON when the gate is moving and turned OFF once done.
The delay between the moving end and light being turned off is a configuration parameter of the `courtesy` channel.
### T4 Commands
@ -125,5 +129,6 @@ String NiceIT4WIFI_GateStatus "Gate Status" <gate> (gMyniceSwing) ["Statu
String NiceIT4WIFI_Obstruction "Obstruction" <none> (gMyniceSwing) {channel="mynice:swing:83eef09166:1:obstruct"}
Switch NiceIT4WIFI_Moving "Moving" <motion> (gMyniceSwing) ["Status","Vibration"] {channel="mynice:swing:83eef09166:1:moving"}
String NiceIT4WIFI_Command "Command" <none> (gMyniceSwing) {channel="mynice:swing:83eef09166:1:command"}
Switch NiceIT4WIFI_Command "Courtesy Light" <light> (gMyniceSwing) {channel="mynice:swing:83eef09166:1:courtesy"}
```

5
_addons_voices/marytts/readme.md
View File

@ -58,3 +58,8 @@ The sample frequency depends on the chosen voice and ranges from 16kHz to 48kHz.
## Log files
The log messages of Mary TTS are not bundled with the openHAB log messages in the `openhab.log` file of your log directory but are stored in their own log file at `server.log` of your log directory.
## Caching
The MaryTTS service uses the openHAB TTS cache to cache audio files produced from the most recent queries in order to reduce traffic, improve performance and reduce number of requests.

5
_addons_voices/mimictts/readme.md
View File

@ -32,7 +32,6 @@ It supports a subset of SSML, and if you want to use it, be sure to start your t
Using your favorite configuration UI to edit **Settings / Other Services - Mimic Text-to-Speech** and set:
* **url** - Mimic URL. Default to `http://localhost:59125`
* **workaroundServletSink** - A boolean activating a workaround for audiosink using the openHAB servlet. It stores audio file temporarily on disk, allowing the servlet to get a cloned stream as needed. Default false.
* **speakingRate** - Controls how fast the voice speaks the text. A value of 1 is the speed of the training dataset. Less than 1 is faster, and more than 1 is slower.
* **audioVolatility** - The amount of noise added to the generated audio (0-1). Can help mask audio artifacts from the voice model. Multi-speaker models tend to sound better with a lower amount of noise than single speaker models.
* **phonemeVolatility** - The amount of noise used to generate phoneme durations (0-1). Allows for variable speaking cadance, with a value closer to 1 being more variable. Multi-speaker models tend to sound better with a lower amount of phoneme variability than single speaker models.
@ -63,3 +62,7 @@ In case you would like to setup these settings via a text file, you can edit the
org.openhab.voice:defaultTTS=mimictts
org.openhab.voice:defaultVoice=mimictts:fr_FR_siwis_low
```
## Caching
The mimic TTS service uses the openHAB TTS cache to cache audio files produced from the most recent queries in order to reduce traffic, improve performance and reduce number of requests.

5
_addons_voices/voicerss/readme.md
View File

@ -181,9 +181,10 @@ It supports the following audio formats: MP3, OGG, AAC and WAV.
## Caching
The VoiceRSS extension does cache audio files from previous requests, to reduce traffic, improve performance, reduce number of requests and provide same time offline capability.
The VoiceRSS TTS service uses the openHAB TTS cache to cache audio files produced from the most recent queries in order to reduce traffic, improve performance and reduce number of requests.
For convenience, there is a tool where the audio cache can be generated in advance, to have a prefilled cache when starting this extension.
An additional and specific cache can be prepared in advance to provide offline capability for predefined queries.
For convenience, there is a tool where this cache can be generated in advance, to have a prefilled cache when starting this service.
You have to copy the generated data to your userdata/voicerss/cache folder.
Synopsis of this tool:

54
_thing_types/org.openhab.binding.mynice/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -47,8 +47,13 @@
<channel id="moving" typeId="moving"/>
<channel id="command" typeId="command"/>
<channel id="t4command" typeId="t4command"/>
<channel id="courtesy" typeId="courtesy"/>
</channels>
<properties>
<property name="thingTypeVersion">1</property>
</properties>
<representation-property>id</representation-property>
<config-description>
@ -73,8 +78,13 @@
<channel id="moving" typeId="moving"/>
<channel id="command" typeId="command"/>
<channel id="t4command" typeId="t4command"/>
<channel id="courtesy" typeId="courtesy"/>
</channels>
<properties>
<property name="thingTypeVersion">1</property>
</properties>
<representation-property>id</representation-property>
<config-description>
@ -90,15 +100,23 @@
<item-type>String</item-type>
<label>Gate Status</label>
<description>Position of the gate or state if moving</description>
<state readOnly="true">
<category>door</category>
<state>
<options>
<option value="open">Open</option>
<option value="closed">Closed</option>
<option value="opening">Opening</option>
<option value="closing">Closing</option>
<option value="stopped">Stopped</option>
<option value="OPEN">Open</option>
<option value="CLOSED">Closed</option>
<option value="OPENING">Opening</option>
<option value="CLOSING">Closing</option>
<option value="STOPPED">Stopped</option>
</options>
</state>
<command>
<options>
<option value="STOP">Stop</option>
<option value="MOVE">Move</option>
</options>
</command>
<autoUpdatePolicy>veto</autoUpdatePolicy>
</channel-type>
<channel-type id="moving">
@ -115,17 +133,17 @@
<state readOnly="true"/>
</channel-type>
<channel-type id="command">
<channel-type id="command" advanced="true">
<item-type>String</item-type>
<label>Command</label>
<description>Send a given command to the gate</description>
<state readOnly="false">
<command>
<options>
<option value="stop">Stop</option>
<option value="open">Open</option>
<option value="close">Close</option>
</options>
</state>
</command>
<autoUpdatePolicy>veto</autoUpdatePolicy>
</channel-type>
@ -133,7 +151,7 @@
<item-type>String</item-type>
<label>T4 Command</label>
<description>Send a T4 Command to the gate</description>
<state readOnly="false">
<command>
<options>
<option value="MDAx">Step by Step</option>
<option value="MDAy">Stop (as remote control)</option>
@ -159,8 +177,22 @@
<option value="MDE5">Release and Open</option>
<option value="MDFh">Release and Close</option>
</options>
</state>
</command>
<autoUpdatePolicy>veto</autoUpdatePolicy>
</channel-type>
<channel-type id="courtesy">
<item-type>Switch</item-type>
<label>Courtesy Light</label>
<description>Courtesy Light illuminates the area around your gates.</description>
<category>lightbulb</category>
<config-description>
<parameter name="duration" type="integer" min="0" unit="s" step="1">
<label>Duration</label>
<description>Duration the lamp stays on</description>
<default>60</default>
</parameter>
</config-description>
</channel-type>
</thing:thing-descriptions>