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 1243)

pull/1969/head
openHAB Build Server 2022-12-05 23:24:20 +00:00
parent 96e489d9b2
commit f81effafb0
26 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_addons_bindings/dbquery/readme.md
View File

@ -198,7 +198,7 @@ Example (using Jython script):
### The Simplest case
Define a InfluxDB2 database thing and a query with an interval execution.
Define an InfluxDB2 database thing and a query with an interval execution.
That executes the query every 15 seconds and punts the result in `myItem`.
# Bridge Thing definition

6
_addons_bindings/enphase/readme.md
View File

@ -27,8 +27,8 @@ Therefore using a refresh rate shorter doesn't provide more information.
The follow things are supported:
* `envoy` The Envoy gateway thing, which is a bridge thing.
* `inverter` A Enphase micro inverter connected to a solar panel.
* `relay` A Enphase relay.
* `inverter` An Enphase micro inverter connected to a solar panel.
* `relay` An Enphase relay.
Not all Envoy gateways support all channels and things.
Therefore some data on inverters and the relay may not be available.
@ -61,7 +61,7 @@ The micro inverter `inverter` and `relay` things have only 1 parameter:
The `envoy` thing has can show both production as well as consumption data.
There are channel groups for `production` and `consumption` data.
The `consumption` data is only available if the gateway reports this.
A example of a production channel name is: `production#wattsNow`.
An example of a production channel name is: `production#wattsNow`.
| channel | type | description |
|--------------------|---------------|---------------------------------------|

2
_addons_bindings/etherrain/readme.md
View File

@ -47,7 +47,7 @@ The second is the initial delay and on-time for each zone when an execute comman
This is optional, it is recommended to let the binding discover and add Etherrain controllers.
To manually configure a Etherrain controller you may specify it's host name or ip ("host").
To manually configure an Etherrain controller you may specify its host name or ip ("host").
You can also optionally specify the unit's password ("pw"), port it is communicating on ("port") or refresh rate ("refresh")
```

2
_addons_bindings/generacmobilelink/readme.md
View File

@ -27,7 +27,7 @@ ThingTypeUID: `account`
### Generator
A Generator thing represents a individual generator linked to an account bridge. Multiple generators are supported.
A Generator thing represents an individual generator linked to an account bridge. Multiple generators are supported.
ThingTypeUID: `generator`

2
_addons_bindings/hydrawise/readme.md
View File

@ -50,7 +50,7 @@ Controller Things require a parent [Account Bridge](#Account-Bridge-Thing)
### Local Thing
The Local Thing type uses an undocumented API that allows direct HTTP access to a irrigation controller on the user's network.
The Local Thing type uses an undocumented API that allows direct HTTP access to an irrigation controller on the user's network.
This provides a subset of features compared to the Cloud Thing type limited to basic zone control.
Controlling zones through the local API will not be reported back to the cloud service or the Hydrawise mobile/web applications, and reporting functionality will not reflect the locally controlled state.

2
_addons_bindings/ipcamera/readme.md
View File

@ -202,7 +202,7 @@ If you do not specify any of these, the binding will use the default which shoul
| `customAudioAlarmUrl`| Foscam only, for custom enable audio alarm use. More info found in Foscam's setup steps. |
| `mjpegUrl`| A HTTP URL for MJPEG format streams. If you enter 'ffmpeg' the stream can be generated from the RTSP URL. |
| `ffmpegInput`| Best if this stream is in H.264 format and can be RTSP or HTTP URLs. Leave this blank to use the auto detected RTSP address for ONVIF cameras. |
| `ffmpegInputOptions` | Allows you to specify any options before the -i on the commands for FFmpeg. If you have a ESP32 camera that only has a mjpeg stream then make this equal `-f mjpeg`. |
| `ffmpegInputOptions` | Allows you to specify any options before the -i on the commands for FFmpeg. If you have an ESP32 camera that only has a mjpeg stream then make this equal `-f mjpeg`. |
| `ffmpegLocation`| The full path including the filename for where you have installed FFmpeg. The default should work for most Linux installs but if using windows use this format: `c:\ffmpeg\bin\ffmpeg.exe` |
| `ffmpegOutput`| The full path to a unique folder (different for each camera) where FFmpeg has the ability to write files to ending with a slash. If you leave this blank, the binding will automatically use `$OPENHAB_USERDATA/ipcamera/UID`. See here for where this is located on your installation, <https://www.openhab.org/docs/installation/#getting-installation-info> |
| `hlsOutOptions`| This gives you direct access to specify your own FFmpeg options to be used. Default: `-strict -2 -f lavfi -i aevalsrc=0 -acodec aac -vcodec copy -hls_flags delete_segments -hls_time 2 -hls_list_size 4` |

2
_addons_bindings/juicenet/readme.md
View File

@ -39,7 +39,7 @@ Once a JuiceNet Account bridge has been created, any JuiceBox EV Chargers associ
The configuration required is to create a JuiceNet account thing and fill in the appropriate API token.
The API token can be found on the Account page at https://home.juice.net/Manage.
A JuiceBox EV Charger requires a a unitID which can also be found in the device settings at the JuiceNet web page.
A JuiceBox EV Charger requires a unitID which can also be found in the device settings at the JuiceNet web page.
## Channels

2
_addons_bindings/keba/readme.md
View File

@ -78,7 +78,7 @@ Number:Dimensionless KebaCurrentRange "Maximum supply current [%.1f %%]" {
Number:ElectricCurrent KebaCurrent "Maximum supply current [%.3f A]" {channel="keba:kecontact:1:maxpresetcurrent"}
Number:ElectricCurrent KebaSystemCurrent "Maximum system supply current [%.3f A]" {channel="keba:kecontact:1:maxsystemcurrent"}
Number:ElectricCurrent KebaFailSafeCurrent "Failsafe supply current [%.3f A]" {channel="keba:kecontact:1:failsafecurrent"}
String KebaState "Operating State [%s]" {channel="keba:kecontact:1:state"}
Number KebaState "Operating State [%s]" {channel="keba:kecontact:1:state"}
Switch KebaSwitch "Enabled" {channel="keba:kecontact:1:enabled"}
Switch KebaWallboxPlugged "Plugged into wallbox" {channel="keba:kecontact:1:wallbox"}
Switch KebaVehiclePlugged "Plugged into vehicle" {channel="keba:kecontact:1:vehicle"}

2
_addons_bindings/mcp23017/readme.md
View File

@ -18,7 +18,7 @@ This binding allows you to have native access for MCP23017 I/O expander on I2C b
It was tested with Raspberry Pi 2 and Raspberry Pi 3, but probably should work with other devices supported by [Pi4J](https://pi4j.com/) library.
On Raspberry Pi the user on which openHAB is running (default user name is "openhab") needs to be added to groups "i2c" and "gpio".
As the MCP23017 has 3 address pins, you are restricted to 8 devices on a I2C bus.
As the MCP23017 has 3 address pins, you are restricted to 8 devices on an I2C bus.
To use more devices you have to open further I2C busses.
Therefore you can use overlays to enable bit banging I2C busses on the Raspberry Pi connector, up to I2C6.
(https://github.com/raspberrypi/firmware/tree/master/boot/overlays)

6
_addons_bindings/modbus.stiebeleltron/readme.md
View File

@ -25,9 +25,9 @@ In case the modbus extension is not yet installed on the ISG, the ISG Updater To
This bundle adds the following thing types to the Modbus binding.
Note, that the things will show up under the Modbus binding.
| Thing | ThingTypeID | Description |
| ------------------ | ----------- | -------------------------------------------------- |
| Stiebel Eltron ISG | heatpump | A stiebel eltron heat pump connected through a ISG |
| Thing | ThingTypeID | Description |
| ------------------ | ----------- | --------------------------------------------------- |
| Stiebel Eltron ISG | heatpump | A stiebel eltron heat pump connected through an ISG |
## Discovery

2
_addons_bindings/omnilink/readme.md
View File

@ -75,7 +75,7 @@ The devices support some of the following channels:
| `alarm_burglary` | Switch | Indicates if a burglary alarm is active. | `area` |
| `alarm_fire` | Switch | Indicates if a fire alarm is active. | `area` |
| `alarm_gas` | Switch | Indicates if a gas alarm is active. | `area` |
| `alarm_auxiliary` | Switch | Indicates if a auxiliary alarm is active. | `area` |
| `alarm_auxiliary` | Switch | Indicates if an auxiliary alarm is active. | `area` |
| `alarm_freeze` | Switch | Indicates if a freeze alarm is active. | `area` |
| `alarm_water` | Switch | Indicates if a water alarm is active. | `area` |
| `alarm_duress` | Switch | Indicates if a duress alarm is active. | `area` |

4
_addons_bindings/openwebnet/readme.md
View File

@ -91,7 +91,7 @@ For other gateways you can add them manually, see [Thing Configuration](#thing-c
#### Discovery by Activation
BUS devices can also be discovered if they are activated while an Inbox Scan has been started: start a new Scan, wait 15-20 seconds and then _while the Scan is still active_, activate the physical device (for example dim the dimmer) to have it discovered by the binding.
Setting the parameter `discoveryByActivation=true` for a BUS gateway Thing makes discovery by activation always working also when a Inbox Scan hasn't been started.
Setting the parameter `discoveryByActivation=true` for a BUS gateway Thing makes discovery by activation always working also when an Inbox Scan hasn't been started.
If a device cannot be discovered automatically from Inbox it's always possible to add it manually, see [Configuring Devices](#configuring-devices).
@ -227,7 +227,7 @@ With this configuration when AUX `where=4` goes ON, the Alarm will execute the a
| `shutter` | `bus_automation` | Rollershutter | To activate roller shutters (`UP`, `DOWN`, `STOP`, Percent - [see Shutter position](#shutter-position)) | R/W |
| `scenario`   | `bus_scenario_control` | String | Trigger channel for Basic scenario events [see possible values](#scenario-channels) | R (TRIGGER) |
| `button#X` | `bus_cen_scenario_control`, `bus_cenplus_scenario_control` | String | Trigger channel for CEN/CEN+ scenario events [see possible values](#scenario-channels) | R (TRIGGER) |
| `sensor` | `bus_dry_contact_ir` | Switch | Indicates if a Dry Contact Interface is `ON`/`OFF`, or if a IR Sensor is detecting movement (`ON`), or not (`OFF`) | R |
| `sensor` | `bus_dry_contact_ir` | Switch | Indicates if a Dry Contact Interface is `ON`/`OFF`, or if an IR Sensor is detecting movement (`ON`), or not (`OFF`) | R |
| `power` | `bus_energy_meter` | Number:Power | The current active power usage from Energy Meter | R |
| `aux` | `bus_aux` | String | Possible commands: `ON`, `OFF`, `TOGGLE`, `STOP`, `UP`, `DOWN`, `ENABLED`, `DISABLED`, `RESET_GEN`, `RESET_BI`, `RESET_TRI`. Only `ON` and `OFF` are supported for now | R/W |

2
_addons_bindings/shelly/doc/UseCaseSmartRoller.md
View File

@ -185,7 +185,7 @@ For example
- get status updates from roller operations by observing channel 'roller#state' and 'roller#stopReason', those report an updated status once the operation is completed
- select a position by sending a number value of 100..0 to channel 'roller#rollerpos'
- or use the defined favorites by sending favorite id to channel 'roller#rollerFav'
- you might set a auto-timer, e.g. once the roller is opened close it again after xx minutes by sending a value to the 'roller#autoOn' or 'roller#autoOff' channels
- you might set an auto-timer, e.g. once the roller is opened close it again after xx minutes by sending a value to the 'roller#autoOn' or 'roller#autoOff' channels
- you could also get the position of the roller from 'roller#control' (by linking a Number item) or the last status from 'roller#state'.
Please note that the device only provides updates only after the roller stops, not during movement so it's not possible to get position updates while the roller is moving.
- of course you could use time-triggered rules, trigger the shutter depending on sunrise/sunset within openHAB, but also directly on the device

2
_addons_bindings/shelly/readme.md
View File

@ -1021,7 +1021,7 @@ You should calibrate the valve using the device Web UI or Shelly App before star
|Group |Channel |Type |read-only|Description |
|----------|-------------|---------|---------|-----------------------------------------------------------------------|
|control |key |String |r/w |Send a IR key to the sense. There a 3 different types supported |
|control |key |String |r/w |Send an IR key to the sense. There a 3 different types supported |
| | | | |Stored key: send the key code defined by the App , e.g. 123_1_up |
| | | | |Pronto hex: send a Pronto Code in hex format, e.g. 0000 006C 0022 ... |
| | | | |Pronto base64: in base64 format, will be send 1:1 to the Sense |

2
_addons_bindings/tacmi/readme.md
View File

@ -166,7 +166,7 @@ But this also means for CoE-Messages from openHAB to TA C.M.I. we have to send m
But due to OH's design there is no default restore of previous values out of the box.
So after OH startup the _output thing channels_ are either initialized with it's configured default value or flagged as 'unknown' until the first update on the channel happens.
You could either use some 'illegal' value as initial value and use _CoE Value Validation_ on the TA side to detect invalid values.
An other option would be to use only every 4th analog and 16th digital channel if you only need a few channels.
Another option would be to use only every 4th analog and 16th digital channel if you only need a few channels.
Additionally you could use [OH's persistence service](https://www.openhab.org/docs/configuration/persistence.html#restoring-item-states-on-restart) and it's option to [restore the item states](https://www.openhab.org/docs/configuration/persistence.html#restoring-item-states-on-restart) during OH startup.
As this only restores the item states you have to write a rule issuing _postUpdates_ on the items with the item's current value so the channel for the binding is updated.

10
_addons_bindings/vesync/readme.md
View File

@ -30,11 +30,11 @@ Air Humidifier Classic 200S (Same as 300S without the nightlight from initial ch
This binding supports the follow thing types:
| Thing | Thing Type | Thing Type UID | Discovery | Description |
|----------------|------------|----------------|-----------|----------------------------------------------------------------------|
| Bridge | Bridge | bridge | Manual | A single connection to the VeSync API |
| Air Purifier | Thing | airPurifier | Automatic | A Air Purifier supporting V2 e.g. Core200S/Core300S or Core400S unit |
| Air Humidifier | Thing | airHumidifier | Automatic | A Air Humidifier supporting V2 e.g. Classic300S or 600s |
| Thing | Thing Type | Thing Type UID | Discovery | Description |
|----------------|------------|----------------|-----------|-----------------------------------------------------------------------|
| Bridge | Bridge | bridge | Manual | A single connection to the VeSync API |
| Air Purifier | Thing | airPurifier | Automatic | An Air Purifier supporting V2 e.g. Core200S/Core300S or Core400S unit |
| Air Humidifier | Thing | airHumidifier | Automatic | An Air Humidifier supporting V2 e.g. Classic300S or 600s |

2
_addons_bindings/vitotronic/readme.md
View File

@ -25,7 +25,7 @@ It supports the separation of the heating adaption from the integration in [open
The adapter transforms the address oriented raw interface of the Vitotronic to an abstract format.
The adapter itself is not a part of the binding.
[A alpha version is available here](https://github.com/steand/optolink)
[An alpha version is available here](https://github.com/steand/optolink)
[More Information about the adapter](https://github.com/steand/optolink/wiki)
## Supported Things

2
_addons_bindings/webthing/readme.md
View File

@ -20,7 +20,7 @@ The [Web Thing API](https://iot.mozilla.org/wot/) describes an open and generic
like motion sensors, web-connected displays or awning controls. Devices implementing the Web Thing standard can be integrated
into smart home systems such as openHAB to monitor and control them.
These days, the Web Thing API is primarily used by makers to provide a common API to their physical devices.
For instance, the Web Thing API has been used by makers to provide an open way to control [LEDs on a ESP8266 board](https://github.com/WebThingsIO/webthing-arduino)
For instance, the Web Thing API has been used by makers to provide an open way to control [LEDs on an ESP8266 board](https://github.com/WebThingsIO/webthing-arduino)
or to monitor [a PIR motion sensor on Raspberry Pi](https://pypi.org/project/pi-pir-webthing/).
## Supported Things

2
_thing_types/org.openhab.binding.dbquery/src/main/resources/OH-INF/thing/influx2-bridge.xml
View File

@ -5,7 +5,7 @@
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<bridge-type id="influxdb2">
<label>InfluxDB2 Bridge</label>
<description>The InfluxDB 2.0 represents a connection to a InfluxDB 2.0 server</description>
<description>The InfluxDB 2.0 represents a connection to an InfluxDB 2.0 server</description>
<config-description>
<parameter name="url" type="text" required="true">

8
_thing_types/org.openhab.binding.iaqualink/src/main/resources/OH-INF/thing/iAqualink.xml
View File

@ -5,7 +5,7 @@
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="controller">
<label>iAquaLink Pool Controller</label>
<description>A iAquaLink pool control thing represents a iAquaLink pool controller for Jandy/Zodiac systems
<description>An iAquaLink pool control thing represents an iAquaLink pool controller for Jandy/Zodiac systems
</description>
<channels>
<channel id="status" typeId="status"/>
@ -91,12 +91,12 @@
<config-description>
<parameter name="userName" type="text" required="true">
<label>User Name</label>
<description>The user name to use when connecting to a iAqualink Account</description>
<description>The user name to use when connecting to an iAqualink Account</description>
</parameter>
<parameter name="password" type="text" required="true">
<context>password</context>
<label>Password</label>
<description>The password to use when connecting to a iAqualink Account</description>
<description>The password to use when connecting to an iAqualink Account</description>
</parameter>
<parameter name="refresh" type="integer" required="true">
<label>Refresh Interval</label>
@ -283,7 +283,7 @@
<channel-type id="equipment-switch">
<item-type>Switch</item-type>
<label>Equipment Switch</label>
<description>The current state of a equipment switch</description>
<description>The current state of an equipment switch</description>
</channel-type>
<channel-type id="equipment-heater">

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

@ -4,7 +4,7 @@
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="printer">
<label>Printer</label>
<description>A IPP Printer</description>
<description>An IPP Printer</description>
<channels>
<channel id="jobs" typeId="jobs"/>

4
_thing_types/org.openhab.binding.openwebnet/src/main/resources/OH-INF/thing/BusGateway.xml
View File

@ -7,8 +7,8 @@
<!-- OpenWebNet BUS gateway -->
<bridge-type id="bus_gateway">
<label>BUS Gateway</label>
<description>This thing allows to connect to a IP BUS/SCS gateway that supports the OpenWebNet protocol (models: F454,
MyHOMEServer1, F455, MH200N, F453, etc.)</description>
<description>This thing allows to connect to an IP BUS/SCS gateway that supports the OpenWebNet protocol (models:
F454, MyHOMEServer1, F455, MH200N, F453, etc.)</description>
<properties>
<property name="vendor">BTicino</property>

2
_thing_types/org.openhab.binding.qolsysiq/src/main/resources/OH-INF/thing/partition.xml
View File

@ -42,7 +42,7 @@
<channel-type id="armState">
<item-type>String</item-type>
<label>Partition Arm State</label>
<description>Reports the current partition arm state or sends a arm or disarm command to the system. For security
<description>Reports the current partition arm state or sends an arm or disarm command to the system. For security
codes, append the 6 digit code to the command separated by a colon (e.g. 'DISARM:123456')</description>
<category>Alarm</category>
<state>

2
_thing_types/org.openhab.binding.rfxcom/src/main/resources/OH-INF/thing/energy.xml
View File

@ -13,7 +13,7 @@
</supported-bridge-type-refs>
<label>RFXCOM Energy Sensor</label>
<description>A Energy device.</description>
<description>An Energy device.</description>
<channels>
<channel id="instantPower" typeId="instantpower"/>

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

@ -59,7 +59,7 @@
<channel-type id="coe-analog-in">
<item-type>Number</item-type>
<label>Analog Input Channel (C.M.I. -> OH)</label>
<description>A Analog Channel received from the C.M.I.</description>
<description>An Analog Channel received from the C.M.I.</description>
<state readOnly="true"/>
<config-description>
<parameter name="output" type="integer" min="1" max="32" required="true">

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

@ -46,7 +46,7 @@
</supported-bridge-type-refs>
<label>Air Purifier via VeSync</label>
<description>A Air Purifier uplinking to VeSync</description>
<description>An Air Purifier uplinking to VeSync</description>
<channels>
<channel id="enabled" typeId="deviceEnabledType"/>
@ -92,7 +92,7 @@
</supported-bridge-type-refs>
<label>Air Humidifier via VeSync</label>
<description>A Air Humidifier uplinking to VeSync</description>
<description>An Air Humidifier uplinking to VeSync</description>
<channels>
<channel id="enabled" typeId="deviceEnabledType"/>