ekey bionyx| This function
block receives the events of a fingerprint scanner of the ekey ranges xLine,
sLine and dLine, that is the devices with controller REG and the
ekey bionyx app. Every finger scan appears at the outputs with user,
finger number and result, and a table defines which finger triggers which
action - open the door, switch on the light, disarm the alarm
system. The older device range with the converter LAN RS-485 is handled by the block Ekey UDP. The two ranges speak different languages: the older one sends UDP packets, the new one calls an address of the controller over HTTP. So the device decides which block fits. How the device sends. The ekey controller establishes the connection itself and calls an address in the local network on every event. The controller of the building does not poll, so there is no polling interval and no delay. The reply is sent immediately; without it, the ekey controller would repeat the event. Setup in the ekey bionyx app. Under Settings → Smart home the notification interface is enabled and the controller is entered as the target, for example http://192.168.1.90:8130. Only host and port are entered - the rest of the address is appended by the ekey controller itself. The port must match the parameter Port of this block. Only the owner of the system may enable the interface. Users and actions. The ekey controller does not send a name but an identifier such as tKlLpvUa. Only the ekey bionyx app knows which person it belongs to - therefore the assignment is entered once in the table of this block. Every row of the table creates one output: if identifier and finger match the event, that output is set. The name from the table appears at the output User and labels the action output, so that the program page shows who switches which output. Importing users. If the user list of the ekey bionyx app is available as JSON, the identifiers do not have to be typed in: in the table dialog, Import users from ekey takes identifier and name from the clipboard or from a file. Each user gets a row with the action Pulse for any finger - set action and finger afterwards and delete rows that are not needed. Identifiers already in the table remain unchanged. If a person has several identifiers in the app, this results in several rows. Actions are only triggered on a match, that is when the finger was recognised and granted. A rejected finger names no user and therefore never switches an action - otherwise a row without an identifier would react to every failed attempt. One block per installation. The app allows only one target, so one block per project is sufficient. Several blocks with the same port cannot work at the same time. Security. The transmission is unencrypted and stays in the local network. The port must not be reachable from the internet. The same applies as for the network API: there is no login, the local network is the protection. Testing without a device. An event can be simulated from any computer in the network: curl -X POST http://192.168.1.90:8130/api/notification/finger -H "Content-Type: application/json" -d "{\"type\":10,\"result\":10,\"params\":{\"userId\":\"tKlLpvUa\",\"fingerIndex\":2}}" With the parameter Debug the received content is written to the log of the controller - this also shows which identifier a finger actually delivers. |
Columns |
||
| User identifier | Identifier of the user from the ekey bionyx app. Upper and lower case are distinguished. Empty means every recognised user - for an action that every authorised finger shall trigger. | |
| Name | Plain text for the identifier. It appears at the output User and labels the action output. If it stays empty, the identifier itself is shown. | |
| Finger left, finger right | One finger number from 1 to 5 per hand, "-" means not used. If
both columns are "-", the row reacts to every finger. If both carry the same
number, the row reacts to both fingers - for example the index finger on the
left and on the right. This way two fingers of the same user trigger two
different actions: one finger opens the door, another one also switches on the
light. The ekey controller reports the number with a sign, the left hand negative - the output Finger shows it exactly as it arrived. Which number a finger delivers is shown by the parameter Debug in the log of the controller. |
|
| Action |
|
|
| Output on, output off | The two values at the action output, default 1 and 0. For a scene or an operating mode another value can be entered as well. | |
| Pulse time | Only with the action Pulse: seconds the value on is present, default 5. | |
Inputs |
||
| FG | Enable | Optional. 0 blocks the block: incoming events are acknowledged but not evaluated - there is no pulse and no action, the outputs keep their values. Other than 0 enables. Not connected: the block is considered enabled. |
Outputs |
||
| PL | Pulse | On every accepted event a pulse is sent: first 0, then 1 and after three seconds 0 again. This allows an own logic to be started, for example an entry in the message centre. When the pulse arrives, the other outputs already carry the values of the event. |
| BE | User | Name from the table, otherwise the identifier of the user. This needs an address of the type character string (EIS 15); "create addresses" creates it accordingly. |
| FI | Finger | Finger number, -5 to 5. The sign distinguishes the two hands, 0 means "no finger". The ekey bionyx app shows which number belongs to which finger. |
| TR | Match | 1 if the finger was recognised and granted, otherwise 0. |
| AB | Rejection | 1 if the finger was rejected - unknown finger, blocked user or time schedule. This requires the parameter Output rejected fingers, otherwise a rejected finger is not passed on at all. |
| GR | Reason | Reason for the rejection as reported by the ekey controller: 10 user deactivated, 20 time schedule, 30 no rule for this finger, 40 no input, 50 invalid input, 60 time limit. 0 for a recognised finger. |
| SC | Scanner | Identifier of the device that read the finger, as text. With several scanners this tells which door was used. |
| EN | Input | Number of the digital input of the ekey controller if the event comes from there. 0 for a finger scan. |
| ZE | Number of events | Counter of all accepted events since the controller started. After a restart it begins at 0. |
| KE | No event | 1 if no event arrived within the monitoring time, that is no
finger scan and no message from an input. A rejected finger counts as an event
too. The next event sets the output back to 0. Without a monitoring time it
always stays 0. A broken connection cannot be detected this way: the ekey controller only reports when something happens and sends no sign of life. If it sends into the void, for example because the controller got a new IP address, this looks exactly like a time in which nobody placed a finger. To prevent this, give the controller a fixed IP address. |
| A1..An | Action per table row | One output per row of the table, labelled with the name from that row. "Create addresses" does not create an address for these outputs - they are connected to the logic or assigned directly to the address of the actuator, for example the door opener. |
Parameters |
||
| Users and actions | Opens the table, see above. At most 32 rows. | |
| Port | TCP port on which the controller accepts the events, default 8130. The same port is entered in the ekey bionyx app. The port must not be used by another service of the controller, for example 10001 (studio and app), 80 and 443 (web interface) or 502 (Modbus slave). | |
| Output rejected fingers | Default off: only the recognised finger appears at the outputs, which is the previous behaviour. Switched on, a rejected finger also creates a pulse, the output Rejection becomes 1 and the reason appears at GR - for a message such as "unknown finger at the front door". A rejected finger still never triggers an action. | |
| Monitoring time | Minutes without an event after which the output No event
becomes 1, at most 1440 (one day). Default 0, that is no monitoring. What is monitored is whether this door is being scanned at all - for example at an entrance that is used every day: if nothing arrives for a whole day, either nobody is there or the messages no longer reach the controller. The block cannot tell one from the other. A short time reports every quiet night, and an absence is reported even with the longest time. |
|
| Debug | Writes every received event completely into the log of the controller. Intended for commissioning, switch it off again in operation. | |