Skip to content

Commit

Permalink
[boschshc] Parental Controls for Thermostats; Wall Thermostats; Inter…
Browse files Browse the repository at this point in the history
…nal refactoring (openhab#11134)

* Reduce debug output

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Added meta information for Bosch binding

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Set binding online only if fetching rooms and devices worked

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Replaced hard-coded IP address with configuration from things file

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fixes after rebasing on 2.5.x branch

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Put keystore where openhab user can access it

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Attempt to get a new subscription ID when the old one is invalidated

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Better install script

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Asynchronously get subscription ID

Otherwise, code would get stuck on requesting second subscription ID
Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Initial steps towards pairing

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Doesn't compile because of bouncycastle - compiles if commented out

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Bumped version

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Added basic support for multiple devices to support Twinguard

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Support for power meter in power switches + all values from Twinguard

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add window contact to the list of supported things

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Updated README to indicate new supported devices

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Added missing file

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Added motion detector thing

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* All devices support RefreshType now

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Cleanup - removed pairing related stuff that doesn't work

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fixed a weird bug where InWallSwitchHandler was not an instance of SHCHandler

Signed-off-by: Stefan Kaestle <stefan@mad-kow.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Update BoschSHCBridgeHandler.java

fixed HTTP request URL to get rooms from SHC

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add handler for Bosch Shutter Control to get and set its open level

Signed-off-by: Christian Oeing <christian.oeing@scalamat.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Auto update of .classpath by IDE

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Handle PercentType command to set a specific shutter level

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Put service name in constant instead of using it hard coded twice

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Refactor putState method of BoschSHCBridgeHandler

Remove unnecessary parts of the request like Gateway ID and put some general logic into separate methods to reuse them in other functions later

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Send operation state STOPPED to stop shutter from moving

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add shutter control to supported devices in README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add null reference check to avoid a NullReferenceException in ShutterControlHandler if device state couldn't be fetched

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add TemperatureLevelService

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add ThermostatHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add valve tappet position channel to thermostat via ValveTappet service

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add service registration for BoschSHCHandler, so the state updates are automatically calling the registered state update callback of the handler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add affectedChannels to service registration and handle RefreshType directly in BoschSHCHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Cleaned up DeviceStatusUpdate class

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added Bosch SHC certs

added public certificates from https://github.com/BoschSmartHome/bosch-shc-api-docs/tree/master/best_practice

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added pairing support

added support for keystore creation and pairing
documented the process in readme
refactoring of httpClient to take care of SSL context

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add RoomClimateControlService and ClimateControlHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Handle command to set setpoint temperature and move conversion from service state data to thing states into service state classes

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Remove unnecessary imports from ThermostatHandler.java

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Make new service and handler @NonNullByDefault

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Added comments for climate control service, handler and base service and handler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add missing comments on new classes and their methods

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Make registerService method of BoschSHCHandler private and adjust usages

Derived handlers should use createService instead.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Throw an error instead of returning null for method getBridgeHandler of BoschSHCHandler

This allows for fewer null checks after the initialization of a handler.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add @author tags in JavaDoc of new classes

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Ran mvn spotless:apply to apply correct code formatting

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fixed missing imports in BoschSHCService.java

This was caused by a too quick merge of me.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fixed warnings about null annotations

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add @NonNullByDefault to all handlers

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added license header by executing mvn license:format

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #16 Adjust logger usages to not be too verbose

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #10 Remove obsolete parse-things.py script

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #29 Remove dev scripts install.sh and run.sh scripts

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added author name to each class comment

Added the author(s) and small comment to each class based on the git
history and if necessary created the basis class comment body.

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added license header for new files

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* run mvn spotless check/apply

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #24 Catch error response when trying to get state of a service of a device and throw specific error instead of returning invalid state object

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #24 Run mvn spotless:apply and mvn license:format to respect coding guidelines

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #5 Update README.md with up-to-date information about the setup of the binding

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #31 Typo in README.md

Co-authored-by: Gerd Zanker <gerd.zanker@web.de>
Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add detailed description of the system password to provide in README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Co-authored-by: Gerd Zanker <gerd.zanker@web.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fix non-initialized member of @NonNullByDefault class ValveTappetServiceState

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #7 Moved each device to a separate subfolder inside devices folder

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #44 Adjust version of org.openhab.addons.reactor.bundles to 2.5.9-SNAPSHOT in pom.xml

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #45 Increase year in copyright headers

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #45 Remove several obsolete loggers and fix logging of exceptions

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #45 Fixed some code analysis warnings

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #45 Ran mvn spotless:apply

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #45 Revert adding @NonNullByDefault to BoschSHCConfiguration

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #47 Fixed code analysis warnings

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* updated text files based on pull request feedback

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Apply suggestions from code review

Applied only suggested string text changes and few trivial code changes

Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Improved comments and changed visibility

code review findings improved related to code comments
and public/private visibility of variables
removed example properties file and class path entries

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added @NonNullByDefault annotation where necessary and easy possible

in addition minor improvements like
removed TODO for code refactoring
used BoschSHCException instead of Error in one place
Renamed internal Error class to ErroInfo
ran spotless:apply

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* use SIUnits

replaced all Celcius units with eclipse SIUnits

Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* change logging and GSON related code

increased many log levels
avoid creating new GSON instances in derived handler subclasses
changed catch code to avoid stack trace dumps

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add @NonNullByDefault to BoschSHCConfiguration class and remove obsolete usages of configuration in handlers

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Throw BoschSHCExceptions instead of generic Errors and handle them during creation of services

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use Class::new supplier function instead of deprecated Class.newInstance() method

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Remove @NonNullByDefault from inner classes and unused logger member to remove compile warnings

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use Base64.getEncoder().encodeToString instead of Base64.getEncoder().encode and a manual conversion to String

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add @NonNullByDefault annotation to BoschSHCBridgeConfiguration and check for empty password and ip address in configuration

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use try-with-resources to auto-close streams for key store creation

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Move data transfer objects of bridge into dto folder

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add thing type ids and channel type ids to README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Move thing configurations out of thing-types.xml and into configs.xml. Remove deprecated required element and use attribute instead.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Adjust some elements, units, descriptions and labels in configs.xml and thing-types.xml

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Move url and request creation from BoschSHCBridgeHandler to BoschHttpClient to reuse it inside BoschHttpClient

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add default timeout to request to smart home controller

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Make httpClient of BoschSHCBridgeHandler @nullable and use BoschHttpClient createUrl and createRequest methods where possible

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Make gson field in BoschSHCBridgeHandler final

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Simplify getDevices method of BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use getContentAsString() instead of getContent() plus manual conversion to String

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use instanceof instead of isInstance(...) in BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add registerService method to BoschSHCHandler to register already created services, so they can be created in the constructor of a handler and do not have to be @nullable

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Using simpler String.format instead of MessageFormatter in BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Move ShutterControlState into dto subfolder and remove @NonNullByDefault annotation

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Make bridgeHandler and deviceId in BoschSHCService @nullable

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Move DTOs in dto subfolders and remove @NonNullByDefault annotations from them

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add texts for errors during initialization of bridge

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Migrate PowerSwitch to new service architecture to get rid of BoschSHCBridgeHandler.updateSwitchState

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Remove obsolete null parameter from subscription request

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Removed obsolete TODO about hard-coded data which does not exist anymore

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use lambda for response handling of long poll

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Remove obsolete @nonnull annotations in BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Throw http exceptions when trying to request state from a device to set the thing to offline

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Add state options for combined-rating, temperature-rating and humidity-rating channels

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fix several minor static code analysis warnings

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Added migration artifacts

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fix formatting and increase version number

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* fix HTTP client issue, improve connection logging, add Developers markdown

the HTTPClient requests were broken
updated exception handling and logging for connection and pairing
describing source of certificates

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use service for shutter control handling instead of having the logic inside the ShutterControlHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #47 Fix code formatting to remove code analysis warnings

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fixed pairing

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Fixed long poll

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Move common error handling for parsing responses from BoschHttpClient into sendRequest method to make subscribe request logic clearer

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use scheduler.schedule instead of Thread.sleep during long polling

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Using synchronous request for subscribe request

The initialization is not finished without a successful subscription.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use synchronous long poll request to get it to work

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Make long polling asynchronous to not block scheduler threads

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Only scheduling new long polls while bridge is not disposed and aborting long polling on disposal

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Move long polling logic into separate class

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Make long polling requests synchronous again, the asynchronous way still does not receive any state updates

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* replaced while loop for pairing with scheduler calls

Pattern from LongPolling reused.
Scheduling new initial access checks including pairing every 15 seconds until it was successful and long polling can be started

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #47 Throw BoschSHCException instead of raw error to avoid code analysis warning

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #47 Remove TODO from code and add issue #55 instead

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #47 Pass non-null httpClient to bridge initialization instead of having to check for null reference

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Use one supportsThingTypes mapping to list the supported things with their handler in BoschSHCHandlerFactory

Previously an array plus a big switch was required.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #47 Starting http client before scheduling initial access

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Use logger.debug instead of logger.info

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Co-authored-by: Connor Petty <mistercpp2000@gmail.com>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* Include cause exception in the PairingFailedException

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Co-authored-by: Connor Petty <mistercpp2000@gmail.com>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Move fields above constructor in BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove obsolete configuration field from BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Move fields and constructor in JsonRpcRequest to top of the class

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Log the failure of a long poll as warning instead of error

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Use %s instead of {} as placeholder for String.format

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Move @nullable annotation in front of field name

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Specify UTF_8 as charset to convert string to byte array

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove spaces from pem files

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Change ArrayList to List in Device.java

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Use QuantityType for power and energy consumption of the in-wall switch handler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Check if StopMoveType is STOP in ShutterControlHandler before setting the device state

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Make fields of DeviceService final

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Stop http client and cancel scheduled pairing on bridge disposal

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove channel check in BoschTwinguardHandler for Refresh command

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Add exception message to warning when update in BoschTwinguardHandler and WindowContactHandler returns incorrect state

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Add additional information about channels to thing-types.xml and README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove confusing comment from LongPolling.subscribe method

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Removed obsolete error log in LongPolling.subscribe

A warning is already logged in BoschBridgeHandler when an exception occurs

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Add detailed description for purity channel

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Fix typo in DEVELOPERS.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Change scheduledPairing field in BoschSHCBridgeHandler to be @nullable

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Change type of channel values from DecimalType to QuantityType in BoschTwinguardHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove obsolete .classpath and .project files

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Fixed typo in DEVELOPERS.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Only log error message instead of whole stack trace in BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove exception which is not thrown and typo in BoschSslUtil

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Use SmartHomeUnits instead of AbstractUnit in BoschTwinguardHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Added supported-bridge-type-refs to thing-types.xml

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove invalid whitespace from thing-types.xml

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Fixed warnings and errors caused by updated Gson library

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Update info about auto reload of bundle jar in DEVELOPERS.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Update information about adding items and things via UI, added missing password configuration value and changed headline in README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Execute long polling requests asynchronous to not block a thread

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Refactored WindowContactHandler to use ShutterContactService instead of implementing service logic itself

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove obsolete .gitignore. The ignored files are already ignored by the root .gitignore

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Rename constant supportsThingTypes to SUPPORTED_THING_TYPES in BoschSHCHandlerFactory

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Use List.of instead of Arrays.asList

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Call super.dispose last in BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Add exception message to status when http connection to controller fails

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Handle JsonSyntaxException in BoschHttpClient.sendRequest

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Forward InterruptedExceptions to callers, so they have to be handled correctly

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Logging long poll error message and code instead of hash

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Throwing InterruptedException during pairing instead of only logging it

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Move nested class AbortLongPolling to end of LongPolling class

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Make gson instance static final in BoschHttpClient

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Rename gson to GSON and make it static final in BoschSHCHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Remove @nullable annotations from GSON-created objects

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Add causing exception to ExecutionException in BoschHttpClient.sendRequest

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #14 Add JsonSyntaxException to definition of processUpdate in BoschTwinguardHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* fixed keyStore creation

Moved PEM files into expected folder according to package

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* moved final fields above non-final fields

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* updated copyright year in header by executing mvn license:format

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* fixed last two pending warnings

added back the removed @nullable annotation in sendRequest()
replaced deprecated SslContextFactory constructor call

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added Bouncy Castle third-party license info into NOTICE

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* changed Bouncy Castle version to same version as  currently used in org.openhab.core.io.jetty.certificate to later reduce download size

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #62 Correctly check if long poll response is valid

GSON will not return null if there is no "result" field, but will just set the "result" member to null.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* Add @NonNullByDefault annotation to LongPollResultTest class and fix method name

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* added first unittests for BoschSslUtil class

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added next unittests for BoschHttpClient class

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #55 replaced the password with a fixed one

The changeable SHC system password for the keystore is replaced by a static string in the code.
The keyStore name is now based on SHC ipAddress to support multiple SmartHomeControllers.

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #72 changed use units of measure for the twinguard humidity and purity values

all other QuantityTypes in bindingcode are fine

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #77 changed title of binding to Bosch Smart Home

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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #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.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Co-authored-by: Gerd Zanker <gerd.zanker@web.de>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #78 defined api-version

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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* logging bundle version

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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #72 changed use units of measure for the twinguard humidity and purity values

all other QuantityTypes in bindingcode are fine

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #77 changed title of binding to Bosch Smart Home

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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #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.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>
Co-authored-by: Gerd Zanker <gerd.zanker@web.de>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

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

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #78 defined api-version

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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* logging bundle version

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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #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

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* added newline

Signed-off-by: Gerd Zanker <gerd.zanker@web.de>

* #46 Rename BoschInWallSwitchHandler, BoschTwinguardHandler, BoschSHCBridgeConfiguration and BoschSHCBridgeHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #46 Adjust descriptions of things

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #40 Use LatestMotionService in MotionDetectorHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #40 Use service instead of custom logic in BoschTwinguardHandler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #40 Add PowerMeterService to use in InWallSwitchHandler instead of having the logic directly in the handler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #40 Rename InWallSwitchHandler to LightControlHandler

This is the official name in the Bosch API documentation, so we should use it as well (https://apidocs.bosch-smarthome.com/local)

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #34 Get device info on thing initialization to check if device exists

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #34 Use generic sendRequest method of http client to have consistent error handling

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #34 Fix formatting error when logging device info

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #83 Add info if a channel is writable to README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #84 Adjust/Add descriptions of supported devices

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #25 Add humidity level service and wall thermostat handler

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #25 Add wall thermostat handler to handler factory

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #66 Check type of service state when received by bridge to make sure that it has the expected type

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #41 Add child lock service to Thermostat handler and link its state to a "child-lock" channel

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* Add null check in BoschSHCServiceState.isValid

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #41 Use custom channel type for child-lock. Handle setting child lock state.

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #101 Store expected state type inside a member instead of a static variable

The static variable was stored in the base class, so it was only initialized once even for different state types

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #63 Use better identifier for thing that is missing a (valid) bridge

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #108 Add changelog to README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #109 Catch possible null pointer exception in long poll response handling

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* Fix potential null pointer access

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* Fix static code analysis error and 2 warnings

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #111 Remove changelog from README.md

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

* #112 Remove JSON from logs

Signed-off-by: Christian Oeing <christian.oeing@slashgames.org>

Co-authored-by: Stefan Kaestle <stefan@mad-kow.de>
Co-authored-by: Gerd Zanker <gerd.zanker@web.de>
Co-authored-by: Christian Oeing <christian.oeing@scalamat.de>
Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Co-authored-by: Connor Petty <mistercpp2000@gmail.com>
  • Loading branch information
7 people authored Oct 30, 2021
1 parent a7ec511 commit cc6bc1b
Show file tree
Hide file tree
Showing 38 changed files with 965 additions and 328 deletions.
122 changes: 76 additions & 46 deletions bundles/org.openhab.binding.boschshc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@
Binding for the Bosch Smart Home.

- [Bosch Smart Home Binding](#bosch-smart-home-binding)
- [Changelog](#changelog)
- [Supported Things](#supported-things)
- [Bosch In-Wall switches & Bosch Smart Plugs](#bosch-in-wall-switches--bosch-smart-plugs)
- [Bosch TwinGuard smoke detector](#bosch-twinguard-smoke-detector)
- [Bosch Window/Door contacts](#bosch-windowdoor-contacts)
- [Bosch Motion Detector](#bosch-motion-detector)
- [Bosch Shutter Control in-wall](#bosch-shutter-control-in-wall)
- [Bosch Thermostat](#bosch-thermostat)
- [Bosch Climate Control](#bosch-climate-control)
- [In-Wall switches & Smart Plugs](#in-wall-switches--smart-plugs)
- [TwinGuard smoke detector](#twinguard-smoke-detector)
- [Door/Window contact](#doorwindow-contact)
- [Motion Detector](#motion-detector)
- [Shutter Control](#shutter-control)
- [Thermostat](#thermostat)
- [Climate Control](#climate-control)
- [Wall Thermostat](#wall-thermostat)
- [Limitations](#limitations)
- [Discovery](#discovery)
- [Bridge Configuration](#bridge-configuration)
Expand All @@ -20,72 +22,98 @@ Binding for the Bosch Smart Home.

## Supported Things

### Bosch In-Wall switches & Bosch Smart Plugs
### In-Wall switches & Smart Plugs

A simple light control.

**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. |
| Channel Type ID | Item Type | Writable | Description |
| ------------------ | ------------- | :------: | -------------------------------------------- |
| power-switch | Switch | &#9745; | Current state of the switch. |
| power-consumption | Number:Power | &#9744; | Current power consumption (W) of the device. |
| energy-consumption | Number:Energy | &#9744; | Energy consumption of the device. |

### TwinGuard smoke detector

### Bosch TwinGuard smoke detector
The Twinguard smoke detector warns you in case of fire and constantly monitors the air.

**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. |
| Channel Type ID | Item Type | Writable | Description |
| ------------------ | -------------------- | :------: | ------------------------------------------------------------------------------------------------- |
| temperature | Number:Temperature | &#9744; | Current measured temperature. |
| temperature-rating | String | &#9744; | Rating of the currently measured temperature. |
| humidity | Number:Dimensionless | &#9744; | Current measured humidity (0 to 100). |
| humidity-rating | String | &#9744; | Rating of current measured humidity. |
| purity | Number:Dimensionless | &#9744; | Purity of the air (ppm). Range from 500 to 5500 ppm. A higher value indicates a higher pollution. |
| purity-rating | String | &#9744; | Rating of current measured purity. |
| air-description | String | &#9744; | Overall description of the air quality. |
| combined-rating | String | &#9744; | Combined rating of the air quality. |

### Bosch Window/Door contacts
### Door/Window contact

Detects open windows and doors.

**Thing Type ID**: `window-contact`

| Channel Type ID | Item Type | Description |
|-----------------|-----------|------------------------------|
| contact | Contact | Contact state of the device. |
| Channel Type ID | Item Type | Writable | Description |
| --------------- | --------- | :------: | ---------------------------- |
| contact | Contact | &#9744; | Contact state of the device. |

### Motion Detector

### Bosch Motion Detector
Detects every movement through an intelligent combination of passive infra-red technology and an additional temperature sensor.

**Thing Type ID**: `motion-detector`

| Channel Type ID | Item Type | Description |
|-----------------|-----------|--------------------------------|
| latest-motion | DateTime | The date of the latest motion. |
| Channel Type ID | Item Type | Writable | Description |
| --------------- | --------- | :------: | ------------------------------ |
| latest-motion | DateTime | &#9744; | The date of the latest motion. |

### Bosch Shutter Control in-wall
### Shutter Control

Control of your shutter to take any position you desire.

**Thing Type ID**: `shutter-control`

| Channel Type ID | Item Type | Description |
|-----------------|---------------|------------------------------------------|
| level | Rollershutter | Current open ratio (0 to 100, Step 0.5). |
| Channel Type ID | Item Type | Writable | Description |
| --------------- | ------------- | :------: | ---------------------------------------- |
| level | Rollershutter | &#9745; | Current open ratio (0 to 100, Step 0.5). |

### Thermostat

### Bosch Thermostat
Radiator 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). |
| Channel Type ID | Item Type | Writable | Description |
| --------------------- | -------------------- | :------: | ---------------------------------------------- |
| temperature | Number:Temperature | &#9744; | Current measured temperature. |
| valve-tappet-position | Number:Dimensionless | &#9744; | Current open ratio of valve tappet (0 to 100). |
| child-lock | Switch | &#9745; | Indicates if child lock is active. |

### Climate Control

### Bosch Climate Control
A virtual device which controls up to six Bosch Smart Home radiator thermostats in a room.

**Thing Type ID**: `climate-control`

| Channel Type ID | Item Type | Description |
|----------------------|--------------------|-------------------------------|
| temperature | Number:Temperature | Current measured temperature. |
| setpoint-temperature | Number:Temperature | Desired temperature. |
| Channel Type ID | Item Type | Writable | Description |
| -------------------- | ------------------ | :------: | ----------------------------- |
| temperature | Number:Temperature | &#9744; | Current measured temperature. |
| setpoint-temperature | Number:Temperature | &#9745; | Desired temperature. |

### Wall Thermostat

Display of the current room temperature as well as the relative humidity in the room.

**Thing Type ID**: `wall-thermostat`

| Channel Type ID | Item Type | Writable | Description |
| --------------- | -------------------- | :------: | ------------------------------------- |
| temperature | Number:Temperature | &#9744; | Current measured temperature. |
| humidity | Number:Dimensionless | &#9744; | Current measured humidity (0 to 100). |

## Limitations

Expand All @@ -112,9 +140,11 @@ This certificate is used for pairing between the Bridge and the Bosch Smart Home
Bosch IDs for found devices are displayed in the openHAB log on bootup (`OPENHAB_FOLDER/userdata/logs/openhab.log`)

The log can also be called using the following command.

```
tail -f /var/log/openhab/openhab.log /var/log/openhab/events.log
```

Alternatively, the log can be viewed using the OpenHab Log Viewer (frontail) via http://openhab:9001.

Example:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
*
* @author Stefan Kästle - Initial contribution
* @author Christian Oeing - added Shutter Control, ThermostatHandler
* @author Christian Oeing - Added WallThermostatHandler
*/
@NonNullByDefault
public class BoschSHCBindingConstants {
Expand All @@ -37,6 +38,7 @@ public class BoschSHCBindingConstants {
public static final ThingTypeUID THING_TYPE_SHUTTER_CONTROL = new ThingTypeUID(BINDING_ID, "shutter-control");
public static final ThingTypeUID THING_TYPE_THERMOSTAT = new ThingTypeUID(BINDING_ID, "thermostat");
public static final ThingTypeUID THING_TYPE_CLIMATE_CONTROL = new ThingTypeUID(BINDING_ID, "climate-control");
public static final ThingTypeUID THING_TYPE_WALL_THERMOSTAT = new ThingTypeUID(BINDING_ID, "wall-thermostat");

// List of all Channel IDs
// Auto-generated from thing-types.xml via script, don't modify
Expand All @@ -56,4 +58,5 @@ public class BoschSHCBindingConstants {
public static final String CHANNEL_LEVEL = "level";
public static final String CHANNEL_VALVE_TAPPET_POSITION = "valve-tappet-position";
public static final String CHANNEL_SETPOINT_TEMPERATURE = "setpoint-temperature";
public static final String CHANNEL_CHILD_LOCK = "child-lock";
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.boschshc.internal.devices.bridge.BoschSHCBridgeHandler;
import org.openhab.binding.boschshc.internal.devices.bridge.BridgeHandler;
import org.openhab.binding.boschshc.internal.exceptions.BoschSHCException;
import org.openhab.binding.boschshc.internal.services.BoschSHCService;
import org.openhab.binding.boschshc.internal.services.dto.BoschSHCServiceState;
Expand Down Expand Up @@ -117,16 +117,34 @@ public BoschSHCHandler(Thing thing) {
*/
@Override
public void initialize() {
this.config = getConfigAs(BoschSHCConfiguration.class);
var config = this.config = getConfigAs(BoschSHCConfiguration.class);

String deviceId = config.id;
if (deviceId == null || deviceId.isEmpty()) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR,
"@text/offline.conf-error.empty-device-id");
return;
}

// Try to get device info to make sure the device exists
try {
this.initializeServices();
var bridgeHandler = this.getBridgeHandler();
var info = bridgeHandler.getDeviceInfo(deviceId);
logger.trace("Device initialized:\n{}", info.toString());
} catch (InterruptedException | TimeoutException | ExecutionException | BoschSHCException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
return;
}

// Mark immediately as online - if the bridge is online, the thing is too.
this.updateStatus(ThingStatus.ONLINE);
// Initialize device services
try {
this.initializeServices();
} catch (BoschSHCException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, e.getMessage());
return;
}

this.updateStatus(ThingStatus.ONLINE);
}

/**
Expand All @@ -142,18 +160,7 @@ public void handleCommand(ChannelUID channelUID, Command command) {
// Refresh state of services that affect the channel
for (DeviceService<? extends BoschSHCServiceState> deviceService : this.services) {
if (deviceService.affectedChannels.contains(channelUID.getIdWithoutGroup())) {
try {
deviceService.service.refreshState();
} catch (TimeoutException | ExecutionException | BoschSHCException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR,
String.format("Error when trying to refresh state from service %s: %s",
deviceService.service.getServiceName(), e.getMessage()));
} catch (InterruptedException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR,
String.format("Interrupted refresh state from service %s: %s",
deviceService.service.getServiceName(), e.getMessage()));
Thread.currentThread().interrupt();
}
this.refreshServiceState(deviceService.service);
}
}
}
Expand Down Expand Up @@ -187,14 +194,16 @@ protected void initializeServices() throws BoschSHCException {
* @return Bridge handler for this thing handler. Null if no or an invalid bridge was set in the configuration.
* @throws BoschSHCException If bridge for handler is not set or an invalid bridge is set.
*/
protected BoschSHCBridgeHandler getBridgeHandler() throws BoschSHCException {
protected BridgeHandler getBridgeHandler() throws BoschSHCException {
Bridge bridge = this.getBridge();
if (bridge == null) {
throw new BoschSHCException(String.format("No valid bridge set for %s", this.getThing()));
throw new BoschSHCException(String.format("No valid bridge set for %s (%s)", this.getThing().getLabel(),
this.getThing().getUID().getAsString()));
}
BoschSHCBridgeHandler bridgeHandler = (BoschSHCBridgeHandler) bridge.getHandler();
BridgeHandler bridgeHandler = (BridgeHandler) bridge.getHandler();
if (bridgeHandler == null) {
throw new BoschSHCException(String.format("Bridge of %s has no valid bridge handler", this.getThing()));
throw new BoschSHCException(String.format("Bridge of %s (%s) has no valid bridge handler",
this.getThing().getLabel(), this.getThing().getUID().getAsString()));
}
return bridgeHandler;
}
Expand All @@ -213,7 +222,7 @@ protected BoschSHCBridgeHandler getBridgeHandler() throws BoschSHCException {
return null;
}
try {
BoschSHCBridgeHandler bridgeHandler = this.getBridgeHandler();
BridgeHandler bridgeHandler = this.getBridgeHandler();
return bridgeHandler.getState(deviceId, stateName, classOfT);
} catch (TimeoutException | ExecutionException | BoschSHCException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR,
Expand Down Expand Up @@ -264,7 +273,7 @@ protected <TService extends BoschSHCService<TState>, TState extends BoschSHCServ
protected <TService extends BoschSHCService<TState>, TState extends BoschSHCServiceState> void registerService(
TService service, Consumer<TState> stateUpdateListener, Collection<String> affectedChannels)
throws BoschSHCException {
BoschSHCBridgeHandler bridgeHandler = this.getBridgeHandler();
BridgeHandler bridgeHandler = this.getBridgeHandler();

String deviceId = this.getBoschID();
if (deviceId == null) {
Expand Down Expand Up @@ -299,6 +308,54 @@ protected <TService extends BoschSHCService<TState>, TState extends BoschSHCServ
}
}

/**
* Lets a service handle a received command.
* Sets the status of the device to offline if handling the command fails.
*
* @param <TService> Type of service.
* @param <TState> Type of service state.
* @param service Service which should handle command.
* @param command Command to handle.
*/
protected <TService extends BoschSHCService<TState>, TState extends BoschSHCServiceState> void handleServiceCommand(
TService service, Command command) {
try {
if (command instanceof RefreshType) {
this.refreshServiceState(service);
} else {
TState state = service.handleCommand(command);
this.updateServiceState(service, state);
}
} catch (BoschSHCException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR,
String.format("Error when service %s should handle command %s: %s", service.getServiceName(),
command.getClass().getName(), e.getMessage()));
}
}

/**
* Requests a service to refresh its state.
* Sets the device offline if request fails.
*
* @param <TService> Type of service.
* @param <TState> Type of service state.
* @param service Service to refresh state for.
*/
private <TService extends BoschSHCService<TState>, TState extends BoschSHCServiceState> void refreshServiceState(
TService service) {
try {
service.refreshState();
} catch (TimeoutException | ExecutionException | BoschSHCException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR,
String.format("Error when trying to refresh state from service %s: %s", service.getServiceName(),
e.getMessage()));
} catch (InterruptedException e) {
this.updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.OFFLINE.COMMUNICATION_ERROR, String
.format("Interrupted refresh state from service %s: %s", service.getServiceName(), e.getMessage()));
Thread.currentThread().interrupt();
}
}

/**
* Registers a service of this device.
*
Expand Down
Loading

0 comments on commit cc6bc1b

Please sign in to comment.