Updated external content (Jenkins build 954)

pull/1839/head
openHAB Build Server 2022-05-29 18:33:31 +00:00
parent 357f3b96ca
commit 68b745224b
6 changed files with 14 additions and 52 deletions

File diff suppressed because one or more lines are too long

View File

@ -18,7 +18,7 @@ This binding integrates the Heliop door/videophone system (https://www.2n.cz).
## Supported Things
Currently, the Helios IP Vario is supported by this binding, running the 2.7 or 2.21 version of the firmware
Currently, the Helios IP Vario is supported by this binding, running the 2.21 version of the firmware
## Binding Configuration
@ -28,7 +28,7 @@ There is no specific binding configuration
## Thing Configuration
The ipvario221 (or ipvario27) Thing requires the IP address of the videophone, and the username and password as a configuration value in order for the binding to log into the videophone.
The ipvario221 Thing requires the IP address of the videophone, and the username and password as a configuration value in order for the binding to log into the videophone.
In the thing file, this looks e.g. like
@ -69,7 +69,7 @@ For switchstate, there are as well the switchstateswitch and switchstateoriginat
demo.Things:
```
Thing helios:ipvario213:gate [ipAddress="192.168.0.14", username="admin", password="mypassword"]
Thing helios:ipvario221:gate [ipAddress="192.168.0.14", username="admin", password="mypassword"]
```
demo.items:

View File

@ -38,7 +38,7 @@ It can be extended with different channels.
| `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`. |
| `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",`|
| `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.|
| `ignoreSSLErrors` | no | false | If set to true ignores invalid SSL certificate errors. This is potentially dangerous.|
*Note:* Optional "no" means that you have to configure a value unless a default is provided and you are ok with that setting.
@ -50,16 +50,18 @@ 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.
**Attention:** `baseUrl` (and `stateExtension`/`commandExtension`) should not use escaping (e.g. `%22` instead of `"` or `%2c` instead of `,`).
**Attention:** `baseUrl` (and `stateExtension`/`commandExtension`) should not normally use escaping (e.g. `%22` instead of `"` or `%2c` instead of `,`).
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).
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
Each item type has its own channel-type.
Depending on the channel-type, channels have different configuration options.
All channel-types (except `image`) have `stateExtension`, `commandExtension`, `stateTransformation`, `commandTransformation` and `mode` parameters.
The `image` channel-type supports `stateExtension` only.
The `image` channel-type supports `stateExtension`, `stateContent` and `escapedUrl` only.
| parameter | optional | default | description |
|-------------------------|----------|-------------|-------------|
@ -67,6 +69,7 @@ The `image` channel-type supports `stateExtension` only.
| `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. |
| `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`) |
| `mode` | no | `READWRITE` | Mode this channel is allowed to operate. `READONLY` means receive state, `WRITEONLY` means send commands. |

View File

@ -256,6 +256,7 @@ The following devices have been tested by openHAB users with the binding. This l
| Busch-Jaeger 6735 | Control Element (1-channel) |
| Busch-Jaeger 6735/01 | Control Element (1-channel, battery-operated) |
| Busch-Jaeger 6736 | Control Element (2-channel) |
| Clipsal Iconic dimmers and swtiches | Switches and dimmers |
| Eurotronic Spirit Thermostat | Radiator Thermostat |
| GE Bulbs | |
| GE Tapt Wall Switch | On/Off Switch |
@ -278,6 +279,7 @@ The following devices have been tested by openHAB users with the binding. This l
| Osram Smart+ Plug | |
| Securifi Peanut Plug | Metered Plug |
| Shenzhen Ksentry Electronics On Off Controller | Relay |
| Schneider Electric dimmers and swtiches | Switches and dimmers |
| SMaBiT (Bitron Video) Magnetic contect | AV2010/21 /21A /21B /21C |
| SMaBiT (Bitron Video) Motion Sensor | AV2010/22 /22A /22B |
| SMaBiT (Bitron Video) Wall-mount relay | AV2010/18 (10A on/off), /16 (2.5A Dimmer) |

View File

@ -271,6 +271,7 @@ The following devices have been tested by openHAB users with the binding. This l
| Busch-Jaeger 6735 | Control Element (1-channel) |
| Busch-Jaeger 6735/01 | Control Element (1-channel, battery-operated) |
| Busch-Jaeger 6736 | Control Element (2-channel) |
| Clipsal Iconic dimmers and swtiches | Switches and dimmers |
| Eurotronic Spirit Thermostat | Radiator Thermostat |
| GE Bulbs | |
| GE Tapt Wall Switch | On/Off Switch |
@ -293,6 +294,7 @@ The following devices have been tested by openHAB users with the binding. This l
| Osram Smart+ Plug | |
| Securifi Peanut Plug | Metered Plug |
| Shenzhen Ksentry Electronics On Off Controller | Relay |
| Schneider Electric dimmers and swtiches | Switches and dimmers |
| SMaBiT (Bitron Video) Magnetic contect | AV2010/21 /21A /21B /21C |
| SMaBiT (Bitron Video) Motion Sensor | AV2010/22 /22A /22B |
| SMaBiT (Bitron Video) Wall-mount relay | AV2010/18 (10A on/off), /16 (2.5A Dimmer) |

View File

@ -1,45 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="helios"
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="ipvario27">
<label>Helios IP Vario</label>
<description>Helios IP Vario Door Station / Intercom with Firmware v2.7</description>
<channels>
<channel id="keypressed" typeId="keypressed"/>
<channel id="keypressedstamp" typeId="keypressedstamp"/>
<channel id="callstate" typeId="callstate"/>
<channel id="calldirection" typeId="calldirection"/>
<channel id="callstatestamp" typeId="callstatestamp"/>
<channel id="card" typeId="card"/>
<channel id="cardvalid" typeId="cardvalid"/>
<channel id="cardstamp" typeId="cardstamp"/>
<channel id="code" typeId="code"/>
<channel id="codevalid" typeId="codevalid"/>
<channel id="codestamp" typeId="codestamp"/>
<channel id="devicestate" typeId="devicestate"/>
<channel id="devicestatestamp" typeId="devicestatestamp"/>
</channels>
<config-description>
<parameter name="ipAddress" type="text" required="true">
<context>network-address</context>
<label>Network Address</label>
<description>Network address of the Helios IP device</description>
</parameter>
<parameter name="openHABipAddress" type="text" required="true">
<context>network-address</context>
<label>Network Address</label>
<description>Network address of the openHAB host</description>
</parameter>
<parameter name="openHABportNumber" type="integer" required="true">
<label>Port Number</label>
<description>TCP port number the notification web service will be registered on</description>
</parameter>
</config-description>
</thing-type>
</thing:thing-descriptions>