Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.md improvements #93

Merged
merged 2 commits into from
Mar 2, 2021
Merged

README.md improvements #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fbbb25
#83 Add info if a channel is writable to README.md
coeing Mar 1, 2021
fd8df7c
#84 Adjust/Add descriptions of supported devices
coeing Mar 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 53 additions & 39 deletions bundles/org.openhab.binding.boschshc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,72 +20,86 @@ 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 | ☑ | 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. |

### 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 | ☐ | 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
### 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 | ☐ | 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 | ☐ | 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 | ☑ | 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 | ☐ | Current measured temperature. |
| valve-tappet-position | Number:Dimensionless | ☐ | Current open ratio of valve tappet (0 to 100). |

### 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 | ☐ | Current measured temperature. |
| setpoint-temperature | Number:Temperature | ☑ | Desired temperature. |

## Limitations

Expand Down
2 changes: 1 addition & 1 deletion .../java/org/openhab/binding/boschshc/internal/devices/lightcontrol/LightControlHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
3 changes: 2 additions & 1 deletion ...a/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ...a/org/openhab/binding/boschshc/internal/devices/shuttercontrol/ShutterControlHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
2 changes: 1 addition & 1 deletion ...c/main/java/org/openhab/binding/boschshc/internal/devices/twinguard/TwinguardHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ...ava/org/openhab/binding/boschshc/internal/devices/windowcontact/WindowContactHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
13 changes: 7 additions & 6 deletions bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
</supported-bridge-type-refs>

<label>In-wall Switch</label>
<description>In-wall switch for light control</description>
<description>A simple light control.</description>

<channels>
<channel id="power-switch" typeId="system.power"/>
Expand All @@ -36,7 +36,7 @@
</supported-bridge-type-refs>

<label>TwinGuard</label>
<description>TwinGuard environmental sensor</description>
<description>The Twinguard smoke detector warns you in case of fire and constantly monitors the air.</description>

<channels>
<channel id="temperature" typeId="temperature"/>
Expand All @@ -58,8 +58,8 @@
<bridge-type-ref id="shc"/>
</supported-bridge-type-refs>

<label>Window/Door Contact</label>
<description>Contact for windows and doors</description>
<label>Door/Window Contact</label>
<description>Detects open windows and doors.</description>

<channels>
<channel id="contact" typeId="contact"/>
Expand All @@ -75,7 +75,8 @@
</supported-bridge-type-refs>

<label>Motion Detector</label>
<description>Motion Detector</description>
<description>Detects every movement through an intelligent combination of passive infra-red technology and an
additional temperature sensor.</description>

<channels>
<channel id="latest-motion" typeId="latest-motion"/>
Expand All @@ -91,7 +92,7 @@
</supported-bridge-type-refs>

<label>Shutter Control</label>
<description>Shutter Control</description>
<description>Control of your shutter to take any position you desire.</description>

<channels>
<channel id="level" typeId="level"/>
Expand Down