V-Series V30x Module Electrical, Physical Layer and Application Integration Guide

Transcription

1 Lumidigm V-Series V30x Module Electrical, Physical Layer and Application Integration Guide PLT-02218, Rev. A.0 December 2014 hidglobal.com

2 Contents 1 Overview The vcom Command Interface Application Development Approaches USB Connector Powering the V30x Module via the USB Connector Using the USB Connection for Sensor Communication Pin vcom Connector LED Indicator Connector Copyright Trademarks 2014 HID Global Corporation/ASSA ABLOY AB. All rights reserved. This document may not be reproduced, disseminated or republished in any form without the prior written permission of HID Global Corporation HID GLOBAL, HID, and the HID logo are the trademarks or registered trademarks of HID Global Corporation, or its licensors, in the U.S. and other countries. Lumidigm is a registered trademark of Lumidigm, Inc. Revision History Date Description Version 12/16/14 First release as part of HID Global (v1.5) A.0 Contacts For additional offices around the world, see corporate offices. North America & Corporate 611 Center Ridge Drive Austin, TX USA Phone: Fax: Lumidigm For Lumidigm specific issues: Website: Lumidigm@hidglobal.com Phone: HID Global Customer Support: support.hidglobal.com December 2014 Page 2 of 12

3 1 Overview The V-Series V30x module has three interface connections: USB Mini-B, 14-pin vcom, and a 4-pin LED indicator. The USB connection or the 14-pin vcom connection can be used for host-to-sensor command and data flow. The 4-pin LED connector is used for directing user action and providing feedback during image capture and matching. Figure 1: V30x module connectors All command and data traffic between the V30x module and the host system must conform to the Lumidigm vcom protocol described in the "The vcom Command Interface section of this document. The V30x module continuously monitors and responds to traffic conforming to the vcom protocol on the USB and RS-232 physical layer interfaces. While it is possible to simultaneously use multiple ports for vcom traffic, applications should be developed to use only one port to avoid contention. The 14-pin vcom connector can be configured to support RS-232 physical layer interfaces and can also be used to supply power to the device. The USB connection is used for USB 2.0 communication and can also supply power to the V30x module. This document contains the electrical and physical layer interface details of all three V30x module connectors as well as a brief on supported application development methods and information about the vcom command interface, Page 3 of 13 December 2014

4 2 The vcom Command Interface The vcom command interface is a protocol that allows low-level control of a sensor using this protocol. The protocol is sensor and physical layer independent, but because different physical layer interfaces operate at very different data transfer rates the latency involved in the command-response pair is dependent on interface type and interface speed. For the V30x module, the USB and RS-232 physical layer interfaces can be used for vcom transactions. It should be noted that applications developed on Windows PC platforms would not normally interact directly with the sensor using vcom but would use the Application Programming Interfaces (APIs) and drivers supplied in the Lumidigm Software Development Kit (SDK). This is the preferred method for application development on Windows PC platforms. The vcom-level interfaces should only be used for application development on other platforms. Please refer to the Application Development Approaches section of this document for more information. vcom is a layered protocol that consists of macro or application level commands, atomic or low-level configuration and control commands, database commands to maintain a local template store, and diagnostic commands used in manufacturing or to diagnose sensor faults. Macro level commands are very similar in function to the API level interface presented to Windows PC developers using the Lumidigm SDK. For more information about the vcom protocol please refer to the Lumidigm vcom Command Reference. For sample code please refer to the Lumidigm vcom Example. 3 Application Development Approaches Once one of the vcom ports is connected to a system, commands and data can be exchanged between the system and one or more V30x units. There are two different types of development approaches that can be used: Windows PC based development using Lumidigm provided drivers and Application Programming Interfaces (APIs) and non Windows PC based application development. V30x unit Windows PC Image Capture Customer Applications and GUI Lumidigm Demo Application and GUI vcom Control Interface Physical Layer Interface Lumidigm Application Protocol Interfaces (APIs) Image processing, Spoof, Feature Extraction, Matching, and other functions Physical layer interface & vcom Driver USB 2.0, rs232 Figure 2: Windows PC-based application development December 2014 Page 4 of 13

5 Windows-based applications use software provided by Lumidigm to communicate with the sensor and provide the sensor an independent set of APIs. This software is called the Software Development Kit (SDK). This SDK also contains a demonstration application and sample code to facilitate a quick start for application developers. All applications, including the demonstration application, use the Windows API approach to application integration. Integration Steps Install Lumidigm SDK on windows PC Use Lumidigm Demo Application to understand sensor operation Use Lumidigm APIs to write Customer application(s) using provided API call example code Customer Applications and GUI Windows PC Lumidigm Demo Application and GUI Lumidigm Application Protocol Interfaces (APIs) Image processing, Spoof, Feature Extraction, Matching, and other functions Physical layer interface & vcom Driver Figure 3: Windows PC-based development steps Non Windows PC based application development is also supported. In this case, a driver implementing the vcom protocol must be developed and linked to the target system s appropriate physical layer interface (USB, RS-232). Then, code must be developed that translates the vcom commands and data in order to provide services to applications and to link the V30x module to those applications through the driver. V30x Unit Image capture & Processing Customer Embedded Computing Platform Feature Extraction, 378 template creation, Spoof 1:1 or 1:N Match to Template Database or Customer app provided template(s) vcom Control Interface Physical layer Interface Customer Applications Customer developed vcom Control Interface Driver Physical Layer Driver USB 2.0 or RS-232 Figure 4: Non-Windows PC-based application development Page 5 of 13 December 2014

6 Integration Steps Determine overall system partitioning; which functions will be assigned to the Customer application and which to the V30x module Develop or purchase a standard USB or RS232 driver Using Lumidigm provided Control Interface Specification; develop a vcom Control Interface Driver Develop or connect the vcom control interface driver into the Customer application program(s) Customer Embedded Computing Platform Customer Applications Customer developed Vxxx Control Interface Driver USB or RS232 Driver Figure 5: Non-Windows PC-based development steps Lumidigm provides compiled drivers and APIs for Windows based PCs and source code for a generic vcom driver for customers developing non Windows PC based applications. In addition system integration, application development and porting services are available. Please contact your Lumidigm representative for more information. The V30xfamily contains several products intended for a variety of customer application use cases. The design process should begin at the system level and the key decision at this step is which system functions to assign to the V30x sensor and which to assign to which parts of the rest of the system. Once this decision is made the appropriate V30x part number can be determined. The primary function partitioning choices are; Image output will the sensor provide images to the customer application? If so the bandwidth of the physical interface needs careful consideration to insure total transaction times are fast enough to meet end customer expectations. Feature extraction will the sensor create biometric templates? Biometric verification will the sensor perform matching of the currently placed finger to a single selected biometric template? Biometric identification will the sensor match the currently place finger against a set of stored templates or a locally stored identification database? Template storage will the sensor template database be used for verification or identification functions? If so is the sensor template storage capacity sufficient for the application? And how will the application manage the sensor template database? December 2014 Page 6 of 13

7 The simplest and most cost effective partitioning approach would enable the sensor to perform all biometric functions augmented by some mechanism for managing the sensors template storage database. In addition to template management and the logic to control the sensor the customer application would provide all system level interfaces. As an example a biometric reader consisting of a sensor, card reader, and control board that is intended for connection to a legacy physical access control panel supporting the Wiegand protocol could be most cost effectively constructed as shown below. V30x Unit Image capture & Processing Feature Extraction and spoof detection 1:1 Verification to Customer application provided template vcom Control Interface Customer Embedded Computing Platform Control Logic Wiegand Driver vcom Driver Control Logic Wait for Card placement Extract template from card and send to sensor Arm sensor On finger placement match to template Based on match result from sensor send open signal to panel Physical Access Control Panel USB 2.0, rs232 Card Reader Driver Card Reader Figure 6: Integration example: card reader Page 7 of 13 December 2014

8 4 USB Connector The V30x module USB connector is an industry standard Mini-B plug that can be used to provide power for the module and is one of the three ports that can be used for commands and data traffic between the module and a host system using the Lumidigm vcom protocol. This connector is located on rear panel of the V30x module on the lower right side. Figure 7: V30x module USB mini-b connector 4.1 Powering the V30x Module via the USB Connector The USB connector or the 14pin connector can be used to provide power to the V30x module. In applications where the USB connection is used for power only, a standard wallmounted USB power supply or application-specific wiring is required. If application-specific wiring is used to supply power to the module, the 5V DC terminal is connected to Pin 1 and the ground (GND) connection is made to Pin 5 (see Figure 6 and Table 5). All other connections should be left open. The V30x module requires up to 500mA of source current from the USB connector and care should be taken to insure the connected PC or USB hub can supply a full 500mA to this device at 5V DC. Some hubs and PCs share USB power among multiple connectors. To determine the available current refer to the PC or hub manufacturers specifications for total current and subtract the maximum current required by all other connected devices. Pin Function 1 USB power + 2 Data - 3 Data + 4 N/C 5 USB power - 6 USB shield Table 1: USB mini-b pinouts Manufacturer: Molex, Part number December 2014 Page 8 of 13

9 4.2 Using the USB Connection for Sensor Communication The physical layer interface conforms to USB 2.0 and is capable of operation up to 480Mbps. In applications where the USB connector is being used for host-to-sensor data communication, cabling of any length that conforms to the USB 2.0 standard can be used. Once physical layer connections are made between the V30x module and the customer s system, commands and data can be transferred over the interface using the Lumidigm vcom protocol. Applications developed using the Lumidigm SDK (which installs required sensor drivers) and a Windows PC platform will communicate with the sensor with the provided APIs rather than vcom. Only non-windows PC application developers need to develop their own drivers and communicate with the sensor via vcom. Please refer to the Application Development Approaches section in this document for more information about application-to-sensor connectivity and application development options Pin vcom Connector The 14-pin vcom connector is used in applications requiring sensor control and dataflow over RS-232 physical layer interfaces and can also be used to provide power to the V30x module. Figure 8: V30x module 14-pin vcom connector The RS-232 connection is an industry standard interface and the implementation on the V30x module conforms to these standards. The interface speed for RS-232 is customerconfigurable using vcom commands. The default interface speed is 9600 bps and the maximum speed is 192 Kbps. In addition, the default RS-232 configuration is 8 bits data, 1 stop bit, and disabled flow control. The RS-232 connection supports software flow control (XON/XOFF). Page 9 of 13 December 2014

10 Customers must purchase connectors and wire them appropriately to connect their system to the V30x module The pinouts are identified in Table 2. The connector manufacturer and the number of the part used on the sensor also are shown. Lumidigm can provide customer-specific cabling for this connector. Please contact your Lumidigm representative for more information. Pin Function Pin Function 14 Ground 7 +5V 13 RS-232 TX 6 Ground 12 RS-232 RX 5 Ground 11 Ground 4 reserved 10 N/C 3 reserved 9 +5V 2 reserved 8 +5V 1 reserved Table 2: v pin vcom connector and pinouts Manufacturer: HIROSE, Part number DF13A-14P-1.25H(50) Once physical layer connections are made between the V30x module and the customer s system, commands and data can be transferred over the interface using the Lumidigm vcom protocol. Applications developed using the Lumidigm SDK (which installs required sensor drivers) and a Windows PC platform will communicate with the sensor with the provided APIs rather than vcom. Only non-windows PC application developers need to develop their own drivers and communicate with the sensor via vcom. Please refer to the Application Development Approaches section in this document for more information about application-to-sensor connectivity and application development options. December 2014 Page 10 of 13

11 6 LED Indicator Connector The LED connector on the V30x module is used by the sensor firmware to indicate operational status and to provide finger placement feedback to the user. Most OEM applications will integrate the V30x module into an enclosure with multiple components and user interfaces. This connector allows the system designer the flexibility to locate the indicators appropriate to the application or not use them at all. The LED indicators can be programmed either through the SDK or the vcom interface. Figure 9: V30x module 4-pin indicator connector Pin Function 1 USB Shield 2 Green LED+ 3 GND 4 Red LED+ Table 3: 4-pin LED indicator connector Manufacturer: HIROSE, Part number DF13A-4P-1.25H(50) Page 11 of 13 December 2014

12 hidglobal.com