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

[Documentation] Markdown improvements n to s (#13948)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-14 16:52:43 +01:00
committed by GitHub
parent d73218d882
commit 1ca9baf157
106 changed files with 4506 additions and 4729 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
bundles/org.openhab.binding.opengarage/README.md
View File

@@ -1,25 +1,24 @@
# OpenGarage Binding
The OpenGarage binding allows you to control an OpenGarage controller (https://opensprinkler.com/product/opengarage/) using openHAB
The OpenGarage binding allows you to control an OpenGarage controller (<https://opensprinkler.com/product/opengarage/>) using openHAB
## Supported Things
Opengarage controllers from https://opensprinkler.com/product/opengarage/ are supported.
Opengarage controllers from <https://opensprinkler.com/product/opengarage/> are supported.
## Discovery
Auto-discover is not currently supported.
Auto-discover is not currently supported.
You need to manually add a new item using its IP address.
## Thing Configuration
As a minimum, the IP address is needed:
* hostname - The hostname of the OpenGarage controller. Typically you'd use an IP address such as `192.168.0.5` for this field.
* port - the port the OpenGarage is listening on. Defaults to port 80
* refresh - The frequency with which to refresh information from the OpenGarage controller specified in seconds. Defaults to 10 seconds.
* password - The password to send commands to the OpenGarage. Defaults to "opendoor"
- `hostname` - The hostname of the OpenGarage controller. Typically you'd use an IP address such as `192.168.0.5` for this field.
- `port` - the port the OpenGarage is listening on. Defaults to port 80
- `refresh` - The frequency with which to refresh information from the OpenGarage controller specified in seconds. Defaults to 10 seconds.
- `password` - The password to send commands to the OpenGarage. Defaults to "opendoor"
## Channels
@@ -35,13 +34,13 @@ As a minimum, the IP address is needed:
opengarage.things:
```
```java
opengarage:opengarage:OpenGarage [ hostname="192.168.0.5" ]
```
opengarage.items:
```
```java
Switch OpenGarage_Status { channel="opengarage:opengarage:OpenGarage:status" }
Contact OpenGarage_Status_Contact { channel="opengarage:opengarage:OpenGarage:status-contact" }
Rollershutter OpenGarage_Status_Rollershutter { channel="opengarage:opengarage:OpenGarage:status-rollershutter" }
@@ -51,7 +50,7 @@ String OpenGarage_Vehicle { channel="opengarage:opengarage:OpenGarage:vehicle" }
opengarage.sitemap:
```
```perl
Switch item=OpenGarage_Status icon="garagedoorclosed" mappings=[ON=Open] visibility=[OpenGarage_Status == OFF]
Switch item=OpenGarage_Status icon="garagedooropen" mappings=[OFF=Close] visibility=[OpenGarage_Status == ON]
Switch item=OpenGarage_Status icon="garage"
@@ -60,5 +59,3 @@ Rollershutter item=OpenGarage_Status_Rollershutter icon="garage"
Text item=OpenGarage_Distance label="OG distance"
Text item=OpenGarage_Vehicle label="Vehicle Presence"
```