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

pull/2245/head
openHAB Build Server 2024-01-15 05:34:33 +00:00
parent 41bfd4c25f
commit 00df97e710
5 changed files with 138 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
_addons_bindings/http/readme.md
View File

@ -25,23 +25,25 @@ It can be extended with different channels.
## Thing Configuration ## Thing Configuration
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------|----------|---------|-------------| |-----------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `baseURL` | no | - | The base URL for this thing. Can be extended in channel-configuration. | | `baseURL` | no | - | The base URL (including protocol `http://` or `https://`) for this thing. Can be extended in channel-configuration. |
| `refresh` | no | 30 | Time in seconds between two refresh calls for the channels of this thing. | | `refresh` | no | 30 | Time in seconds between two refresh calls for the channels of this thing. |
| `timeout` | no | 3000 | Timeout for HTTP requests in ms. | | `timeout` | no | 3000 | Timeout for HTTP requests in ms. |
| `bufferSize` | no | 2048 | The buffer size for the response data (in kB). | | `bufferSize` | no | 2048 | The buffer size for the response data (in kB). |
| `delay` | no | 0 | Delay between two requests in ms (advanced parameter). | | `delay` | no | 0 | Delay between two requests in ms (advanced parameter). |
| `username` | yes | - | Username for authentication (advanced parameter). | | `username` | yes | - | Username for authentication (advanced parameter). |
| `password` | yes | - | Password for authentication (advanced parameter). | | `password` | yes | - | Password for authentication (advanced parameter). Also used for the authentication token when using `TOKEN` authentication. |
| `authMode` | no | BASIC | Authentication mode, `BASIC`, `BASIC_PREEMPTIVE` or `DIGEST` (advanced parameter). | | `authMode` | no | BASIC | Authentication mode, `BASIC`, `BASIC_PREEMPTIVE`, `TOKEN` or `DIGEST` (advanced parameter). |
| `stateMethod` | no | GET | Method used for requesting the state: `GET`, `PUT`, `POST`. | | `stateMethod` | no | GET | Method used for requesting the state: `GET`, `PUT`, `POST`. |
| `commandMethod` | no | GET | Method used for sending commands: `GET`, `PUT`, `POST`. | | `commandMethod` | no | GET | Method used for sending commands: `GET`, `PUT`, `POST`. |
| `contentType` | yes | - | MIME content-type of the command requests. Only used for `PUT` and `POST`. | | `contentType` | yes | - | MIME content-type of the command requests. Only used for `PUT` and `POST`. |
| `encoding` | yes | - | Encoding to be used if no encoding is found in responses (advanced parameter). | | `encoding` | yes | - | Encoding to be used if no encoding is found in responses (advanced parameter). |
| `headers` | yes | - | Additional headers that are sent along with the request. Format is "header=value". Multiple values can be stored as `headers="key1=value1", "key2=value2", "key3=value3",`. When using text based configuration include at minimum 2 headers to avoid parsing errors.| | `headers` | yes | - | Additional headers that are sent along with the request. Format is "header=value". Multiple values can be stored as `headers="key1=value1", "key2=value2", "key3=value3",` |
| `ignoreSSLErrors` | no | false | If set to true ignores invalid SSL certificate errors. This is potentially dangerous.| | `ignoreSSLErrors` | no | false | If set to true, ignores invalid SSL certificate errors. This is potentially dangerous. |
| `strictErrorHandling` | no | false | If set to true, thing status is changed depending on last request result (failed = `OFFLINE`). Failed requests result in `UNDEF` for channel values. |
| `userAgent` | yes | (yes ) | Sets a custom user agent (default is "Jetty/version", e.g. "Jetty/9.4.20.v20190813"). |
_Note:_ Optional "no" means that you have to configure a value unless a default is provided and you are ok with that setting. _Note:_ Optional "no" means that you have to configure a value unless a default is provided, and you are ok with that setting.
_Note:_ The `BASIC_PREEMPTIVE` mode adds basic authentication headers even if the server did not request authentication. _Note:_ The `BASIC_PREEMPTIVE` mode adds basic authentication headers even if the server did not request authentication.
This is dangerous and might be misused. This is dangerous and might be misused.
@ -50,30 +52,29 @@ Authentication might fail if redirections are involved as headers are stripper p
_Note:_ If you rate-limit requests by using the `delay` parameter you have to make sure that the time between two refreshes is larger than the time needed for one refresh cycle. _Note:_ If you rate-limit requests by using the `delay` parameter you have to make sure that the time between two refreshes is larger than the time needed for one refresh cycle.
**Attention:** `baseUrl` (and `stateExtension`/`commandExtension`) should not normally use escaping (e.g. `%22` instead of `"` or `%2c` instead of `,`). **Attention:** `baseUrl` (and `stateExtension`/`commandExtension`) should not use escaping (e.g. `%22` instead of `"` or `%2c` instead of `,`).
URLs are properly escaped by the binding itself before the request is sent. URLs are properly escaped by the binding itself before the request is sent.
Using escaped strings in URL parameters may lead to problems with the formatting (see below). Using escaped strings in URL parameters may lead to problems with the formatting (see below).
In certain scenarios you may need to manually escape your URL, for example if you need to include an escaped `=` (`%3D`) in this scenario include `%%3D` in the URL to preserve the `%` during formatting, and set the parameter `escapedUrl` to true on the channel.
## Channels ## Channels
The thing has two channels of type `request-date-time` which provide the timestamp of the last successful (`last-success`) and last failed (`last-failure`) request.
Additionally, the thing can be extended with data channels.
Each item type has its own channel-type. Each item type has its own channel-type.
Depending on the channel-type, channels have different configuration options. Depending on the channel-type, channels have different configuration options.
All channel-types (except `image`) have `stateExtension`, `commandExtension`, `stateTransformation`, `commandTransformation` and `mode` parameters. All channel-types (except `image`) have `stateExtension`, `commandExtension`, `stateTransformation`, `commandTransformation` and `mode` parameters.
The `image` channel-type supports `stateExtension`, `stateContent` and `escapedUrl` only. The `image` channel-type supports `stateExtension` only.
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |-------------------------|----------|-------------|-----------------------------------------------------------------------------------------------------------|
| `stateExtension` | yes | - | Appended to the `baseURL` for requesting states. | | `stateExtension` | yes | - | Appended to the `baseURL` for requesting states. |
| `commandExtension` | yes | - | Appended to the `baseURL` for sending commands. If empty, same as `stateExtension`. | | `commandExtension` | yes | - | Appended to the `baseURL` for sending commands. If empty, same as `stateExtension`. |
| `stateTransformation ` | yes | - | One or more transformation applied to received values before updating channel. | | `stateTransformation ` | yes | - | One or more transformation applied to received values before updating channel. |
| `commandTransformation` | yes | - | One or more transformation applied to channel value before sending to a remote. | | `commandTransformation` | yes | - | One or more transformation applied to channel value before sending to a remote. |
| `escapedUrl` | yes | - | This specifies whether the URL is already escaped. |
| `stateContent` | yes | - | Content for state requests (if method is `PUT` or `POST`) | | `stateContent` | yes | - | Content for state requests (if method is `PUT` or `POST`) |
| `mode` | no | `READWRITE` | Mode this channel is allowed to operate. `READONLY` means receive state, `WRITEONLY` means send commands. | | `mode` | no | `READWRITE` | Mode this channel is allowed to operate. `READONLY` means receive state, `WRITEONLY` means send commands. |
Transformations need to be specified in the same format as
Some channels have additional parameters. Some channels have additional parameters.
When concatenating the `baseURL` and `stateExtension` or `commandExtension` the binding checks if a proper URL part separator (`/`, `&` or `?`) is present and adds a `/` if missing. When concatenating the `baseURL` and `stateExtension` or `commandExtension` the binding checks if a proper URL part separator (`/`, `&` or `?`) is present and adds a `/` if missing.
@ -96,7 +97,7 @@ The same mechanism works for commands (`commandTransformation`) for outgoing val
### `color` ### `color`
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |-----------------|----------|---------|---------------------------------------------------------------------------|
| `onValue` | yes | - | A special value that represents `ON` | | `onValue` | yes | - | A special value that represents `ON` |
| `offValue` | yes | - | A special value that represents `OFF` | | `offValue` | yes | - | A special value that represents `OFF` |
| `increaseValue` | yes | - | A special value that represents `INCREASE` | | `increaseValue` | yes | - | A special value that represents `INCREASE` |
@ -109,14 +110,14 @@ All values that are not `onValue`, `offValue`, `increaseValue`, `decreaseValue`
### `contact` ### `contact`
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |---------------|----------|---------|------------------------------------------|
| `openValue` | no | - | A special value that represents `OPEN` | | `openValue` | no | - | A special value that represents `OPEN` |
| `closedValue` | no | - | A special value that represents `CLOSED` | | `closedValue` | no | - | A special value that represents `CLOSED` |
### `dimmer` ### `dimmer`
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |-----------------|----------|---------|---------------------------------------------------------------------------|
| `onValue` | yes | - | A special value that represents `ON` | | `onValue` | yes | - | A special value that represents `ON` |
| `offValue` | yes | - | A special value that represents `OFF` | | `offValue` | yes | - | A special value that represents `OFF` |
| `increaseValue` | yes | - | A special value that represents `INCREASE` | | `increaseValue` | yes | - | A special value that represents `INCREASE` |
@ -128,7 +129,7 @@ All values that are not `onValue`, `offValue`, `increaseValue`, `decreaseValue`
### `number` ### `number`
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |-----------|----------|---------|---------------------------------|
| `unit` | yes | - | The unit label for this channel | | `unit` | yes | - | The unit label for this channel |
`number` channels can be used for `DecimalType` or `QuantityType` values. `number` channels can be used for `DecimalType` or `QuantityType` values.
@ -138,18 +139,18 @@ Please note that incompatible units (e.g. `°C` for a `Number:Density` item) wil
### `player` ### `player`
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |--------------------|----------|---------|-----------------------------------------------|
| `play` | yes | - | A special value that represents `PLAY` | | `playValue` | yes | - | A special value that represents `PLAY` |
| `pause` | yes | - | A special value that represents `PAUSE` | | `pauseValue` | yes | - | A special value that represents `PAUSE` |
| `next` | yes | - | A special value that represents `NEXT` | | `nextValue` | yes | - | A special value that represents `NEXT` |
| `previous` | yes | - | A special value that represents `PREVIOUS` | | `previousValue` | yes | - | A special value that represents `PREVIOUS` |
| `fastforward` | yes | - | A special value that represents `FASTFORWARD` | | `fastforwardValue` | yes | - | A special value that represents `FASTFORWARD` |
| `rewind` | yes | - | A special value that represents `REWIND` | | `rewindValue` | yes | - | A special value that represents `REWIND` |
### `rollershutter` ### `rollershutter`
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |-------------|----------|---------|----------------------------------------|
| `upValue` | yes | - | A special value that represents `UP` | | `upValue` | yes | - | A special value that represents `UP` |
| `downValue` | yes | - | A special value that represents `DOWN` | | `downValue` | yes | - | A special value that represents `DOWN` |
| `stopValue` | yes | - | A special value that represents `STOP` | | `stopValue` | yes | - | A special value that represents `STOP` |
@ -160,7 +161,7 @@ All values that are not `upValue`, `downValue`, `stopValue`, `moveValue` are int
### `switch` ### `switch`
| parameter | optional | default | description | | parameter | optional | default | description |
|-------------------------|----------|-------------|-------------| |------------|----------|---------|---------------------------------------|
| `onValue` | no | - | A special value that represents `ON` | | `onValue` | no | - | A special value that represents `ON` |
| `offValue` | no | - | A special value that represents `OFF` | | `offValue` | no | - | A special value that represents `OFF` |
@ -168,7 +169,7 @@ All values that are not `upValue`, `downValue`, `stopValue`, `moveValue` are int
## URL Formatting ## URL Formatting
After concatenation of the `baseURL` and the `commandExtension` or the `stateExtension` (if provided) the URL is formatted using the [java.util.Formatter](https://docs.oracle.com/javase/6/docs/api/java/util/Formatter.html). After concatenation of the `baseURL` and the `commandExtension` or the `stateExtension` (if provided) the URL is formatted using the [java.util.Formatter](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Formatter.html).
The URL is used as format string and two parameters are added: The URL is used as format string and two parameters are added:
- the current date (referenced as `%1$`) - the current date (referenced as `%1$`)
@ -178,13 +179,13 @@ After the parameter reference the format needs to be appended.
See the link above for more information about the available format parameters (e.g. to use the string representation, you need to append `s` to the reference, for a timestamp `t`). See the link above for more information about the available format parameters (e.g. to use the string representation, you need to append `s` to the reference, for a timestamp `t`).
When sending an OFF command on 2020-07-06, the URL When sending an OFF command on 2020-07-06, the URL
```text ```
http://www.domain.org/home/lights/23871/?status=%2$s&date=%1$tY-%1$tm-%1$td http://www.domain.org/home/lights/23871/?status=%2$s&date=%1$tY-%1$tm-%1$td
``` ```
is transformed to is transformed to
```text ```
http://www.domain.org/home/lights/23871/?status=OFF&date=2020-07-06 http://www.domain.org/home/lights/23871/?status=OFF&date=2020-07-06
``` ```

5
_addons_bindings/luxtronikheatpump/readme.md
View File

@ -302,9 +302,10 @@ The usage of the numbered channels above is currently unknown. If you are able t
The following channels are also writable: The following channels are also writable:
| channel | type | advanced | description | | channel | type | advanced | description |
|------------------------------------------|--------------------|----------|--------------------------------------| |------------------------------------------|--------------------|----------|-------------------------------------------------------------------------------------|
| temperatureHeatingParallelShift | Number:Temperature | | Heating temperature (parallel shift) | | temperatureHeatingParallelShift | Number:Temperature | | Heating temperature (parallel shift) |
| temperatureHotWaterTarget | Number:Temperature | | Hot water target temperature | | temperatureHotWaterTarget | Number:Temperature | | Hot water target temperature |
| temperatureHeatingFixedReturnTarget | Number:Temperature | | Fixed return target temperature if heat pump is operating in fixed temperature mode |
| heatingMode | Number | | Heating mode | | heatingMode | Number | | Heating mode |
| hotWaterMode | Number | | Hot water operating mode | | hotWaterMode | Number | | Hot water operating mode |
| thermalDisinfectionMonday | Switch | x | Thermal disinfection (Monday) | | thermalDisinfectionMonday | Switch | x | Thermal disinfection (Monday) |
@ -382,4 +383,4 @@ This binding was initially based on the [Novelan/Luxtronik Heat Pump Binding](ht
Luxtronik control units have an internal webserver which serves a Java applet. This applet can be used to configure some parts of the heat pump. The applet itselves uses a socket connection to fetch and send data to the heatpump. Luxtronik control units have an internal webserver which serves a Java applet. This applet can be used to configure some parts of the heat pump. The applet itselves uses a socket connection to fetch and send data to the heatpump.
This socket is also used by this binding. To get some more information on how this socket works you can check out other Luxtronik tools like [Luxtronik2 for NodeJS](https://github.com/coolchip/luxtronik2). This socket is also used by this binding. To get some more information on how this socket works you can check out other Luxtronik tools like [Luxtronik2 for NodeJS](https://github.com/coolchip/luxtronik2).
A detailed parameter descriptions for the Java Webinterface can be found in the [Loxwiki](https://loxwiki.atlassian.net/wiki/spaces/LOX/pages/1533935933/Java+Webinterface) A detailed parameter description for the Java Webinterface can be found in the [Loxwiki](https://loxwiki.atlassian.net/wiki/spaces/LOX/pages/1533935933/Java+Webinterface)

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

@ -9,6 +9,19 @@
<label>HTTP URL Thing</label> <label>HTTP URL Thing</label>
<description>Represents a base URL and all associated requests.</description> <description>Represents a base URL and all associated requests.</description>
<channels>
<channel typeId="request-date-time" id="last-failure">
<label>Last Failure</label>
</channel>
<channel typeId="request-date-time" id="last-success">
<label>Last Success</label>
</channel>
</channels>
<properties>
<property name="thingTypeVersion">2</property>
</properties>
<config-description> <config-description>
<parameter name="baseURL" type="text" required="true"> <parameter name="baseURL" type="text" required="true">
<label>Base URL</label> <label>Base URL</label>
@ -44,7 +57,7 @@
</parameter> </parameter>
<parameter name="password" type="text"> <parameter name="password" type="text">
<label>Password</label> <label>Password</label>
<description>Basic Authentication password</description> <description>Authentication password or token</description>
<context>password</context> <context>password</context>
<advanced>true</advanced> <advanced>true</advanced>
</parameter> </parameter>
@ -54,6 +67,7 @@
<option value="BASIC">Basic Authentication</option> <option value="BASIC">Basic Authentication</option>
<option value="BASIC_PREEMPTIVE">Preemptive Basic Authentication</option> <option value="BASIC_PREEMPTIVE">Preemptive Basic Authentication</option>
<option value="DIGEST">Digest Authentication</option> <option value="DIGEST">Digest Authentication</option>
<option value="TOKEN">Token/Bearer Authentication</option>
</options> </options>
<default>BASIC</default> <default>BASIC</default>
<limitToOptions>true</limitToOptions> <limitToOptions>true</limitToOptions>
@ -112,9 +126,20 @@
<default>false</default> <default>false</default>
<advanced>true</advanced> <advanced>true</advanced>
</parameter> </parameter>
<parameter name="userAgent" type="text">
<label>User Agent</label>
<description>Sets a custom user agent (default is "Jetty/version", e.g. "Jetty/9.4.20.v20190813").</description>
<advanced>true</advanced>
</parameter>
</config-description> </config-description>
</thing-type> </thing-type>
<channel-type id="request-date-time">
<item-type>DateTime</item-type>
<label>Dummy</label>
<state readOnly="true" pattern="%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS"/>
</channel-type>
<channel-type id="color"> <channel-type id="color">
<item-type>Color</item-type> <item-type>Color</item-type>
<label>Color Channel</label> <label>Color Channel</label>

7
_thing_types/org.openhab.binding.luxtronikheatpump/src/main/resources/OH-INF/thing/channels.xml
View File

@ -2059,6 +2059,13 @@
<state pattern="%.1f %unit%" min="30" max="65" step="0.5"></state> <state pattern="%.1f %unit%" min="30" max="65" step="0.5"></state>
</channel-type> </channel-type>
<channel-type id="temperatureHeatingFixedReturnTarget" advanced="true">
<item-type>Number:Temperature</item-type>
<label>Fixed Heating Target Return Temperature</label>
<category>Temperature</category>
<state pattern="%.1f %unit%"></state>
</channel-type>
<channel-type id="comfortCoolingMode"> <channel-type id="comfortCoolingMode">
<item-type>Number</item-type> <item-type>Number</item-type>
<label>Comfort Cooling Mode</label> <label>Comfort Cooling Mode</label>

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

@ -16,6 +16,7 @@
<channel id="temperatureOutsideMean" typeId="temperatureOutsideMean"/> <channel id="temperatureOutsideMean" typeId="temperatureOutsideMean"/>
<channel id="temperatureHotWater" typeId="temperatureHotWater"/> <channel id="temperatureHotWater" typeId="temperatureHotWater"/>
<channel id="temperatureHotWaterTarget" typeId="temperatureHotWaterTarget"/> <channel id="temperatureHotWaterTarget" typeId="temperatureHotWaterTarget"/>
<channel id="temperatureHeatingFixedReturnTarget" typeId="temperatureHeatingFixedReturnTarget"/>
<channel id="temperatureHotWaterCoverage" typeId="temperatureHotWaterCoverage"/> <channel id="temperatureHotWaterCoverage" typeId="temperatureHotWaterCoverage"/>
<channel id="temperatureHeatSourceInlet" typeId="temperatureHeatSourceInlet"/> <channel id="temperatureHeatSourceInlet" typeId="temperatureHeatSourceInlet"/>
<channel id="temperatureHeatSourceOutlet" typeId="temperatureHeatSourceOutlet"/> <channel id="temperatureHeatSourceOutlet" typeId="temperatureHeatSourceOutlet"/>
@ -312,6 +313,10 @@
<channel id="comfortCoolingATUndercut" typeId="comfortCoolingATUndercut"/> <channel id="comfortCoolingATUndercut" typeId="comfortCoolingATUndercut"/>
</channels> </channels>
<properties>
<property name="thingTypeVersion">1</property>
</properties>
<config-description> <config-description>
<parameter name="ipAddress" type="text" required="true"> <parameter name="ipAddress" type="text" required="true">
<context>network-address</context> <context>network-address</context>