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

[Documentation] Markdown improvements f to m (#13866)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-08 21:36:05 +01:00
committed by GitHub
parent 3c236b3103
commit 0e68936663
122 changed files with 3490 additions and 3662 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
bundles/org.openhab.binding.linuxinput/README.md
View File

@@ -36,21 +36,20 @@ The `libevdev` library has to be installed for this plugin to work.
## Thing Configuration
Each thing has has to be explicitly enabled after it is configured.
While it is enabled *all* of the generated events will be consumed by openHAB.
While it is enabled _all_ of the generated events will be consumed by openHAB.
The device will not be available for normal input processing!
### Static configuration
#### Thing
```
```java
Thing linuxinput:input-device:some-keyboard [ enable=true, path="/dev/input/eventXX" ]
```
#### Item
```
```java
Contact SomeButton "Some Button" { channel="linuxinput:input-device:event17:keypresses#KEY_0" }
```
@@ -58,8 +57,8 @@ Contact SomeButton "Some Button" { channel="linuxinput:input-device:event17:keyp
Each Thing provides multiple channels
* A `key` channel that aggregates all events.
* Per physical key channels.
- A `key` channel that aggregates all events.
- Per physical key channels.
### Events
@@ -67,16 +66,16 @@ The following happens when pressing and releasing a key:
#### Press
1) State of global key channel updated to new key.
2) State of per-key channel updated to `"CLOSED"`.
3) Global key channel triggered with the current key name.
4) Per-key channel triggered with `"PRESSED"`".
5) State of global key channel updated to `""` (Empty string)
1. State of global key channel updated to new key.
1. State of per-key channel updated to `"CLOSED"`.
1. Global key channel triggered with the current key name.
1. Per-key channel triggered with `"PRESSED"`".
1. State of global key channel updated to `""` (Empty string)
#### Release
1) State of per-key channel updated to `"OPEN"`
2) Per-key channel triggered with `"RELEASED"`
1. State of per-key channel updated to `"OPEN"`
1. Per-key channel triggered with `"RELEASED"`
#### Rationale