From 1fbbb25662ab8fc23e8369d43739e0ec9676bdfa Mon Sep 17 00:00:00 2001 From: Christian Oeing Date: Mon, 1 Mar 2021 20:56:29 +0100 Subject: [PATCH 1/2] #83 Add info if a channel is writable to README.md Signed-off-by: Christian Oeing --- .../org.openhab.binding.boschshc/README.md | 64 +++++++++---------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/bundles/org.openhab.binding.boschshc/README.md b/bundles/org.openhab.binding.boschshc/README.md index c1568334794d7..5b439280ab39d 100644 --- a/bundles/org.openhab.binding.boschshc/README.md +++ b/bundles/org.openhab.binding.boschshc/README.md @@ -24,68 +24,68 @@ Binding for the Bosch Smart Home. **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 | ☑ | 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. | +| Channel Type ID | Item Type | Writable | 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. | +| Channel Type ID | Item Type | Writable | 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. | +| Channel Type ID | Item Type | Writable | 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). | +| Channel Type ID | Item Type | Writable | 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). | +| Channel Type ID | Item Type | Writable | 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. | +| Channel Type ID | Item Type | Writable | Description | +|----------------------|--------------------| :------: |-------------------------------| +| temperature | Number:Temperature | ☐ | Current measured temperature. | +| setpoint-temperature | Number:Temperature | ☑ | Desired temperature. | ## Limitations From fd8df7cc5d19590820b3f12c5ebaed5409722680 Mon Sep 17 00:00:00 2001 From: Christian Oeing Date: Mon, 1 Mar 2021 21:12:54 +0100 Subject: [PATCH 2/2] #84 Adjust/Add descriptions of supported devices Signed-off-by: Christian Oeing --- .../org.openhab.binding.boschshc/README.md | 28 ++++++++++++++----- .../lightcontrol/LightControlHandler.java | 2 +- .../motiondetector/MotionDetectorHandler.java | 3 +- .../shuttercontrol/ShutterControlHandler.java | 2 +- .../devices/twinguard/TwinguardHandler.java | 2 +- .../windowcontact/WindowContactHandler.java | 2 +- .../resources/OH-INF/thing/thing-types.xml | 13 +++++---- 7 files changed, 34 insertions(+), 18 deletions(-) diff --git a/bundles/org.openhab.binding.boschshc/README.md b/bundles/org.openhab.binding.boschshc/README.md index 5b439280ab39d..f5a7ca9b97aef 100644 --- a/bundles/org.openhab.binding.boschshc/README.md +++ b/bundles/org.openhab.binding.boschshc/README.md @@ -20,7 +20,9 @@ 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` @@ -30,7 +32,9 @@ Binding for the Bosch Smart Home. | power-consumption | Number:Power | ☐ | Current power consumption (W) of the device. | | energy-consumption | Number:Energy | ☐ | Energy consumption of the device. | -### Bosch TwinGuard smoke detector +### TwinGuard smoke detector + +The Twinguard smoke detector warns you in case of fire and constantly monitors the air. **Thing Type ID**: `twinguard` @@ -45,7 +49,9 @@ Binding for the Bosch Smart Home. | air-description | String | ☐ | Overall description of the air quality. | | combined-rating | String | ☐ | Combined rating of the air quality. | -### Bosch Window/Door contacts +### Door/Window contact + +Detects open windows and doors. **Thing Type ID**: `window-contact` @@ -53,7 +59,9 @@ Binding for the Bosch Smart Home. |-----------------|-----------| :------: |------------------------------| | contact | Contact | ☐ | Contact state of the device. | -### Bosch Motion Detector +### Motion Detector + +Detects every movement through an intelligent combination of passive infra-red technology and an additional temperature sensor. **Thing Type ID**: `motion-detector` @@ -61,7 +69,9 @@ Binding for the Bosch Smart Home. |-----------------|-----------| :------: |--------------------------------| | latest-motion | DateTime | ☐ | 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` @@ -69,7 +79,9 @@ Binding for the Bosch Smart Home. |-----------------|---------------| :------: |------------------------------------------| | level | Rollershutter | ☑ | Current open ratio (0 to 100, Step 0.5). | -### Bosch Thermostat +### Thermostat + +Radiator thermostat **Thing Type ID**: `thermostat` @@ -78,7 +90,9 @@ Binding for the Bosch Smart Home. | temperature | Number:Temperature | ☐ | Current measured temperature. | | valve-tappet-position | Number:Dimensionless | ☐ | Current open ratio of valve tappet (0 to 100). | -### Bosch Climate Control +### Climate Control + +A virtual device which controls up to six Bosch Smart Home radiator thermostats in a room. **Thing Type ID**: `climate-control` diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/lightcontrol/LightControlHandler.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/lightcontrol/LightControlHandler.java index 4b8123e4fcbcc..9825db8f43c94 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/lightcontrol/LightControlHandler.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/lightcontrol/LightControlHandler.java @@ -36,7 +36,7 @@ import org.openhab.core.types.State; /** - * Represents Bosch in-wall switches. + * A simple light control. * * @author Stefan Kästle - Initial contribution */ diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java index c1e21fb333b9e..a5dc356d5f7b4 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java @@ -25,7 +25,8 @@ import org.openhab.core.thing.Thing; /** - * MotionDetectorHandler + * Detects every movement through an intelligent combination of passive infra-red technology and an additional + * temperature sensor. * * @author Stefan Kästle - Initial contribution * @author Christian Oeing - Use service instead of custom logic diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/shuttercontrol/ShutterControlHandler.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/shuttercontrol/ShutterControlHandler.java index 6b54503744e20..3dc767b4e2216 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/shuttercontrol/ShutterControlHandler.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/shuttercontrol/ShutterControlHandler.java @@ -30,7 +30,7 @@ import org.openhab.core.types.Command; /** - * Handler for a shutter control device + * Control of your shutter to take any position you desire. * * @author Christian Oeing - Initial contribution */ diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/twinguard/TwinguardHandler.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/twinguard/TwinguardHandler.java index dc0bec18dc3e9..0b10500fce67e 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/twinguard/TwinguardHandler.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/twinguard/TwinguardHandler.java @@ -38,7 +38,7 @@ import org.openhab.core.thing.Thing; /** - * The {@link BoschTwinguardHandler} is responsible for handling commands for the TwinGuard handler. + * The Twinguard smoke detector warns you in case of fire and constantly monitors the air. * * @author Stefan Kästle - Initial contribution * @author Christian Oeing - Use service instead of custom logic diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/windowcontact/WindowContactHandler.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/windowcontact/WindowContactHandler.java index 90b978a20430d..502187e5ed409 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/windowcontact/WindowContactHandler.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/windowcontact/WindowContactHandler.java @@ -27,7 +27,7 @@ import org.openhab.core.types.State; /** - * The {@link BoschSHCHandler} is responsible for handling Bosch window/door contacts. + * Detects open windows and doors. * * @author Stefan Kästle - Initial contribution */ diff --git a/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml index 7c8a153ec6860..4bb66eea9ea78 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml @@ -18,7 +18,7 @@ - In-wall switch for light control + A simple light control. @@ -36,7 +36,7 @@ - TwinGuard environmental sensor + The Twinguard smoke detector warns you in case of fire and constantly monitors the air. @@ -58,8 +58,8 @@ - - Contact for windows and doors + + Detects open windows and doors. @@ -75,7 +75,8 @@ - Motion Detector + Detects every movement through an intelligent combination of passive infra-red technology and an + additional temperature sensor. @@ -91,7 +92,7 @@ - Shutter Control + Control of your shutter to take any position you desire.