HowTo - Install and configure Wiegand Interface
This article describes the procedure how to install and configure Wiegand interface on TBS devices.
The Wiegand interface is supported by most control panels on the market and marks the lowest integration level with the TBS subsystem. It is a point-to-point unidirectional 2-wire (3-wires with common GND) connection from TBS device to external panel. All TBS devices offer Wiegand output directly on board (ports 'Wiegand D0/Out1, D1/Out2').
The Wiegand timing is usually not critical and modern receivers can self-synchronize on the sender. TBS devices send Wiegand data with ~2ms pulse intervals, each pulse having a length of ~50μs.
1. Installation
Typically, connection of the output ports on TBS device with the input lines on external 3rd party controller needs to be done this way:
All TBS devices | 3rd Party Controller |
D0 (Out 1) | D0 |
D1 (Out 2) | D1 |
IMPORTANT NOTES:
This connection is based on previous installations but cannot be guaranteed because it strongly depends on controller type!
In case of other connection scheme please inform TBS support by naming controller type and manufacturer.
If
wiring is correct and Wiegand signal is not received correctly, the reason
could be different ground levels on sender and receiver. Please connect ground
lines as well in this case.
2. Supported Wiegand formats
The following bit formats are supported through the Wiegand interface:
- 26 bit
- 37 bit
- 35 bit (HID Corporate 1000 format)
26 bit Format:
37 bit Format:
35 bit HID Corporate 1000 Format:
This format uses a 12 bit facility code (bits 3-14) and a 20 bit card code (bits 15-34).
Bit 1 is an odd parity bit that covers all 35 bits. Bit 2 is an even parity covering bits 3,4,6,7,9,10,12,13,15,16,28,19,21,22,24,25,27,28,30,31,33,34.
Bit 35 is odd parity, covering bits 2,3,5,6,8,9,11,12,14,15,17,18,20,21,23,24,26,27,29,30,32,33. The parity bits have to be calculated in following order: bit 2, bit 35 and bit 1.
These rules
apply:
Format | 26 bit Wiegand | 37 bit Wiegand | 35 bit Wiegand |
Max. Facility Code | 255 (8 bit) | 65536 (16 bit) | 4095 (12 bit) |
Max. User ID | 65536 (16 bit) | 524278 (19 bit) | 1048575 (20 bit) |
Leading Parity Bit (1) | linked to the first 12 data bits (Facility Code + 4 leading User ID bits) | linked to the first 18 data bits (Facility Code + 2 leading User ID bits) | refer above |
Trailing Parity Bit (2) | linked to the last 12 data bits (12 trailing User ID bits) | linked to the last 18 data bits (18 trailing User ID bits) | refer above |
(1) When the parity of the data bits is in sum odd, the leading parity bit is set to '1' (to make the 13-bit total come out
even)
(2) When the parity of the data bits is in sum even, the trailing parity
bit is set to '1' (to make the 13-bit total come out odd)
If the configured ID is higher than maximum value, then the ID is not transmitted to ensure data integrity.
3. Configuration
The Wiegand output can be configured in two modes: (1) Result Output (2) Authorization IO.
3.1 Result Output:
In this mode, the result of the transaction is transferred from the device to the controller. It transmits the ID of the user authenticating on the device.
The ID that is transferred is determined by the Primary ID Field settings. By default, it is set to UserID, but it can be configured to FlexID.
To enable, use DeviceConfig interface, go to menu 'Settings', click on 'Result Output' and activate the slider for 'Wiegand'.
The submenu 'Wiegand' appears in the left menu bar. Click on it to configure your project settings.
In case bigger IDs are desired to be transmitted, then configure custom 37-bit and assign the required number of bits for ID as shown below.
In the above example ID bits count is set to 27 bits, then the max value is 134217728 (2^27).
Limitations:
- In this mode, only successful transactions are transmitted. Transactions that fail due to no match in the database or authorization failure are not sent.
- Since the device does not wait for access rights feedback from the controller, it will still display "Access Granted" even if the controller rejects the request.
3.2 Wiegand IO authorization:
In this mode, the ID is transferred to the controller for authorization (access rights) request and awaits the feedback via GPINs (General Purpose INputs). The GPOUT (General Purpose OUTput) from the controller which signals the access decision must be connected to the GPIN on the device.
To enable the IO authorization for Wiegand, go to DeviceConfig interface, under 'Settings - Authorization', activate the slider for 'I/O' then click apply.
The submenu 'I/O' appears in the left menu bar. Click on it to configure your project settings.
To receive the access feedback from controller, the GPINs must be used. The devices 3D AIR Gen3, 2D IRON, 2D SENSE Series 21, LIGHT and FLASH have inbuilt GPINs that could be used for this purpose. If there is no inbuilt GPIN, then external GPINs from TBS 'Controller Lite' or 'Controller SMART+' should be used.
Its possible to define separate GPIN for receiving granted and denied access feedback. In this case, the transaction process will finish quickly. Alternatively, its possible to receive feedback only with one GPIN configured. For example if only granted feedback GPIN is configured, the device will treat request as granted if the GPIN is triggered otherwise will reject access after the configured timeout. Below is a brief description of the fields:
Output type: Its set to default 'Wiegand' and settings could be configured under Wiegand Output section.
general purpose input:
GPin for granted: If this GPIN is triggered active during authorization phase by controller GPOUT, the device grants access.
GPin for granted: This GPIN is used to receive the denied feedback signal.
Delay in reading ...: Delay in milliseconds after which the GPIN status will be read by the device.
Triggering level: By default its Low to High, but could be configured to High to Low based on the controller GPOUT characteristics.
Timeout: The maximum wait time for the feedback on the GPIN. If no response is received within this period, the transaction is denied.
Wiegand output: This section allows customization of the Wiegand output data according to project specifications.
4. Connection Diagram
Provided below the connection block diagram for I/O authorization to receive positive feedback on the 3D AIR Gen3 terminal. For detailed information on GPIN characteristics, please refer to the AIR Installation manual.
Related Articles
HowTo - Activate and configure the OSDP extension
This article provides an introduction to OSDP extension and explains how to activate and configure it on the TBS devices. Introduction The OSDP (Open Supervised Device Protocol) is an Industry standard protocol designed to connect field devices with ...FAQ - Client Registration procedure in BME with device and BCS
This article explains the registration procedure for Clients (Devices, BCS) in BME. The registration process has been simplified in the BME using the activation code. During registration, the certificate, license and other details are automatically ...FAQ - Device error code description
Question How to interpret the error codes reported on device and resolve them? Answer The following table provides brief description of device error codes. Error code Description Resolution 0 No error. 1 General error. 42 Sensor image caching (sensor ...HowTo - Resolve 3D sensor errors
The sensor in 3D AIR (Model 2012, former 3D TERMINAL) is not working stably and sensor runtime issues are reported regularly Solution If firmware is not able to load sensor at startup or report sensor run-time issues (error codes 42/412/414), it may ...HowTo - Resolve 3D finger positioning problems
I am not able to position finger properly inside the 3D sensor, how to resolve it? If users are not able to position finger properly inside the 3D sensor, this could be caused by improper sensor calibration. You can resolve it by following below ...