Leosac
0.8.0
Open Source Access Control
|
Explains how to configure the module to work with various Wiegand reader.
This module provides support for Wiegand devices. Simply put, it listens to GPIO event, gather them, and generate Wiegand events. It supports multiple readers.
As this is an module that provide an authentication source (by reading card ids or PIN code, or both), it shall conforms to those specifications regarding message passing.
There are multiple mode supported by the wiegand module. They allows the module to read from differently configured hardware, and allows you to chose what kind of credentials the module shall generate.
Options | Options | Options | Description | Mandatory |
---|---|---|---|---|
use_database | If true, use the database for config. Ignore other options | NO (defaults to false) | ||
readers | Lists of all configured readers | YES | ||
—> | reader | Configuration of 1 wiegand reader | YES | |
—> | —> | name | device name | YES |
—> | —> | high | name of the input GPIO that sends "high" data | YES |
—> | —> | low | name of the input GPIO that sends "low" data | YES |
—> | —> | green_led | name of the green led device attached to the reader | NO |
—> | —> | buzzer | name of the buzzer device attached to the reader | NO |
—> | —> | mode | Which mode the reader is using (see below) | NO (defaults to SIMPLE_WIEGAND ) |
—> | —> | pin_timeout | Timeout when reading a PIN code. | NO (defaults to 2500ms) |
—> | —> | pin_key_end | Which key is used to signal the end of a PIN code | NO (defaults to '#') |
—> | —> | nowait | Don't wait for pin code after card read | NO (defaults to 0) |
Note: high
, low
, green_led
and buzzer
must be name of GPIO object: either defined using the sysfsgpio or pifacedigital module.
There are multiples mode
available for a reader:
SIMPLE_WIEGAND
is for simply reading a wiegand card.WIEGAND_PIN_4BITS
for reading a PIN code, when the reader send 4 bits per key pressed.WIEGAND_PIN_8BITS
for reading a PIN code, when the reader send 8 bits per key pressed.WIEGAND_PIN_BUFFERED
for reading a PIN code when the reader buffers up to 5key and send them in a 26 bits wiegand frame. Note that in this mode, the pin_key_end
and pin_timeout
parameter have no effect.WIEGAND_CARD_PIN_4BITS
reads a card number followed by a PIN code read in 4bits mode.WIEGAND_CARD_PIN_8BITS
reads a card number followed by a PIN code read in 8bits mode.WIEGAND_CARD_PIN_BUFFERED
reads a card number followed by a PIN code read in buffered mode.AUTODETECT
allows the module to read and create different type of credentials. It can read a pin code or a card number, or both. The pin code can be read if the reader is either in 4 bits or 8 bits mode. If you are doing card-only authentication, note that you will notice a delay of ~2 second, unless nowait is set to true. This delay is here to let the user have a chance to enter his PIN code.AUTODETECT
mode is not compatible with the hardware Wiegand-Buffered mode.You can see this for more the message passing specific specification about those modes. Note that multiple mode share a common message implementation.
Additional informations:
pin_timeout
is the number of milliseconds (defaults to 2000) of inactivity on the keypad before considering the PIN code complete and sending it for processing. It's also the delay you have to enter your PIN after swiping your card.pin_key_end
is the key to press to signal the end of the pin (default to '#'). This key wont be appended to the PIN code.pin_key_end
.This is a example of configuration for the Wiegand module.
For wiring to a pico-pc operating at 3.3v (like Raspberry Pi), see Raspberry Pi 1 and Wiegand
Technical implementations details can be found here.