]> git.basschouten.com Git - openhab-addons.git/commitdiff
[ekey] Update documentation (#15792)
authorhamsil <bwal@mail.de>
Sun, 22 Oct 2023 15:02:02 +0000 (17:02 +0200)
committerGitHub <noreply@github.com>
Sun, 22 Oct 2023 15:02:02 +0000 (17:02 +0200)
Adapted README based on my recent experience with the MULTI protocol

Signed-off-by: hamsil <bwal@mail.de>
bundles/org.openhab.binding.ekey/README.md

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