Bluetooth BLE keyboard emulation settings
A list of all valid configuration settings for the config.txt file which relate to sending pass information over a BLE keyboard emulation interface, when the VTAP PRO is in Local mode.
Note: Bluetooth is only available on VTAP100-PRO-BW hardware.
BTKeyboardMode enables/disables the BLE keyboard emulation. When enabled, you can pair and connect the VTAP reader with a Bluetooth host device (such as a tablet or laptop), and start receiving the pass or card data on the text editor or other application that expects to receive a keyboard input. Like USB keyboard emulation, you need to ensure your cursor is at the right place (in an appropriate app) to receive the input.
When scanning for pairing or connecting, the VTAP PRO name will match its 'VTAP label' (check boot.txt or label on the bottom or the case for this serial number). By default no PIN is set, so the host device can automatically pair and connect to the VTAP PRO. Should you need to change the Bluetooth name for your VTAP PRO, use BTKeyboardName. If you want to add a PIN for pairing set BTKeyboardPIN.
BTKeyboardSource determines whether BLE keyboard mode responds to only mobile pass reads, or card/tag reads too. You might need a BTKeyboardDelayMS value to insert a delay between key presses, to suit your receiving application
BTKeyboardPrefix and BTKeyboardPostfix can be optionally used to add extra characters before or after a pass read, to suit your application.
When BTKeyboardPassMode=1, a character delimited section of the pass payload will be extracted. The delimiting character defaults to | but this can be changed to another character using BTKeyboardPassSeparator. The payload is then considered as comprising a number of sections, any of which can be selected using BTKeyboardPassSection. By identifying a BTKeyboardContentSeparator this process can be repeated at a lower level, within a section. This follows the same approach as over a USB keyboard emulation, for which there is a simple example in the section Extract only part of the pass data.
Settings below:
BTKeyboardDelayMS | BTKeyboardMode | BTKeyboardName | BTKeyboardPassContentMode | BTKeyboardPassContentSection | BTKeyboardPassContentSeparator | BTKeyboardPassLength | BTKeyboardPassMode | BTKeyboardPassSection | BTKeyboardPassSeparator | BTKeyboardPassStart | BTKeyboardPIN | BTKeyboardPostfix | BTKeyboardPrefix | BTKeyboardSource
Definition:
Inserts a number of milliseconds delay between key down and key up in the BLE keyboard output.
Options:
Adjust to suit your receiving application between 5ms and 255ms.
Default value: =5
Example value: =10
Definition:
Turns BLE keyboard emulation on or off.
Options:
=1 enables BLE keyboard emulation,
=0 switches it off (default)
Default value: =0
Example value: =1
Definition:
This is the name that the VTAP BLE keyboard will advertise for discovery by a host device.
Options:
Up to 15 characters. If something longer is set it will be truncated.
Defaults to the VTAP assigned serial number. (VTAP Label value in boot.txt.)
Default value: =<VTAP Label>
Example value: =CC123456
BTKeyboardPassContentMode
Definition:
Turns on a subdivision of a data section into smaller content sections.
Options:
=0 off (default),
=1 on
To use this mode you must also supply BTKeyboardPassContentSeparator if the default % is not the separator you want to use and BTKeyboardPassContentSection.
Default value: =0
Example value: =1
BTKeyboardPassContentSection
Definition:
Identifies the content section of interest, by finding BTKeyboardPassContentSeparator characters. The first content section, before the first separator, is numbered 0.
Options:
Used only if BTKeyboardPassContentMode=1.
Default value: =0
Example value: =1
BTKeyboardPassContentSeparator
Definition:
Identifies the content separator character in the data which bounds content sections.
Options:
Used only if BTKeyboardPassContentMode=1 and a BTKeyboardPassContentSection is set.
Default value: =%
Example value: =%
Definition:
Number of characters of data to extract, starting from the position defined by BTKeyboardPassStart.
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
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 (BTKeyboardPassSection is ignored).
=1 uses the BTKeyboardPassSection value to extract a character delimited section of the pass payload.
Default value: =0
Example value: =1
Definition:
Identifies the section of interest, based on finding BTKeyboardPassSeparator characters. The first section, before the first separator, is numbered 0.
Options:
Used only if BTKeyboardPassMode=1.
Default value: =0
Example value: =2
Definition:
Identifies the separator character in the data which bounds sections.
Options:
Used only if BTKeyboardPassMode=1 and a BTKeyboardPassSection is set.
Default value: =|
Example value: =|
Definition:
Number of characters into pass data to start reading, where first character is 0.
Options:
May be used with BTKeyboardPassLength.
Default value: =0
Example value: =5
Definition:
Optional PIN for pairing the VTAP PRO reader with host device such as PC or tablet.
Options:
Numeric, 6 digits. By default a PIN is not set.
If a PIN of less than 6 digits is set, that PIN will be padded with leading zeros.
So, if you set BTKeyboardPIN=1234, your PIN will actually be 001234.
Default value: N/A
Example value: =123456
Definition:
Adds special characters after BLE keyboard data, if needed.
Options:
Use standard
ASCII hex characters to describe the keystrokes to append.
%0D in the example adds a carriage return after the data,
%0A adds a new line after every pass or tag entry.
$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.
(For a Pass 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 value: =%0A
Example value: =end%0D
Definition:
Adds special characters before BLE keyboard data, if needed.
Options:
Use standard ASCII hex characters to describe the keystrokes to append.
%0A in the example adds a new line linefeed before the data.
$t would include the pass type .
$$t would prefix the output with '$t'.
$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.
(For a Pass 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 value: [Empty]
Example value: =%0Astart
Definition:
Controls which types of event data (pass reads, card/tag reads, serial commands) are sent as a BLE keyboard entries.
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
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