Wiegand interface settings

A list of all valid configuration settings relating to the Wiegand interface for use in the config.txt file.

Note: The Wiegand interface is only available on VTAP100-PAC-W hardware.

If WiegandMode=1 and WiegandSource is set, you can open an application on the computer connected to the VTAP reader, and pass or card data that is read will be sent over the Wiegand interface. WiegandSource determines whether data is sent over the Wiegand interface only when there are mobile pass reads, or cards/tag reads too.

PassFormat allows you to choose to interpret ASCII pass data as hex or decimal. By default 56 bits of data will be passed over the Wiegand interface, but you can change this by setting PassWiegandBits. The setting PassWiegandParity allows you to pad mobile pass data with zeroes, to imitate the inclusion of parity bits. This makes the pass data interchangeable that from with cards/tags which include parity bits, as long as parity is not being tested for validity.

When WiegandPassMode=1 you can use all of the other settings beginning WiegandPass... to extract only part of the mobile pass data. To do this you have to start by identifying a separator character in the data as WiegandPassSeparator. This allows the data to be regarded as a set of sections that can be identified by number. By identifying a WiegandPassContentSeparator this process can be repeated at a lower level, within a section. There is a simple example in the section Extract only part of the pass data.

Settings below: WiegandMode | WiegandInputEnable | WiegandPassContentMode | WiegandPassContentSection | WiegandPassContentSeparator | WiegandPassLength | WiegandPassMode | WiegandPassSection | WiegandPassSeparator | WiegandPassStart | WiegandPassTypeIdent | WiegandPaddingMode | PassFormat | PassWiegandBits | PassWiegandParity | TagWiegandASCIIFormat | TagWiegandBits | TagWiegandParity | WiegandSource

WiegandMode
Definition:

Activate the Wiegand interface for receiving mobile pass data.

Options:

=1 sends VTAP data to the Wiegand interface,
=0 switches it off (default)

Default value: =0
Example value: =1
WiegandInputEnable
Definition:

Control the VTAP response to Wiegand red, green and beep input signals, from a door controller.

Options:

=81 (default) means that the VTAP will receive both beep and red and green LED inputs,
=0 prevents any use of these inputs.

To drive VTAP responses (beep and LEDs) you must also have WiegandMode=1.

Default value: =81
Example value: =0
WiegandPassContentMode
Definition:

Turns on a subdivision of a data section into content sections.

Options:

=0 off (default),
=1 on.

To use this mode you must also supply WiegandPassContentSeparator if the default % is not the separator you want to use and WiegandPassContentSection.

Default value: =0
Example value: =1
WiegandPassContentSection
Definition:

Identifies the content section of interest, based on finding WiegandPassContentSeparator characters. The first content section, before the first separator, is numbered 0.

Options:

Only used if WiegandPassContentMode=1 and WiegandPassContentSection is set

Default value: =0
Example value: =1
WiegandPassContentSeparator
Definition:

Identifies the content separator character in the data which bounds content sections.

Options:

Only used if WiegandPassContentMode=1 and WiegandPassContentSection is set.

Default value: =%
Example value: =%
WiegandPassLength
Definition:

Number of characters of data to extract, starting from the position defined by WiegandPassStart.

Options:

Defaults to 0 meaning do not truncate data, send all available characters from the pass data, or extracted section of pass data.

Default value: =0
Example value: =10
WiegandPassMode
Definition:

Sets whether to extract parts of the data from the mobile NFC pass.

Options:

=0 does not extract a character delimited section of the pass payload (WiegandPassSection is ignored).
=1 uses the WiegandPassSection value to extract a character delimited section of the pass payload.

Default value: =0
Example value: =1
WiegandPassSection
Definition:

Identifies the section of interest, based on finding WiegandPassSeparator characters. The first section, before the first separator, is numbered 0.

Options:

Only used if WiegandPassMode=1.

Default value: =0
Example value: =2
WiegandPassSeparator
Definition:

Identifies the separator character in the data which bounds sections.

Options:

Only used if WiegandPassMode=1 and WiegandPassSection is set.

Default value: =|
Example value: =|
WiegandPassStart
Definition:

Number of characters into string to start extracting data, where first character is 0.

Options:

May be used in conjunction with WiegandPassLength.

Default value: =0
Example value: =5
WiegandPassTypeIdent
Definition:

Inserts an additional leading byte of pass type identifier information in the Wiegand output. Either 01 for Apple VAS, or 02 for Google ST. This allows the controller or application receiving the Wiegand data (via a door controller) to distinguish between cards/tags and mobile wallet passes, as well as identifying the wallet type (Google or Apple) for reporting purposes.

Options:

=0 disabled or
=1 add the pass type identifier.

When this option is used, the Wiegand bit length is fixed to 56 bits + 8 bits type identifier = 64 bits total, so PassWiegandBits is ignored, if this option is enabled.

Default value: =0
Example value: =1
WiegandPaddingMode
Definition:

Controls where to apply padding zero bits when converting ASCII hexadecimal data which does not contain sufficient hex digits to produce the configured Wiegand bit length. Zeros can be added to LS (default) or MS end.

Options:

=0 LS end padding (default),
=1 MS end padding.

Default value: =0
Example value: =1
PassFormat
Definition:

Choose to interpret ASCII pass data characters as either hex or decimal, when converting the pass data to a Wiegand bit sequence.

Options:

=d for a decimal 64 bit number, from which the appropriate number of bits are output to Wiegand;
=h for hexadecimal, converted to a byte sequence from which the appropriate number of bits are output. (These lengths are both controlled by WiegandPassBits).

Default value: =h
Example value: =d
PassWiegandBits
Definition:

Specify the number of bits to output over the Wiegand interface from the start of the filtered pass data, where it otherwise defaults to 56.

Options:

=1 to =255 number of bits required. (Note: This number includes any parity bits.)

Default value: =56
Example value: =64
New options from v2.2.6.0
PassWiegandParity
Definition:

Adds calculated parity bits, or the equivalent of parity bits, to decimal pass data. This makes it possible to use mobile pass data formats that include parity bits. Parity bit equivalents can be used if the parity bit(s) are not being tested for validity. This is the same as bitwise left‑shifting the data by the given number of bits within the 64 bit result.

Options:

=1 Adds a single bit of 0 padding (for example in lieu of parity bits) to the least significant end of the data.
Used with PassFormat=d or PassFormat=h.

=2 Adds calculated odd and even parity bits to Wiegand data. Used with either PassFormat=d or PassFormat=h data of any length, defined by PassWiegandBits. In this calculation the MS parity bit is calculated from the left half of the bits and the LS parity calculated from the right half of the bits, with the centre bit included in both calculations.

Default value: =0
Example value: =2
TagWiegandASCIIFormat
Definition:

Defines how to interpret ASCII tag or card data for output over a Wiegand interface.

Options:

=d is decimal
=h is hexadecimal
=a means ASCII (default)

Default value: =a
Example value: =d
TagWiegandBits
Definition:

Specify the number of bits to output over the Wiegand interface from the start of the extracted tag data, where it otherwise defaults to 56. Or allow the number of bits to be automatically determined from the data.

Options:

=0 to automatically determine the bit length from the extracted data, or
=1 to =255 to set to the number of bits required. (Note: This number includes any parity bits.)

Default value: =0
Example value: =64
New options from v2.2.6.0
TagWiegandParity
Definition:

Adds calculated parity bits, or the equivalent of parity bits, to decimal tag data. This makes it possible to use tag or card data formats that include parity bits. Parity bit equivalents can be used if the parity bit(s) are not being tested for validity. This is the same as bitwise left-shifting the data by the given number of bits.

Options:

=1 Adds a single bit of 0 padding (for example in lieu of parity bits) to the least significant end of the data.
Used with TagReadFormat=a and TagWiegandASCIIFormat=d to get decimal data, or TagWiegandASCIIFormat=h.

=2 Adds calculated odd and even parity bits to Wiegand data. Used with either TagWiegandFormat=d or TagWiegandFormat=h data of any length, defined by TagWiegandBits.

Default value: =0
Example value: =2
WiegandSource
Definition:

WiegandSource controls which types of event data (pass reads, card/tag reads, serial commands) go to the Wiegand interface.

Options:

The values are determined from a bitwise combination of the following hexadecimal values. Source options include these bit values for mobile passes and tag UIDs:
Bit 7 (0x80) = Mobile Pass (Apple VAS/Google Wallet Smart Tap)
Bit 6 (0x40) = STUID
Bit 5 (0x20) = Write to card emulation mode (CardEmulationMode=1 see VTAP NFC tag emulation settings)
Bit 4 (0x10) = RFU
Bit 3 (0x08) = RFU
Bit 2 (0x04) = Scanners
Bit 1 (0x02) = Command interface messages (>interface:type:message see Dynamic configuration commands)
Bit 0 (0x01) = Card/Tag UID

Note: If scanner data is sent to the VTAP Wiegand interface, the barcode data is assumed to be a sequence of bytes as ASCII hex digits. The first byte indicates the Wiegand bit length and subsequent bytes contain the Wiegand bit pattern.

Default value: =A5
Example value:

=80 (hex) will send only mobile NFC pass data
=A1 to send data from NFC passes and NFC cards/tags and card emulation
=83 to send passes, cards/tags and serial commands