OSDP interface settings

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

Note: OSDP functionality is only supported on VTAP50 v2 hardware onwards and VTAP100 v5 hardware onwards

Note: You can use OSDP on any serial interface although using this protocol on the Serial2 RS-485 interface is the most common scenario, creating an RS-485 OSDP connection between a reader and door controller. To use OSDP on a different interface just substitute Serial2... in the settings for Serial... or COMPort...

In order to use these commands, you should first ensure that you have enabled Serial2 as an RS-485 interface using Serial2RS485=1, permit the sending of pass card/tag payloads over the Serial2 interface using Serial2Source=A1 and chosen appropriate settings for Serial2Settings to match the required interface speed.

Settings below: Serial2OSDP | Serial2OSDPAddress | Serial2OSDPKeySlot | Serial2OSDPFormat | Serial2OSDPSecureOnly

Serial2OSDP
Definition:

Enable or disable use of OSDP on the Serial2 interface.

Options:

=1 enables OSDP on the Serial2 interface,
=0 disables OSDP on the Serial2 interface (default)

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

Assigns the VTAP reader a numerical address, as a peripheral device under OSDP

Options:

Value 0 to 126

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

Assigns any one of the 9 available encryption key slots, as the one to be used to hold the OSDP Secure Channel Base key

Options:

=1 to =9, to refer to the application key files uploaded as appkey1.txt through appkey9.txt
=0 no key slot specified, implies not secure channel

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

Choose ASCII or Wiegand (raw) format for payload

Options:

=Wiegand, where the output will be a binary number comprised of a bit count and bit stream

Any value other than =Wiegand will output the tag data as ASCII text (not zero terminated). This can include the following values, used to define card event data to include, or require additional formatting of the output:

$d is the tag data,
$t would include the pass type ,
$$t would append '$t' to the output,
$t$n will follow the pass type character with a digit for VAS merchant ID/ST collector ID index (1 to 6) and a digit for keyslot used (1 to 6),
$u adds the UID as 8, 14 or 16 hex ASCII digits.
\n is a new line character,
\t is a tab character,
\\ would append '\' to the output.,
\0 is binary 0,
%XX , where XX is a two character hext digit representing the binary value of a character to use (URL encoding style),
%% would append '%' to the output.

(For a ClosedPass type explainer - click here)

Pass type character

Pass type is a single character to describe the source of a received pass payload, which may be an Apple VAS pass or Google ST pass, a particular type of NFC card, or other source such as a barcode scanner. The values that returned are:

A - Apple VAS pass
G - Google ST pass
0 - MIFARE card/tag
2 - NFC type 2 card/tag
4 - NFC type 4 card/tag
6 - NFC type 5 card/tag
E - Card emulation
Q - Scanner input
X - Apple Wallet Access iPhone
W - Apple Wallet Access Watch

Default output, if this setting is omitted or no value is set, is equivalent to setting =$t$n:$d which will return data in the form A16:123456 where the tag data is 123456

Default value: =$t$n:$d
Example value:

=Wiegand
=start:$d:end ; returns 'start:123456:end' if 123456 is the tag data

Serial2OSDPSecureOnly
Definition:

Used to require that only the Secure profile is used, after initialisation.

Options:

=1 is enabled to enforce secure mode.
=0 is not enabled. It is possible that the implementation of OSDP on the controller would allow the VTAP reader to fall back to using the Basic profile, if Secure credentials failed.

Default value: =1
Example value: =0