[Documentation] Markdown improvements for bindings a to e (#13859)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
committed by
GitHub
parent
72efc1cfed
commit
caf71f72e6
@@ -4,11 +4,13 @@
|
||||
|
||||
To only build the Bosch Smart Home binding code execute
|
||||
|
||||
mvn -pl :org.openhab.binding.boschshc install
|
||||
```shell
|
||||
mvn -pl :org.openhab.binding.boschshc install
|
||||
```
|
||||
|
||||
## Execute
|
||||
|
||||
After compiling a new ``org.openhab.binding.boschshc.jar``
|
||||
After compiling a new ``org.openhab.binding.boschshc.jar``
|
||||
copy it into the ``addons`` folder of your openHAB test instance.
|
||||
|
||||
For the first time the jar is loaded automatically as a bundle.
|
||||
@@ -17,26 +19,37 @@ It should also be reloaded automatically when the jar changed.
|
||||
|
||||
To reload the bundle manually you need to execute in the openhab console:
|
||||
|
||||
bundle:update "openHAB Add-ons :: Bundles :: Bosch Smart Home Binding"
|
||||
|
||||
```shell
|
||||
bundle:update "openHAB Add-ons :: Bundles :: Bosch Smart Home Binding"
|
||||
```
|
||||
|
||||
or get the ID and update the bundle using the ID:
|
||||
|
||||
bundle:list
|
||||
-> Get ID for "openHAB Add-ons :: Bundles :: Bosch Smart Home Binding"
|
||||
bundle:update <ID>
|
||||
|
||||
```shell
|
||||
bundle:list
|
||||
```
|
||||
|
||||
-> Get ID for "openHAB Add-ons :: Bundles :: Bosch Smart Home Binding"
|
||||
|
||||
```shell
|
||||
bundle:update <ID>
|
||||
```
|
||||
|
||||
## Debugging
|
||||
|
||||
To get debug output and traces of the Bosch Smart Home binding code
|
||||
add the following lines into ``userdata/etc/log4j2.xml`` Loggers XML section.
|
||||
add the following lines into ``userdata/etc/log4j2.xml`` Loggers XML section.
|
||||
|
||||
<!-- Bosch SHC for debugging -->
|
||||
<Logger level="TRACE" name="org.openhab.binding.boschshc"/>
|
||||
```xml
|
||||
<!-- Bosch SHC for debugging -->
|
||||
<Logger level="TRACE" name="org.openhab.binding.boschshc"/>
|
||||
```
|
||||
|
||||
or use the openhab console to change the log level
|
||||
|
||||
log:set TRACE org.openhab.binding.boschshc
|
||||
```shell
|
||||
log:set TRACE org.openhab.binding.boschshc
|
||||
```
|
||||
|
||||
## Pairing and Certificates
|
||||
|
||||
@@ -47,10 +60,10 @@ Read more about the pairing process in [register a new client to the bosch smart
|
||||
A precondition for the secured connection to the Bosch SHC is a self singed key + certificate.
|
||||
The key + certificate will be created and stored with the public Bosch SHC certificates in a Java Key store (jks).
|
||||
|
||||
The public certificates files are from https://github.com/BoschSmartHome/bosch-shc-api-docs/tree/master/best_practice.
|
||||
The public certificates files are from <https://github.com/BoschSmartHome/bosch-shc-api-docs/tree/master/best_practice>.
|
||||
File copies stored in ``src/main/resource``.
|
||||
|
||||
All three certificates and the key will be used for the HTTPS connection between
|
||||
this openHAB binding and the Bosch SHC.
|
||||
|
||||
During pairing the openHAB binding will exchange the self singed certificate with SHC.
|
||||
During pairing the openHAB binding will exchange the self singed certificate with SHC.
|
||||
|
||||
@@ -7,7 +7,7 @@ Binding for the Bosch Smart Home.
|
||||
- [In-Wall Switch](#in-wall-switch)
|
||||
- [Compact Smart Plug](#compact-smart-plug)
|
||||
- [Twinguard Smoke Detector](#twinguard-smoke-detector)
|
||||
- [Door/Window Contact](#door-window-contact)
|
||||
- [Door/Window Contact](#doorwindow-contact)
|
||||
- [Motion Detector](#motion-detector)
|
||||
- [Shutter Control](#shutter-control)
|
||||
- [Thermostat](#thermostat)
|
||||
@@ -209,7 +209,7 @@ The system password is set by you during your initial registration steps in the
|
||||
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*.
|
||||
_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
|
||||
|
||||
@@ -217,15 +217,15 @@ Bosch IDs for found devices are displayed in the openHAB log on bootup (`OPENHAB
|
||||
|
||||
The log can also be called using the following command.
|
||||
|
||||
```
|
||||
```bash
|
||||
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.
|
||||
Alternatively, the log can be viewed using the OpenHab Log Viewer (frontail) via <http://openhab:9001>.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
```bash
|
||||
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
|
||||
@@ -245,7 +245,7 @@ Example:
|
||||
|
||||
You define your Bosch devices by adding them either to a `.things` file in your `$OPENHAB_CONF/things` folder like this:
|
||||
|
||||
```
|
||||
```java
|
||||
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" ]
|
||||
@@ -269,7 +269,7 @@ Or by adding them via UI: Settings -> Things -> "+" -> Bosch Smart Home Binding.
|
||||
|
||||
You define the items which should be linked to your Bosch devices via a `.items` file in your `$OPENHAB_CONF/items` folder like this:
|
||||
|
||||
```
|
||||
```java
|
||||
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" }
|
||||
|
||||
Reference in New Issue
Block a user