Advertisement

Quick Links

Integration Guide -
Serial Integration Guide
Firmware from v2.2.2.1
VTAP50 and VTAP100
Revised November 2023 v1.01

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the VTAP Series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Dot Origin VTAP Series

  • Page 1 Integration Guide - Serial Integration Guide Firmware from v2.2.2.1 VTAP50 and VTAP100 Revised November 2023 v1.01...
  • Page 2 No part of this Integration Guide may be published or reproduced without the written permission of Dot Origin Ltd except for personal use. This Integration Guide relates to correct use of the VTAP reader only. No liability can be accepted under any circumstances relating to the operation of the user’s own PC, network or infrastructure.
  • Page 3: Table Of Contents

    4  Sending commands to a VTAP reader 4.1 Data request commands 4.2 Dynamic commands 4.3 Remote management commands 5  Use an interface in passive mode 6  Transfer files over a command interface 7  About this Integration Guide SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE I...
  • Page 4: Integrating Vtap With Other Systems

    Guide deals with the essential functions of a VTAP reader for this situation. Detecting a reader is present; Reading data from the VTAP reader; Changing configuration file settings for reading passes, cards or tags, and providing the configured user feedback; SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 1...
  • Page 5: Advanced - Usb Com, Serial Rs232 Or Rs485 Communications

    Transfer files - either firmware or configuration files. After considering your choice(s) of interface, this Integration Guide will look at the best approach for each of these types of action one by one. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 2...
  • Page 6: Choice Of Interface

    3. Pass payload, sending commands and file transfer all use a single type of serial port, in passive mode. (If you are using command-response actions and receiving routine data on the same interface, choose passive mode to avoid the risk of pass reads interrupting other actions.) SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 3...
  • Page 7 Your preference is likely to be driven by your existing systems, and in-house technical expertise. If you need pinouts and hardware connection information please refer to the Installation Guide for your VTAP reader (available on https://vtapnfc.com). SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 4...
  • Page 8: Interfaces To Receive Data From The Vtap Reader

    Windows - difficulties for communication is in only one direction at a time. automating file transfer •May be file caching issues where a deleted file is only detected by the operating system on reboot/remount SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 5...
  • Page 9: Available Interfaces On The Vtap Models

    Available Available - Available - VTAP100-OEM Available Available - VTAP100-USB-CC Available Available - Available Available - VTAP100-PAC-485-CC Available Available - Available - VTAP100-PAC-W Available Available - Available - Available VTAP100-PRO (Coming soon) SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 6...
  • Page 10: Receiving Pass Payload From A Vtap Reader

    This Integration Guide discusses the integration and operational aspects of using the serial interfaces, including RS232 and RS485. It includes using the VTAP interfaces for sending commands, which may be required for your integration and custom software development. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 7...
  • Page 11: Send Pass Payload Over A Serial Rs232 Or Ttl Interface

    Use the setting SerialSource in config.txt to restrict the types of data to be passed through the serial RS232 interface, if needed. The default value is A1, which allows every mobile pass or card/tag read, all commands and interface messages. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 8...
  • Page 12 80 corresponds to choosing 1000 0011 in the table above. You could add extra prefix or postfix characters (up to 16 characters) to the data being sent, using SerialPrefix or SerialPostfix settings. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 9...
  • Page 13 After changing these Serial... settings in config.txt and saving it (if something other than default behaviour is required), you can start reading pass payloads over the serial RS232 interface, in either active or passive mode. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 10...
  • Page 14 VTAP reader which is not accessible over USB. Section 5 details how to Use an interface in passive mode, and important factors to bear in mind when using this approach. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 11...
  • Page 15: Send Pass Payload Over A Serial Rs485 Interface

    Serial2Prefix or Serial2Postfix settings. This setting works in the same way as Serial2Source for RS232. Refer to SerialPrefix and SerialPostfix syntax in the previous section for more, if this is needed for your application. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 12...
  • Page 16 You can then modify or add any of the Serial2... settings by sending them as a command over the serial RS485 interface. This is useful if you need to change a setting value on a VTAP reader which is not accessible over USB. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 13...
  • Page 17: Sending Commands To A Vtap Reader

    The following sections discuss the use of different types of commands, during integration or operation, over the ComPort, RS232 or RS485 interfaces. The full list of possible commands is provided in the VTAP Commands Reference Guide. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 14...
  • Page 18: Data Request Commands

    This command can be used in both active and passive mode. Example: Send %PassLED to get the value for the LED response pattern set for a successful pass read %PassLED This will result in a VTAP response such as: PassLED=00FF00,100,50,2 SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 15...
  • Page 19 Use the ?temp command to retrieve the internal temperature (in Celsius) of the VTAP reader . Example: Send %temp to check the internal temperature of the VTAP reader ?temp This will result in a VTAP response such as: 40.41C SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 16...
  • Page 20: Dynamic Commands

    VTAP reader. Send an emulated NFC pass or card UID, during testing, to see if the device connected on a particular interface reacts as required. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 17...
  • Page 21 .ini file. Multiple files describing complex LED patterns and sequences can be saved in the VTAP reader file system, and any one of those triggered using ?LEDR. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 18...
  • Page 22 For single a beep, use ?BEEPR <on time>. Example: Drive LEDs dynamically with ?LEDR command ?BEEPR 200,100,2 ; beep the buzzer twice, ; each time 200ms on and 100ms off. ?BEEPR 100 will beep the buzzer once for 100ms. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 19...
  • Page 23: Remote Management Commands

    Zmodem file transfer will begin and the file will be transferred. Use this command when you need to modify or add many settings in config.txt, or change patterns/animations in leds.ini. You could also use this setting to make a backup copy of the current config.txt or boot.txt. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 20...
  • Page 24: Use An Interface In Passive Mode

    VTAP reader (in passive mode) and a connected system (here a PC). This exchange retrieves the pass payload and pass type, when an Apple VAS pass is successfully presented to the VTAP reader: SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 21...
  • Page 25 SerialPostfix settings (and the equivalents for other interfaces). For this reason, if you have set $t to retrieve pass type with each pass read as a prefix/postfix in active mode, you must use ?type or ?t to separately retrieve this data in passive mode. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 22...
  • Page 26: Transfer Files Over A Command Interface

    Option 2: Implement your own code including actions that trigger a Zmodem transfer It is expected that developers would be more likely to implement their own code, which includes actions that trigger a Zmodem transfer. We generally recommend the use of our SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 23...
  • Page 27 We recommend that you set the interface you are using for a Zmodem transfer to passive mode, or receive routine pass (or card/tag) read data on a different interface. This is because user taps could interrupt other operations. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 24...
  • Page 28: About This Integration Guide

    If you need further help do contact us by email to vtap-support@dotorigin.com, or by phone +44 (0) 1428 685861 from Europe and Asia, or +1 (562) 262-9642 from Northern and Latin America. SERIAL INTEGRATION GUIDE © DOT ORIGIN PAGE 25...

This manual is also suitable for:

Vtap50Vtap100

Table of Contents