Skip to content

Commit 807a14a

Browse files
authored
[ekey] Update documentation (openhab#15792)
Adapted README based on my recent experience with the MULTI protocol Signed-off-by: hamsil <[email protected]>
1 parent a09ed86 commit 807a14a

File tree

1 file changed

+37
-27
lines changed

1 file changed

+37
-27
lines changed

bundles/org.openhab.binding.ekey/README.md

+37-27
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ Number UserID "Last user that accessed the house was [MAP(ekey_names.map):%d]" {
6060
multi.items
6161

6262
```java
63-
Number Action "Last action [MAP(ekey_action.map):%d]" { channel="ekey:cvlan:de3b8db06e:action" }
64-
Number FingerID "User used finger [MAP(ekey_finger.map):%d]" { channel="ekey:cvlan:de3b8db06e:fingerId" }
65-
String FsName "Name of Scanner [%s] { channel="ekey:cvlan:de3b8db06e:fsName" }
63+
Number Action "Last action [MAP(ekey_action.map):%s]" { channel="ekey:cvlan:de3b8db06e:action" }
64+
Number FingerID "User used finger [MAP(ekey_finger.map):%s]" { channel="ekey:cvlan:de3b8db06e:fingerId" }
65+
String FsName "Name of Scanner [%s]" { channel="ekey:cvlan:de3b8db06e:fsName" }
6666
Number FsSerial "Serialnumber [%d]" { channel="ekey:cvlan:de3b8db06e:fsSerial" }
6767
Number InputID "Last input that has been triggered [%d]" { channel="ekey:cvlan:de3b8db06e:inputId" }
6868
Number KeyID "Last key that has been used [%d]" { channel="ekey:cvlan:de3b8db06e:keyId" }
69-
Number UserID "Last user that accessed the house was [MAP(ekey_names.map):%d]" { channel="ekey:cvlan:de3b8db06e:userId" }
70-
String UserName " Name of Last user that accessed the house was : [%d]" { channel="ekey:cvlan:de3b8db06e:userName" }
71-
Number UserStatus "Last user that accessed the house was [MAP(ekey_names.map):%d]" { channel="ekey:cvlan:de3b8db06e:userStatus" }
69+
Number UserID "Last user that accessed the house was [%d]" { channel="ekey:cvlan:de3b8db06e:userId" }
70+
String UserName "Name of Last user that accessed the house was: [%s]" { channel="ekey:cvlan:de3b8db06e:userName" }
71+
Number UserStatus "Last user that accessed the house was [MAP(ekey_status.map):%s]" { channel="ekey:cvlan:de3b8db06e:userStatus" }
7272
```
7373

7474
home.items
@@ -81,30 +81,38 @@ Number Serialnumber "Serialnumber [%d]" {
8181
Number UserID "Last user that accessed the house was [MAP(ekey_names.map):%d]" { channel="ekey:cvlan:de3b8db06e:userId" }
8282
```
8383

84-
transform/ekey_finger.map [This is just an example, as there is no strict rule what finger belongs to what number]
84+
transform/ekey_finger.map [this works for HOME and MULTI protocols, for RARE it's individually defined]
8585

8686
```text
87-
0=leftlittle
88-
1=leftring
89-
2=leftmiddle
90-
3=leftindex
91-
4=leftthumb
92-
5=rightthumb
93-
6=rightindex
94-
7=rightmiddle
95-
8=rightring
96-
9=rightlittle
97-
-1=unknown
87+
1=leftlittle
88+
2=leftring
89+
3=leftmiddle
90+
4=leftindex
91+
5=leftthumb
92+
6=rightthumb
93+
7=rightindex
94+
8=rightmiddle
95+
9=rightring
96+
0=rightlittle
97+
R=RFID
98+
-1=nofinger
9899
```
99100

100101
transform/ekey_names.map [NO spaces allowed]
101-
102102
```text
103103
-1=Unspecified
104104
1=JohnDoe
105105
2=JaneDoe
106106
```
107107

108+
transform/ekey_status.map
109+
110+
```text
111+
-1=undefined
112+
1=enabled
113+
0=disabled
114+
```
115+
108116
transform/ekey_terminal.map
109117

110118
```text
@@ -115,14 +123,16 @@ transform/ekey_terminal.map
115123
transform/ekey_multi_action.map
116124

117125
```text
118-
0=granted
119-
-1=rejected
120-
1=timeoutA
121-
2=timeoutB
122-
3=inactive
123-
4=alwaysuser
124-
5=notcoupled
125-
6=digitalinput
126+
1=open
127+
2=refuseunrecognizedfinger
128+
3=refusetimeslotA
129+
4=refusetimeslotB
130+
5=refusedisabled
131+
6=refuseOnlyalwaysusers
132+
7=fingerscannernotconnectedtocontrolpanel
133+
8=digitalinput
134+
A=codepad1minutelock
135+
B=codepad15minutelock
126136
```
127137

128138
transform/ekey_rare_action.map

0 commit comments

Comments
 (0)