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

81
bundles/org.openhab.binding.satel/README.md
View File

@@ -17,7 +17,7 @@ More details and all documentation about Integra system you can find on their si
This binding supports following thing types:
| Thing type | Description |
|------------|------------------------------------------------------------------------------------------------------------------------------------------|
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| ethm-1 | Ethernet bridge, supports [ETHM-1](https://www.satel.pl/en/product/115/) and [ETHM-1 Plus](https://www.satel.pl/en/product/698/) modules |
| int-rs | RS-232 bridge, supports [INT-RS](https://www.satel.pl/en/product/123/) and [INT-RS Plus](https://www.satel.pl/en/product/664/) modules |
| partition | Set of zones representing some physical area or logical relation |
@@ -28,7 +28,6 @@ This binding supports following thing types:
| event-log | A virtual thing that allows reading records from the alarm system event log |
| atd-100 | Wireless temperature detector [ATD-100](https://www.satel.pl/en/produktid/503) |
## Discovery
The binding discovers all devices (partitions, zones) defined in the system, but bridge things must be configured manually.
@@ -40,7 +39,7 @@ The binding discovers all devices (partitions, zones) defined in the system, but
You can configure the following settings for this bridge:
| Name | Required | Description |
|---------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| host | yes | Host name or IP addres of ETHM-1 module. |
| port | no | TCP port for the integration protocol, defaults to 7094. |
| timeout | no | Timeout value in milliseconds for connect, read and write operations, defaults to 5000 (5secs). |
@@ -52,12 +51,12 @@ You can configure the following settings for this bridge:
Example:
```
```java
Bridge satel:ethm-1:home [ host="192.168.0.2", refresh=1000, userCode="1234", encryptionKey="abcdefgh" ]
```
**NOTE:** There can be only one client connected to ETHM-1 module.
It does not accept new connections if there is already a connection established.
**NOTE:** There can be only one client connected to ETHM-1 module.
It does not accept new connections if there is already a connection established.
In case you have troubles connecting to the system using this module, please make sure there is no other client (for example installed 1.x version of the binding) already connected to it.
### int-rs bridge
@@ -65,7 +64,7 @@ In case you have troubles connecting to the system using this module, please mak
You can configure the following settings for this bridge:
| Name | Required | Description |
|-------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| ----------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| port | yes | Serial port connected to the module. |
| timeout | no | Timeout value in milliseconds for connect, read and write operations, defaults to 5000 (5secs). |
| refresh | no | Polling interval in milliseconds, defaults to 5000 (5secs). |
@@ -75,7 +74,7 @@ You can configure the following settings for this bridge:
Example:
```
```java
Bridge satel:int-rs:home [ port="/dev/ttyS0", refresh=1000, userCode="1234" ]
```
@@ -84,13 +83,13 @@ Bridge satel:int-rs:home [ port="/dev/ttyS0", refresh=1000, userCode="1234" ]
You can configure the following settings for a partition:
| Name | Required | Description |
|-------------|----------|------------------------------------------------------------------|
| ----------- | -------- | ---------------------------------------------------------------- |
| id | yes | Partition number |
| forceArming | no | Arms the partition regardless of ongoing troubles and violations |
Example:
```
```java
Thing partition partition1 [ id=1, forceArming=true ]
```
@@ -99,14 +98,14 @@ Thing partition partition1 [ id=1, forceArming=true ]
You can configure the following settings for a zone:
| Name | Required | Description |
|-------------|----------|--------------------------------------------------------------------------|
| ----------- | -------- | ------------------------------------------------------------------------ |
| id | yes | Zone number |
| invertState | no | Changes active (ON) state to 0 |
| wireless | no | This zone is monitored by a wireless detector like APD-100, AFD-100, etc |
Example:
```
```java
Thing zone zone1 [ id=1 ]
```
@@ -115,7 +114,7 @@ Thing zone zone1 [ id=1 ]
You can configure the following settings for an output:
| Name | Required | Description |
|-------------|----------|-----------------------------------------------------------------------|
| ----------- | -------- | --------------------------------------------------------------------- |
| id | yes | Output number |
| invertState | no | Changes active (ON) state to 0 |
| commandOnly | no | Accepts commands only, does not update state of the thing |
@@ -123,7 +122,7 @@ You can configure the following settings for an output:
Example:
```
```java
Thing output output1 [ id=1, invertState=true, wireless=false ]
```
@@ -132,14 +131,14 @@ Thing output output1 [ id=1, invertState=true, wireless=false ]
You can configure the following settings for a shutter:
| Name | Required | Description |
|-------------|----------|-----------------------------------------------------------|
| ----------- | -------- | --------------------------------------------------------- |
| upId | yes | Output number for "up" direction |
| downId | yes | Output number for "down" direction |
| commandOnly | no | Accepts commands only, does not update state of the thing |
Example:
```
```java
Thing shutter shutter1 [ upId=10, downId=11, commandOnly=true ]
```
@@ -149,7 +148,7 @@ This thing type does not have any configuration parameters.
Example:
```
```java
Thing system System [ ]
```
@@ -159,7 +158,7 @@ This thing type does not have any configuration parameters.
Example:
```
```java
Thing event-log EventLog [ ]
```
@@ -168,13 +167,13 @@ Thing event-log EventLog [ ]
You can configure the following settings for this thing:
| Name | Required | Description |
|---------|----------|------------------------------------------------------------|
| ------- | -------- | ---------------------------------------------------------- |
| id | yes | Zone number in the alarm system monitored by this detector |
| refresh | no | Polling interval in minutes, defaults to 15 |
Example:
```
```java
Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
```
@@ -183,7 +182,7 @@ Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
### partition
| Name | Type | Description |
|--------------------|--------|-----------------------------------|
| ------------------ | ------ | --------------------------------- |
| armed | Switch | Armed |
| really_armed | Switch | Really armed |
| armed_mode_1 | Switch | Armed in mode 1 |
@@ -206,7 +205,7 @@ Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
### zone
| Name | Type | Description |
|------------------------|--------|-----------------------------------------------------------|
| ---------------------- | ------ | --------------------------------------------------------- |
| violation | Switch | Violation |
| tamper | Switch | Tamper |
| alarm | Switch | Alarm |
@@ -227,7 +226,7 @@ Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
**NOTE:** You can change state of mono/bistable outputs only.
| Name | Type | Description |
|---------------|--------|-----------------------------------------------------------|
| ------------- | ------ | --------------------------------------------------------- |
| state | Switch | State of the output |
| device_lobatt | Switch | Indicates low battery level in the wireless device |
| device_nocomm | Switch | Indicates communication troubles with the wireless device |
@@ -235,13 +234,13 @@ Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
### shutter
| Name | Type | Description |
|---------------|---------------|----------------------|
| ------------- | ------------- | -------------------- |
| shutter_state | Rollershutter | State of the shutter |
### system
| Name | Type | Description |
|-----------------|----------|------------------------------------------------------------------------------------------------------------------------------------|
| --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| date_time | DateTime | Date and time on the alarm system |
| troubles | Switch | Active when the system has troubles (trouble LED is blinking on a panel) |
| troubles_memory | Switch | Memorized state of system troubles |
@@ -256,7 +255,7 @@ Thing atd-100 KitchenTemp [ id=10, refresh=30 ]
These channels and the thing will be removed in the future release of the binding. Please use `readEvent` rule action instead.
| Name | Type | Description |
|-------------|----------|----------------------------------------------------------------------------------------|
| ----------- | -------- | -------------------------------------------------------------------------------------- |
| index | Number | Index of the current record in the event log. Send '-1' to get most recent record. |
| prev_index | Number | Index of the previous record in the event log. Use this value to iterate over the log. |
| timestamp | DateTime | Date and time when the event happened. |
@@ -266,7 +265,7 @@ These channels and the thing will be removed in the future release of the bindin
### atd-100
| Name | Type | Description |
|---------------|--------------------|-----------------------------------------------------------|
| ------------- | ------------------ | --------------------------------------------------------- |
| temperature | Number:Temperature | Current temperature in the zone |
| device_lobatt | Switch | Indicates low battery level in the wireless device |
| device_nocomm | Switch | Indicates communication troubles with the wireless device |
@@ -275,11 +274,11 @@ These channels and the thing will be removed in the future release of the bindin
### readEvent
This action allows you to read one record from the event log placed at index given by input parameter.
This action allows you to read one record from the event log placed at index given by input parameter.
The result of this action is compatible with channels of `event-log` thing and contains following values:
| Name | Type | Description |
|-------------|---------------|----------------------------------------------------------------------------------------|
| ----------- | ------------- | -------------------------------------------------------------------------------------- |
| index | Number | Index of this record in the event log. |
| prev_index | Number | Index of the previous record in the event log. Use this value to iterate over the log. |
| timestamp | ZonedDateTime | Date and time when the event happened. |
@@ -288,10 +287,10 @@ The result of this action is compatible with channels of `event-log` thing and c
Usage:
```
val actions = getActions("satel", "satel:event-log:home:EventLog")
val eventRec = actions.readEvent(-1)
logInfo("EventLog", eventRec.get("description"))
```java
val actions = getActions("satel", "satel:event-log:home:EventLog")
val eventRec = actions.readEvent(-1)
logInfo("EventLog", eventRec.get("description"))
```
**NOTE:** To have this action available, you must have `event-log` thing configured in openHAB.
@@ -300,7 +299,7 @@ Usage:
### satel.things
```
```java
Bridge satel:ethm-1:home [ host="192.168.0.2", refresh=1000, userCode="1234", encryptionKey="abcdefgh" ] {
Thing partition MainPartition [ id=1 ]
Thing zone LivingRoomPIR [ id=1 ]
@@ -317,7 +316,7 @@ Bridge satel:ethm-1:home [ host="192.168.0.2", refresh=1000, userCode="1234", en
### satel.items
```
```java
Group Satel
Group:Switch:OR(ON,OFF) Alarms "Alarms [(%d)]" <siren>
Switch PARTITION_ARMED "Partition armed" (Satel) { channel="satel:partition:home:MainPartition:armed" }
@@ -340,7 +339,7 @@ Switch KITCHEN_TEMP_NOCOMM "Kitchen sensor: no communication" (Satel) { channel=
### satel.sitemap
```
```perl
Frame label="Alarm system" {
Switch item=Alarms mappings=[OFF="Clear"]
Switch item=PARTITION_ARMED mappings=[ON="Arm", OFF="Disarm"]
@@ -371,7 +370,7 @@ Frame label="Alarm system" {
### satel.rules
```
```java
var String userCode = ""
var Timer keypadTimer = null
var Timer userCodeTimer = null
@@ -441,7 +440,7 @@ end
### binary items
In openHAB all channels have strict types, which means you cannot use other type then designated for a channel.
In openHAB all channels have strict types, which means you cannot use other type then designated for a channel.
In Satel binding all binary items are now of 'Switch' type. Using other item types, like 'Contact' is not possible in this version of the binding.
For this reason, when migrating 1.x item files, besides changing binding configuration for each item, you must replace all 'Contact' items to 'Switch' type.
@@ -452,7 +451,7 @@ You can easily replace them with the following configuration:
#### satel.items
```
```java
Switch MODULE_CONNECTED "Connection status" <network> (Satel)
DateTime MODULE_CONNECTED_SINCE "Connection established at [%1$tF %1$tR]" <time> (Satel)
Number MODULE_CONNECTION_ERRORS "Connection errors [%d]" (Satel)
@@ -460,7 +459,7 @@ Number MODULE_CONNECTION_ERRORS "Connection errors [%d]" (Satel)
#### satel.rules
```
```java
rule "Satel bridge changed to ONLINE"
when
Thing "satel:ethm-1:home" changed to ONLINE
@@ -502,4 +501,4 @@ You can find such keypad in the [Full Example](#full-example) section.
## Media
* [Arming and clearing troubles](https://www.youtube.com/watch?v=ogdgn0Dk1G8)
- [Arming and clearing troubles](https://www.youtube.com/watch?v=ogdgn0Dk1G8)