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

pull/1569/head
openHAB Build Server 2021-04-11 17:12:33 +00:00
parent c27c8d8ccc
commit 686c09fc3f
5 changed files with 365 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.vuepress/thing-types.json
View File

File diff suppressed because one or more lines are too long

BIN
_addons_bindings/qbus/doc/Logo.JPG Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 888 KiB

124
_addons_bindings/qbus/readme.md Normal file
View File

@ -0,0 +1,124 @@
---
id: qbus
label: Qbus
title: Qbus - Bindings
type: binding
description: "![Qbus Logo](doc/Logo.JPG)"
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Qbus Binding
![Qbus Logo](doc/Logo.JPG)
This binding for [Qbus](https://qbus.be) communicates with all controllers of the Qbus home automation system.
We also host a site which contains a [manual](https://manualoh.schockaert.tk/) where you can find lots of information to set up openHAB with Qbus client and server (for the moment only in Dutch).
The controllers can not communicate directly with openHAB, therefore we developed a client/server application which you must install prior to enable this binding.
More information can be found here:
[Qbus Client/Server](https://github.com/QbusKoen/QbusClientServer-Installer)
With this binding you can control and read almost every output from the Qbus system.
## Supported Things
The following things are supported by the Qbus binding:
- `dimmer`: Dimmer 1 button, 2 button and clc
- `onOff`: Bistabiel, Timer1-3, Interval
- `thermostats`: Thermostats - normal and PID
- `scene`: Scenes
- `co2`: CO2
- `rollershutter`: Rollershutter
- `rollershutter_slats`: Rollerhutter with slats
For now the following Qbus things are not yet supported but will come:
- DMX
- Timer 4 & 5
- HVAC
- Humidity
- Renson
- Duco
- Kinetura
- Energy monitor
- Weather station
## Discovery
The discovery service is not yet implemented but the System Manager III software of Qbus generates things and item files from the programming, which you can use directly in openHAB.
## Bridge configuration
```
Bridge qbus:bridge:CTD001122 [ addr="localhost", sn="001122", port=8447, serverCheck=10 ] {
...
}
```
| Property | Default | Required | Description |
| ------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `addr` | localhost | YES | The ip address of the machine where the Qbus Server runs |
| `sn` | | YES | The serial number of your controller |
| `port` | 8447 | YES | The communication port of the client/server |
| `serverCheck` | 10 | NO | Refresh time - After x minutes there will be a check if server is still running and if client is still connected. If not - reconnect |
## Things configuration
| Thing Type ID | Channel Name | Read only | description |
| --------------------- | ------------- | --------- | ------------------------------------------------------ |
| `onOff` | switch | No | This is the channel for Bistable, Timers and Intervals |
| `dimmer` | brightness | No | This is the channel for Dimmers 1&2 buttons and CLC |
| `scene` | Switch | No | This is the channel for scenes |
| `co2` | co2 | Yes | This is the channel for CO2 sensors |
| `rollershutter` | rollershutter | No | This is the channel for rollershutters |
| `rollershutter_slats` | rollershutter | No | This is the channel for rollershutters with slats |
| `thermostat` | setpoint | No | This is the channel for thermostats setpoint |
| `thermostat` | measured | Yes | This is the channel for thermostats currenttemp |
| `thermostat` | mode | No | This is the channel for thermostats mode |
## Full Example
### Things
```
Bridge qbus:bridge:CTD001122 [ addr="localhost", sn="001122", port=8447, serverCheck=10 ] {
dimmer 1 "ToonzaalLED" [ dimmerId=100 ]
onOff 30 "Toonzaal230V" [ bistabielId=76 ]
thermostat 50 "Service" [ thermostatId=99 ]
scene 70 "Disco" [ sceneId=36 ]
co2 100 "Productie" [ co2Id=26 ]
rollershutter 120 "Roller1" [ rolId=268 ]
rollershutter_slats 121 "Roller2" [ rolId=264 ]
}
```
### Items
```
Dimmer ToonzaalLED <light> [ "Lighting" ] {channel="qbus:dimmer:CTD007841:1:brightness"}
Switch Toonzaal230V <light> {channel="qbus:onOff:CTD007841:30:switch"}
Number:Temperature ServiceSP"[%.1f %unit%]" (GroepThermostaten) {channel="qbus:thermostat:CTD007841:50:setpoint"}
Number:Temperature ServiceCT"[%.1f %unit%]" (GroepThermostaten) {channel="qbus:thermostat:CTD007841:50:measured"}
Number ServiceMode (GroepThermostaten) {channel="qbus:thermostat:CTD007841:50:mode",ihc="0x33c311" , autoupdate="true"}
Switch Disco <light> {channel="qbus:scene:CTD007841:36:scene"}
Number ProductieCO2 {channel="qbus:co2:CTD007841:100:co2"}
Rollershutter Roller1 {channel="qbus:rollershutter:CTD007841:120:rollershutter"}
Rollershutter Roller2 {channel="qbus:rollershutter_slats:CTD007841:121:rollershutter"}
Dimmer Roller2_slats {channel="qbus:rollershutter_slats:CTD007841:121:slats"}
```
This is the link to the [Qbus forum](https://qbusforum.be). This forum is mainly in dutch and you can find a lot of information about the pre testings of this binding and offers a way to communicate with other users.

231
_thing_types/org.openhab.binding.qbus/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,231 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="qbus"
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="bridge">
<label>Qbus Bridge</label>
<description>This bridge represents a Qbus client</description>
<config-description>
<parameter name="addr" type="text" required="true">
<label>Hostname</label>
<description>IP address or hostname of Qbus server, usually 'localhost'</description>
<default>localhost</default>
<context>network-address</context>
</parameter>
<parameter name="sn" type="text" required="true">
<label>Serial Number</label>
<description>Serial number of the CTD controller</description>
</parameter>
<parameter name="port" type="integer" required="false">
<label>Bridge Port</label>
<description>Port to communicate with Qbus server, default 8447</description>
<default>8447</default>
<advanced>true</advanced>
</parameter>
<parameter name="serverCheck" type="integer" required="false" unit="min" min="1">
<label>Server Check</label>
<description>Time to check communication with Qbus Server (min), default 10. If set to 0 or left empty, no refresh
will be scheduled</description>
<default>10</default>
<advanced>true</advanced>
</parameter>
</config-description>
</bridge-type>
<thing-type id="onOff">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Switch</label>
<description>Bistabiel-Mono-Timer-Interval Output</description>
<channels>
<channel id="switch" typeId="system.power"/>
</channels>
<config-description>
<parameter name="bistabielId" type="integer" required="true">
<label>Qbus ID</label>
<description>Qbus Bistabiel ID</description>
</parameter>
</config-description>
</thing-type>
<thing-type id="scene">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Scene</label>
<description>Qbus Scene</description>
<channels>
<channel id="scene" typeId="scene"/>
</channels>
<config-description>
<parameter name="sceneId" type="integer" required="true">
<label>Qbus Scene ID</label>
<description>Qbus Scene ID</description>
</parameter>
</config-description>
</thing-type>
<thing-type id="co2">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>CO2</label>
<description>Qbus CO2</description>
<channels>
<channel id="co2" typeId="co2"/>
</channels>
<config-description>
<parameter name="co2Id" type="integer" required="true">
<label>Qbus CO2 ID</label>
<description>Qbus CO2 ID</description>
</parameter>
</config-description>
</thing-type>
<thing-type id="dimmer">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Dimmer</label>
<description>Qbus Dimmer Output</description>
<channels>
<channel id="brightness" typeId="system.brightness"/>
</channels>
<config-description>
<parameter name="dimmerId" type="integer" required="true">
<label>Output ID</label>
<description>Qbus Dimmer ID</description>
</parameter>
<parameter name="step" type="integer" required="true">
<label>Step Value</label>
<description>Step value used for increase/decrease of dimmer brightness, default 10%</description>
<default>10</default>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
<thing-type id="rollershutter">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>RollerShutter</label>
<description>Qbus shutter (ROL02P) control</description>
<channels>
<channel id="rollershutter" typeId="rollershutter"/>
</channels>
<config-description>
<parameter name="rolId" type="integer" required="true">
<label>Rol ID</label>
<description>Qbus Rol Id</description>
</parameter>
</config-description>
</thing-type>
<thing-type id="rollershutter_slats">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>RollerShutter (With Slats)</label>
<description>Qbus shutter with slats control</description>
<channels>
<channel id="rollershutter" typeId="rollershutter"/>
<channel id="slats" typeId="slats"/>
</channels>
<config-description>
<parameter name="rolId" type="integer" required="true">
<label>Rol ID</label>
<description>Qbus Rol Id</description>
</parameter>
</config-description>
</thing-type>
<thing-type id="thermostat">
<supported-bridge-type-refs>
<bridge-type-ref id="bridge"/>
</supported-bridge-type-refs>
<label>Thermostat</label>
<description>Qbus Thermostat</description>
<channels>
<channel id="measured" typeId="measured"/>
<channel id="mode" typeId="mode"/>
<channel id="setpoint" typeId="setpoint"/>
</channels>
<config-description>
<parameter name="thermostatId" type="integer" required="true">
<label>Thermostat ID</label>
<description>Qbus Thermostat ID</description>
</parameter>
</config-description>
</thing-type>
<channel-type id="scene">
<item-type>Switch</item-type>
<label>Scene</label>
<description>Scene Control for Qbus</description>
<category>Scene</category>
</channel-type>
<channel-type id="measured">
<item-type>Number:Temperature</item-type>
<label>Measured</label>
<description>Temperature Measured by Thermostat</description>
<category>Temperature</category>
<tags>
<tag>CurrentTemperature</tag>
</tags>
<state readOnly="true" pattern="%.1f %unit%"/>
</channel-type>
<channel-type id="setpoint">
<item-type>Number:Temperature</item-type>
<label>Setpoint</label>
<description>Setpoint Temperature of Thermostat</description>
<category>Temperature</category>
<tags>
<tag>TargetTemperature</tag>
</tags>
<state min="0" max="100" step="0.5" pattern="%.1f %unit%"/>
</channel-type>
<channel-type id="mode">
<item-type>Number</item-type>
<label>Mode</label>
<description>Thermostat Mode</description>
<category>Number</category>
<state>
<options>
<option value="0">Manual</option>
<option value="1">Freeze</option>
<option value="2">Economic</option>
<option value="3">Comfort</option>
<option value="4">Night</option>
</options>
</state>
</channel-type>
<channel-type id="co2">
<item-type>Number</item-type>
<label>CO2</label>
<description>CO2 value for Qbus</description>
<category>CO2</category>
</channel-type>
<channel-type id="rollershutter">
<item-type>Rollershutter</item-type>
<label>Rollershutter</label>
<description>Rollershutter Control for Qbus</description>
<category>Blinds</category>
</channel-type>
<channel-type id="slats">
<item-type>Dimmer</item-type>
<label>Slatcontrol</label>
<description>Slatcontrol for Qbus</description>
<category>Blinds</category>
</channel-type>
</thing:thing-descriptions>

14
installation/openhabian.md
View File

@ -122,12 +122,16 @@ On x86 hardware, 64 bit is the standard.
### Networking
The scripted use (i.e. the non-image version) of openHABian does not change anything about your OS' networking setup (except if you deploy a VPN from the menu, of course) so you have to take care of that yourself.
For image based installations, openHABian re-uses the TCP/IP networking setup Raspberry Pi OS is coming with. This is documented over here:
https://www.raspberrypi.org/documentation/configuration/tcpip/.
See also there what that `169.*` IP address is about in case you see it on your system (it means DHCP didn't work).
A properly working DHCP server is a mandatory prerequisite to openHABian networking setup.
For image based installations, openHABian re-uses the TCP/IP networking setup Raspberry Pi OS is coming with.
A properly working DHCP server is a mandatory prerequisite to openHABian's networking setup.
We recommend you configure your DHCP server to always assign the same IP based based on your Pi's MAC address.
That'll effectively get you a fixed IP address.
Most DHCP servers are part of your Internet router and have an option to allow for this type of mapping.
For example in AVM Fritz!boxes (popular in Germany), it's a simple checkbox you can tick - note it only appears after the address was assigned to a client (your openHABian box) for the first time.
Note it is NOT supported to setup openHABian with a static IP address as described in the Raspberry Pi OS documentation as that can interfere with openHABian functionality.
If you want to have a fixed address, configure your DHCP server to respond with that IP to requests from your Pi's MAC address.
For reference, the RPi OS process is documented over here: https://www.raspberrypi.org/documentation/configuration/tcpip/.
If you are getting an `169.*` IP address it means DHCP didn't work.
When you boot a flashed image for the first time, openHABian will setup and use the Ethernet port if that one is connected with a cable to your LAN.
It'll also use the `wifi_ssid` and `wifi_password` parameters from `/etc/openhabian.conf` to determine whether and how to setup the Wi-Fi interface.