public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Documentation] Markdown improvements for bindings a to e (#13859)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-07 21:09:32 +01:00
committed by GitHub
parent 72efc1cfed
commit caf71f72e6
86 changed files with 1740 additions and 1822 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
bundles/org.openhab.binding.boschshc/DEVELOPERS.md
View File

@@ -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.