openhab-addons/bundles/org.openhab.binding.boschshc
Christian Oeing a796e472ec
[boschshc] Release v1.1 (#10097)
* #72 changed use units of measure for the twinguard humidity and purity values

all other QuantityTypes in bindingcode are fine

* #77 changed title of binding to Bosch Smart Home

Replaced the SHC occurrences with Smart Home,
to avoid technical names.

* #62 Try to restart long polling when it fails before taking the thing offline

* #62 Run subscribe request on a new thread instead of using the thread of the previous long polling http request

This might be the reason why the subscribe request does never finish or finishes with a timeout

* #74 Run the whole long polling response handling in a new thread to not get timeout from HTTP client

* #74 Schedule initial access when long polling fails unexpected

We need to try to reconnect again and again (with 15 seconds between the requests) as the controller may have been restarted (update, manual restart,...). This is already done by the initial access, so I reuse that mechanism.

* Use direct formatting of logger.trace instead of String.format

* #76 Use i18n texts instead of raw translations for status messages about failed long polling

* #76 Use logger.debug instead of logger.warn for long poll error as it is handled now

* #78 defined api-version

each HTTP request will use now the defined "avp-version=2.1" for request to the smart home controller

* logging bundle version

removed the old static version string
access OSGi bundle version information instead

* #75 improved initial access

- added isOnline check and isAccessPossible now failed in case HTTPStatus is an error
- same HTTPStatus check done to all blocking send() request calls
- using i18n strings for all bridge updateStatus calls
- skipped the 'controller' and use only 'Bosch Smart Home' in descriptions
- added more @Nullable annotations
* added newline

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>
Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
2021-02-13 12:09:30 -08:00
..
src [boschshc] Release v1.1 (#10097) 2021-02-13 12:09:30 -08:00
DEVELOPERS.md [boschshc] Release v1.1 (#10097) 2021-02-13 12:09:30 -08:00
NOTICE [boschshc] Initial contribution - Bindings for Bosch Smart Home devices (#8629) 2021-01-17 13:20:20 -08:00
pom.xml [boschshc] Release v1.1 (#10097) 2021-02-13 12:09:30 -08:00
README.md [boschshc] Release v1.1 (#10097) 2021-02-13 12:09:30 -08:00

Bosch Smart Home Binding

Binding for the Bosch Smart Home.

Supported Things

Bosch In-Wall switches & Bosch Smart Plugs

Thing Type ID: in-wall-switch

Channel Type ID Item Type Description
power-switch Switch Current state of the switch.
power-consumption Number:Power Current power consumption (W) of the device.
energy-consumption Number:Energy Energy consumption of the device.

Bosch TwinGuard smoke detector

Thing Type ID: twinguard

Channel Type ID Item Type Description
temperature Number:Temperature Current measured temperature.
temperature-rating String Rating of the currently measured temperature.
humidity Number:Dimensionless Current measured humidity.
humidity-rating String Rating of current measured humidity.
purity Number:Dimensionless Purity of the air (ppm). Range from 500 to 5500 ppm. A higher value indicates a higher pollution.
purity-rating String Rating of current measured purity.
air-description String Overall description of the air quality.
combined-rating String Combined rating of the air quality.

Bosch Window/Door contacts

Thing Type ID: window-contact

Channel Type ID Item Type Description
contact Contact Contact state of the device.

Bosch Motion Detector

Thing Type ID: motion-detector

Channel Type ID Item Type Description
latest-motion DateTime The date of the latest motion.

Bosch Shutter Control in-wall

Thing Type ID: shutter-control

Channel Type ID Item Type Description
level Rollershutter Current open ratio (0 to 100, Step 0.5).

Bosch Thermostat

Thing Type ID: thermostat

Channel Type ID Item Type Description
temperature Number:Temperature Current measured temperature.
valve-tappet-position Number:Dimensionless Current open ratio of valve tappet (0 to 100).

Bosch Climate Control

Thing Type ID: climate-control

Channel Type ID Item Type Description
temperature Number:Temperature Current measured temperature.
setpoint-temperature Number:Temperature Desired temperature.

Limitations

  • Discovery of Things
  • Discovery of Bridge

Discovery

Configuration via configuration files or UI (see below).

Bridge Configuration

You need to provide the IP address and the system password of your Bosch Smart Home Controller. The IP address of the controller is visible in the Bosch Smart Home Mobile App (More -> System -> Smart Home Controller) or in your network router UI. The system password is set by you during your initial registration steps in the Bosch Smart Home App.

A keystore file with a self-signed certificate is created automatically. This certificate is used for pairing between the Bridge and the Bosch Smart Home Controller.

Press and hold the Bosch Smart Home Controller Bridge button until the LED starts blinking after you save your settings for pairing.

Getting the device IDs

Bosch IDs for found devices are displayed in the openHAB log on bootup (OPENHAB_FOLDER/userdata/logs/openhab.log)

Example:

2020-08-11 12:42:49.490 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.495 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-RoomClimateControl- id=roomClimateControl_hz_1
2020-08-11 12:42:49.497 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-VentilationService- id=ventilationService
2020-08-11 12:42:49.498 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Großes Fenster id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.501 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-IntrusionDetectionSystem- id=intrusionDetectionSystem
2020-08-11 12:42:49.502 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.502 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.503 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung Haus id=hdm:ICom:819410185:HC1
2020-08-11 12:42:49.503 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-RoomClimateControl- id=roomClimateControl_hz_6
2020-08-11 12:42:49.504 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=PhilipsHueBridgeManager id=hdm:PhilipsHueBridge:PhilipsHueBridgeManager
2020-08-11 12:42:49.505 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.506 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.507 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Central Heating id=hdm:ICom:819410185

Thing Configuration

You define your Bosch devices by adding them either to a .things file in your $OPENHAB_CONF/things folder like this:

Bridge boschshc:shc:1 [ ipAddress="192.168.x.y", password="XXXXXXXXXX" ] {
  Thing in-wall-switch bathroom "Bathroom" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
  Thing in-wall-switch bedroom "Bedroom" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
  Thing in-wall-switch kitchen "Kitchen" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
  Thing in-wall-switch corridor "Corridor" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]
  Thing in-wall-switch livingroom "Living Room" [ id="hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX" ]

  Thing in-wall-switch coffeemachine "Coffee Machine" [ id="hdm:HomeMaticIP:3014F711A0000XXXXXXXXXXXX" ]

  Thing twinguard      tg-corridor    "Twinguard Smoke Detector" [ id="hdm:ZigBee:000d6f000XXXXXXX" ]
  Thing window-contact window-kitchen "Window Kitchen"           [ id="hdm:HomeMaticIP:3014F711A00000XXXXXXXXXX" ]
  Thing window-contact entrance       "Entrance door"            [ id="hdm:HomeMaticIP:3014F711A00000XXXXXXXXXX" ]

  Thing motion-detector  motion-corridor "Bewegungsmelder"      [ id="hdm:ZigBee:000d6f000XXXXXXX" ]
}

Or by adding them via UI: Settings -> Things -> "+" -> Bosch Smart Home Binding.

Item Configuration

You define the items which should be linked to your Bosch devices via a .items file in your $OPENHAB_CONF/items folder like this:

Switch Bosch_Bathroom    "Bath Room"    { channel="boschshc:in-wall-switch:1:bathroom:power-switch" }
Switch Bosch_Bedroom     "Bed Room"     { channel="boschshc:in-wall-switch:1:bedroom:power-switch" }
Switch Bosch_Kitchen     "Kitchen"      { channel="boschshc:in-wall-switch:1:kitchen:power-switch" }
Switch Bosch_Corridor    "Corridor"     { channel="boschshc:in-wall-switch:1:corridor:power-switch" }
Switch Bosch_Living_Room "Living Room"  { channel="boschshc:in-wall-switch:1:livingroom:power-switch" }

Switch Bosch_Lelit       "Lelit"        { channel="boschshc:in-wall-switch:1:coffeemachine:power-switch" }

Or by adding them via UI: Settings -> Items -> "+".