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

[Documentation] Markdown improvements t to z (#14371)

Browse Source 
* Apply markdown fixes for bindings with letter _t_
* Apply markdown fixes for bindings with letter _u_
* Apply markdown fixes for bindings with letter _v_
* Apply markdown fixes for bindings with letter _w_
* Apply markdown fixes for bindings with letter _x_
* Apply markdown fixes for bindings with letter _y_
* Apply markdown fixes for bindings with letter _z_

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2023-04-11 12:54:54 +02:00
committed by GitHub
parent 69a09ed825
commit ce3f673380
54 changed files with 1655 additions and 1778 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
bundles/org.openhab.binding.zoneminder/README.md
View File

@@ -22,7 +22,7 @@ There are two different styles of operation, depending on whether or not you hav
### Non-Authenticated
If ZoneMinder authentication is not used, the User and Password parameters should be empty in the *ZoneMinder Server* thing configuration.
If ZoneMinder authentication is not used, the User and Password parameters should be empty in the _ZoneMinder Server_ thing configuration.
No other configuration is required.
### Authenticated
@@ -34,7 +34,7 @@ Then, enter the user name and password into the ZoneMinder Server thing configur
## Discovery
The server bridge must be added manually.
Once the server bridge is configured with a valid ZoneMinder host name or IP address,
Once the server bridge is configured with a valid ZoneMinder host name or IP address,
all monitors associated with the ZoneMinder server will be discovered.
## Thing Configuration
@@ -110,17 +110,17 @@ The following configuration parameters are available on the Monitor thing:
## Thing Actions
### triggerAlarm
### triggerAlarm (with Duration)
The `triggerAlarm` action triggers an alarm that runs for the number of seconds specified by the parameter `duration`.
##### triggerAlarm - trigger an alarm
#### triggerAlarm - trigger an alarm
```java
void triggerAlarm(Number duration)
```
```
```text
Parameters:
duration - The number of seconds for which the alarm should run.
```
@@ -130,7 +130,7 @@ duration - The number of seconds for which the alarm should run.
The `triggerAlarm` action triggers an alarm that runs for the number of seconds specified
in the Monitor thing configuration.
##### triggerAlarm - trigger an alarm
#### triggerAlarm - trigger an alarm
```java
void triggerAlarm()
@@ -140,7 +140,7 @@ void triggerAlarm()
The `cancelAlarm` action cancels a running alarm.
##### cancelAlarm - cancel an alarm
#### cancelAlarm - cancel an alarm
```java
void cancelAlarm()
@@ -155,7 +155,7 @@ The API must be enabled in the ZoneMinder configuration using the **OPT_USE_API*
### Things
```
```java
Bridge zoneminder:server:server [ host="192.168.1.100", refreshInterval=5, defaultAlarmDuration=120, discoveryEnabled=true, useDefaultUrlPath=true ]
Thing zoneminder:monitor:1 "Monitor 1" (zoneminder:server:server) [ monitorId="1", imageRefreshInterval=10, alarmDuration=180 ]
@@ -165,7 +165,7 @@ Thing zoneminder:monitor:2 "Monitor 2" (zoneminder:server:server) [ monitorId="2
### Items
```
```java
// Server
String ZmServer_ImageMonitorId "Image Monitor Id [%s]" { channel="zoneminder:server:server:imageMonitorId" }
String ZmServer_ImageUrl "Image Url [%s]" { channel="zoneminder:server:server:imageUrl" }
@@ -200,8 +200,7 @@ Number:Time ZM_Monitor1_Length "Event Length [%.2f]" { channel="z
### Sitemap
```
```perl
Selection item=ZmServer_ImageMonitorId
Image item=ZmServer_ImageUrl
Selection item=ZmServer_VideoMonitorId
@@ -214,9 +213,9 @@ Image item=ZM_Monitor1_Image
### Rules
The following examples assume you have a motion sensor that is linked to an item called *MotionSensorAlarm*.
The following examples assume you have a motion sensor that is linked to an item called _MotionSensorAlarm_.
```
```java
rule "Record When Motion Detected Using Channel"
when
Item MotionSensorAlarm changed to ON
@@ -225,7 +224,7 @@ then
end
```
```
```java
rule "Record for 120 Seconds When Motion Detected"
when
Item MotionSensorAlarm changed to ON
@@ -235,7 +234,7 @@ then
end
```
```
```java
rule "Record When Motion Detected"
when
Item MotionSensorAlarm changed to ON
@@ -245,7 +244,7 @@ then
end
```
```
```java
rule "Record When Motion Detection Cleared"
when
Item MotionSensorAlarm changed to OFF
@@ -255,7 +254,7 @@ then
end
```
```
```java
val monitors = newArrayList("1", "3", "4", "6")
var int index = 0