Page tree


User Manual

 

IDTECH OPOS

F or SmartPIN L100 device

USB - HID, RS232

 

 

 

 

 

80141503-001

Rev. A

 

05/11/2016

 

 

 

 

 

 

 

 

IDTECH SOFTWARE LICENSE AGREEMENT

 

ID TECH ("LICENSOR") IS WILLING TO LICENSE THIS SOFTWARE TO YOU ONLY IF YOU ACCEPT ALL OF THE TERMS IN THIS LICENSE AGREEMENT. PLEASE READ THE TERMS CAREFULLY BEFORE YOU AGREE BECAUSE YOU WILL BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THESE TERMS, LICENSOR WILL NOT LICENSE THIS SOFTWARE TO YOU.

 

Ownership of the Software

1.  The Licensor software program ("Software") and any accompanying written materials are owned by Licensor [or its suppliers] and are protected by United States copyright laws, by laws of other nations, and by international treaties.

 

Grant of License

2.  Licensor grants the right to use the Software in conjunction with an ID TECH product. You may load one copy into permanent memory of one computer and may use that copy only on that same computer.

 

Restrictions on Use and Transfer

3.  The Software may not be copied, except that (1) one copy of the Software may be made solely for backup or archival purposes, and (2) the Software may be transfer to a single hard disk provided the original is kept solely for backup or archival purposes.  The written materials may not be copied.

 

4.  The Software may be permanently transferred and any accompanying written materials (including the most recent update and all prior versions) if no copies are retained and the transferee agrees to be bound by the terms of this Agreement.  Such a transfer terminates your license. The software may not be rented or leased or otherwise transferred or assigned the right to use the Software, except as stated in this paragraph.

 

5. The software may not be reverse engineered, decompiled, or disassembled.

 

Limited Warranty

6.  If used in conjunction with an ID TECH product, Licensor warrants that the Software will perform substantially in accordance with the accompanying written materials for a period of 90 days from the date of your receipt of the Software. Any implied warranties on the Software are limited to 90 days. Some states and territories do not allow limitations on duration of an implied warranty, so the above limitation may not apply to you.

7.  LICENSOR DISCLAIMS ALL OTHER WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT, WITH RESPECT TO THE SOFTWARE AND ANY ACCOMPANYING WRITTEN MATERIALS. This limited warranty gives you specific legal rights. You may have others, which vary from state to state.

 

8.  LICENSOR'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL BE REPLACEMENT OF THE SOFTWARE THAT DOES NOT MEET LICENSOR'S LIMITED WARRANTY. Any replacement Software will be warranted for the remainder of the original warranty period or 30 days, whichever is longer.

 

9.  This Limited Warranty is void if failure of the Software has resulted from modification, accident, abuse, or misapplication.

 

10.  IN NO EVENT WILL LICENSOR BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY LOSS OF PROFITS, LOST SAVINGS, OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE SOFTWARE. Because some states do not allow the exclusion or limitation of liability for consequential or incidental damages, the above limitation may not apply you.

 

11.  This Agreement is governed by the laws of the state of California.

 

12.  For any questions concerning this Agreement or to contact Licensor for any reason, please write:  International Technologies & Systems Corporation, 10721 Walker Street, Cypress, CA 90630 or call (714) 761-6368.

 

13.  U.S. Government Restricted Rights. The Software and documentation are provided with Restricted Rights. Use, duplication, or disclosure by the Government is subject to restrictions set forth in subparagraph (c)(1) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c)(1)(ii) and (2) of Commercial Computer Software - Restricted Rights at 48 CFR 52.227-19, as applicable. Supplier is ID TECH, 10721 Walker Street, Cypress, CA 90630.
Revision History

Revision Date

Description

05/06/ 2016

Initial Draft

 

 

 

 

 

Abbr

POS Point of Service

UPOS Unified POS

OPOS OLE for Point of Service

COM Component Object Model

OLE Object Linking and Embedding

CO Control Object

SO Service Object

USB Universal Serial Bus

PIN Personal Identification Number

MSR Magnetic Stripe Reader

R/W Reader/Writer

SC Smart Card

DUKPT Derived Unique Key Per Transaction

Reference & Standard

1. Unified POS Retail Peripheral Architecture Version 1.1 3

2. International Standard for Implementation of Point Of Service Peripherals

Introduction

OPOS is an OLE implementation of UPOS, it featured in supplying a programming interface and architecture to make the user application easy to use the device, and make the user’s application is independent from any specified device. This document describe s the features and limitation of PINPad class ,uSign class and MSR class for ID TECH SmartPIN L100 device . These OPOSes share the communication settings in the Windows Registry.

All OPOS are compatible with UPOS v1.1 3 .

Registry Communication Settings

All OPOSes for SmartPIN L100 share the communication setting of serial port or USB HID , that is stored at Windows Registry:

For PINPad RS232 OPOS:

[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\PINPad\SmartPIN_L100_RS232]

 

 

For PINPad USBHID OPOS:

[HKEY_LOCAL_MACHINE\SOFTWARE\OLEforRetail\ServiceOPOS\PINPad\SmartPIN_L100_HID]

 

PINPAD OPOS

Description

The documentation describes the properties, methods, and events of OPOS PINPad component for IDTECH SmartPIN L100. The component includes two parts: a Control Object running on the upper level, which is an ActiveX control, and a Service Control running on the lower level, which is an automation server. The properties, methods, and events are exposed by the Control Object. For example, when the Control Object is imported into your project as an ActiveX control, you will see all the properties, methods, and events.

 

Target Device

SmartPIN L100 , interface: RS232 or USBHID.

Target Host System

Microsoft Windows 7 32bit, Vista 32bit, XP 32bit, 2000, 98.
Microsoft Windows 7 64bit, Vista 64bit.
Service Object and Control Object:
Service Object Version: 1. 0 . 1 .0   Dll File Version: 1.0.0
Control Object Version:1.13.001

Features

1. Support DUKPT PINPad system.

Installation

Just double click the setup program and follow the installation wizard. The device’s USB driver should be installed, if the device is USB interface. Modify the default value of communication settings. The default settings is installed after setup. If the firmware’s default value is changed, the settings must be modified correspondingly. Modify setting by Regedit.exe. See “ Registry Communication Settings

Properties, Methods and Events

This section describe methods, properties, and events.

Properties

Please see OPOS PINPad Spec if the detailed information is wanted.

Name

Type

Mutability

Supported?

AutoDisable

boolean

read-write

not support

CapCompareFirmwareVersion

boolean

read-only

not support

CapPowerReporting

int32

read-only

not support

CapStatisticsReporting

boolean

read-only

not support

CapUpdateFirmware

boolean

read-only

not support

CapUpdateStatistics

boolean

read-only

not support

CheckHealthText

string

read-only

support

Claimed

boolean

read-only

support

DataCount

int32

read-only

support

DataEventEnabled

boolean

read-write

support

DeviceEnabled

boolean

read-write

support

FreezeEvents

boolean

read-write

support

OutputID

int32

read-only

not support

PowerNotify

int32

read-write

not support

PowerState

int32

read-only

not support

State

int32

read-only

support

DeviceControlDescription

string

read-only

support

DeviceControlVersion

int32

read-only

support

DeviceServiceDescription

string

read-only

support

DeviceServiceVersion

int32

read-only

support

PhysicalDeviceDescription

string

read-only

support

PhysicalDeviceName

string

read-only

support

CapDisplay

int32

read-only

support

Capkeyboard

boolean

read-only

not support

CapLanguage

int32

read-only

support

CapMACCalculation

boolean

read-only

not support

CapTone

boolean

read-only

not support

AccountNumber

string

read-write

support

AdditionalSecurityinformation

string

read-only

support

Amount

currency

read-write

support

AvailableLanguagesList

string

read-only

support

AvailablePromptsList

string

read-only

support

EncryptedPIN

string

read-only

support

Maximum PINLength

int32

read-write

support

MinimumPINLength

int32

read -write

support

MerchantID

string

read- write

support

PINEntryEnabled

boolean

read-only

support

Prompt

int32

read- write

support

PromptLanguage

nls

read- write

support

TerminalID

string

read-write

support

Track1Data

binary

read-write

not support

Track2Data

binary

read-write

not support

Track3Data

binary

read-write

not support

Track4Data

binary

read-write

not support

TransactionType

string

read- write

support

 

Methods

Please see OPOS PINPad Spec if the detailed information is wanted.

Name

Supported?

Open

support

Close

support

Claim

support

Release

support

Checkhealth

support

clearInput

support

clearInputProperties

support

clearOutput

not support

compareFirmwareVersion

not support

resetStatistics

not support

retrivevStatistics

not support

updateFirmware

not support

updateStatistics

not support

beginEFTTransaction

support

CapMAC

not support

enablePINEntry

support

endEFTTransaction

support

updateKey

not support

verifyMAC

not support

 

Open (LPCTSTR DeviceName)

Parameter: DeviceName, the “SmartPIN_L100_RS 232 for RS232 interface device , and the “SmartPIN_L100_HID” for USBHID interface device.

Return: OPOS_SUCCESS if every thing works, or OPOS error code (see UPOS Specification).

Events

These events are fired by the Service Object when it is necessary. The following functions are, in fact, the event-handlers that can be added into the applications. Then the applications can receive these events and do some processing accordingly. Please see OPOS PINPad Spec if the detailed information is wanted.

Name

             Usage

DataEvent

support

ErrorEvent

support

DirectIOEvent

not support

OutputCompleteEvent

not support

StatusUpdateEvent

not support

 

Example in Visual C++ 6. 0

Create a Dialog based MFC application. And then click VC IDE menu “Project/Add to Project/Components and Controls…” to the OPOS PINPad ActiveX control to the project. The following code shows the simple example.

 

void CTestDlg::OnDataEventPinpad1(long Status)

{

TRACE("PIN %s\n", m_pinpad.GetEncryptedPIN());

TRACE("Security Information %s\n", m_pinpad.GetAdditionalSecurityInformation() );

if (m_pinpad.EndEFTTransaction(1) != OPOS_SUCCESS) {

// fail

return;

}

}

 

void CTestDlg::OnButton1()

{

if (m_pinpad.Open("SmartPIN_L100_RS232 ") != OPOS_SUCCESS) {

// "Fail to open pinpad"

return ;

}

if ( m_pinpad.ClaimDevice(1000) != OPOS_SUCCESS) {

// Fail to claim

return ;

}

m_pinpad.SetDeviceEnabled(TRUE);

if (m_pinpad.GetResultCode() != OPOS_SUCCESS) {

// fail to claim.

return;

}

m_pinpad.SetDataEventEnabled(TRUE);

if (m_pinpad.GetResultCode() != OPOS_SUCCESS) {

// fail to claim.

return;

}

m_pinpad.SetAccountNumber("1234567890123456");

if ( m_pinpad.GetResultCode() != OPOS_SUCCESS) {

// fail to set account number

return;

}

if (m_pinpad.BeginEFTTransaction("DUKPT", 1) != OPOS_SUCCESS)  {

// fail

return;

}

if (m_pinpad.EnablePINEntry() != OPOS_SUCCESS) {

// fail

return;

}

}

 

void CTestDlg::OnButton2()

{

// TODO: Add your control notification handler code here

m_pinpad.Close();

}