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

[ekey] Update documentation (#15792)

Browse Source 
Adapted README based on my recent experience with the MULTI protocol

Signed-off-by: hamsil <bwal@mail.de>
This commit is contained in:
hamsil 2023-10-22 17:02:02 +02:00 committed by GitHub
parent a09ed8658e
commit 807a14a655
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
bundles/org.openhab.binding.ekey/README.md
View File

@ -60,15 +60,15 @@ Number UserID "Last user that accessed the house was [MAP(ekey_names.map):%d]" {
multi.items multi.items
```java ```java
Number Action "Last action [MAP(ekey_action.map):%d]" { channel="ekey:cvlan:de3b8db06e:action" } Number Action "Last action [MAP(ekey_action.map):%s]" { channel="ekey:cvlan:de3b8db06e:action" }
Number FingerID "User used finger [MAP(ekey_finger.map):%d]" { channel="ekey:cvlan:de3b8db06e:fingerId" } Number FingerID "User used finger [MAP(ekey_finger.map):%s]" { channel="ekey:cvlan:de3b8db06e:fingerId" }
String FsName "Name of Scanner [%s] { channel="ekey:cvlan:de3b8db06e:fsName" } String FsName "Name of Scanner [%s]" { channel="ekey:cvlan:de3b8db06e:fsName" }
Number FsSerial "Serialnumber [%d]" { channel="ekey:cvlan:de3b8db06e:fsSerial" } Number FsSerial "Serialnumber [%d]" { channel="ekey:cvlan:de3b8db06e:fsSerial" }
Number InputID "Last input that has been triggered [%d]" { channel="ekey:cvlan:de3b8db06e:inputId" } Number InputID "Last input that has been triggered [%d]" { channel="ekey:cvlan:de3b8db06e:inputId" }
Number KeyID "Last key that has been used [%d]" { channel="ekey:cvlan:de3b8db06e:keyId" } Number KeyID "Last key that has been used [%d]" { channel="ekey:cvlan:de3b8db06e:keyId" }
Number UserID "Last user that accessed the house was [MAP(ekey_names.map):%d]" { channel="ekey:cvlan:de3b8db06e:userId" } Number UserID "Last user that accessed the house was [%d]" { channel="ekey:cvlan:de3b8db06e:userId" }
String UserName " Name of Last user that accessed the house was : [%d]" { channel="ekey:cvlan:de3b8db06e:userName" } String UserName "Name of Last user that accessed the house was: [%s]" { channel="ekey:cvlan:de3b8db06e:userName" }
Number UserStatus "Last user that accessed the house was [MAP(ekey_names.map):%d]" { channel="ekey:cvlan:de3b8db06e:userStatus" } Number UserStatus "Last user that accessed the house was [MAP(ekey_status.map):%s]" { channel="ekey:cvlan:de3b8db06e:userStatus" }
``` ```
home.items home.items
@ -81,30 +81,38 @@ Number Serialnumber "Serialnumber [%d]" {
Number UserID "Last user that accessed the house was [MAP(ekey_names.map):%d]" { channel="ekey:cvlan:de3b8db06e:userId" } Number UserID "Last user that accessed the house was [MAP(ekey_names.map):%d]" { channel="ekey:cvlan:de3b8db06e:userId" }
``` ```
transform/ekey_finger.map [This is just an example, as there is no strict rule what finger belongs to what number] transform/ekey_finger.map [this works for HOME and MULTI protocols, for RARE it's individually defined]
```text ```text
0=leftlittle 1=leftlittle
1=leftring 2=leftring
2=leftmiddle 3=leftmiddle
3=leftindex 4=leftindex
4=leftthumb 5=leftthumb
5=rightthumb 6=rightthumb
6=rightindex 7=rightindex
7=rightmiddle 8=rightmiddle
8=rightring 9=rightring
9=rightlittle 0=rightlittle
-1=unknown R=RFID
-1=nofinger
``` ```
transform/ekey_names.map [NO spaces allowed] transform/ekey_names.map [NO spaces allowed]
```text ```text
-1=Unspecified -1=Unspecified
1=JohnDoe 1=JohnDoe
2=JaneDoe 2=JaneDoe
``` ```
transform/ekey_status.map
```text
-1=undefined
1=enabled
0=disabled
```
transform/ekey_terminal.map transform/ekey_terminal.map
```text ```text
@ -115,14 +123,16 @@ transform/ekey_terminal.map
transform/ekey_multi_action.map transform/ekey_multi_action.map
```text ```text
0=granted 1=open
-1=rejected 2=refuseunrecognizedfinger
1=timeoutA 3=refusetimeslotA
2=timeoutB 4=refusetimeslotB
3=inactive 5=refusedisabled
4=alwaysuser 6=refuseOnlyalwaysusers
5=notcoupled 7=fingerscannernotconnectedtocontrolpanel
6=digitalinput 8=digitalinput
A=codepad1minutelock
B=codepad15minutelock
``` ```
transform/ekey_rare_action.map transform/ekey_rare_action.map