Page tree


User Manual

 

 

SmartPIN L100

USB-HID, RS232

JPOS S ervice O bject R eference

 

 

 

 

 

80141504-001

Rev. A

 

05/11/20 1 6

 


Revision History

Revision Date

Description

05/05/ 2016

Initial Draft

 

 

 

 

 

 

 

 

Table of Contents

 

Introduction

System Requirements:

Reference Document:

Environment Build

Properties, Methods, Events

Run POSTest

A Sample for using PINPad JPOS


Introduction

This document provides information for us ing JPOS Service Object (SO) for SmartPIN L100 Device

System Requirements:

This JPOS Service Object is for Windows 7/8.

Reference Document:

1. Unified POS Retail Peripheral Architecture Version 1. 13

2. International Standard for Implementation of Point Of Service Peripherals

Environment Build

Install Sun JRE 1.5 32-bit or JDK 5.0 32-bit, JRE 6 32-bit or JDK 6 32-bit, JRE 7 32-bit or JDK 7 32-bit, JRE 8 32-bit or JDK 8 32-bit:

Download the newest JRE 1.8 installation package from : http://java.sun.com/j2s e /1. 5 .0/download.jsp , then click : JDK Download and select a proper platform JDK version to download. I nstall the package and m ake sure the "java" command functions properly . There may be a need to add the JRE bin directory into the system environments variables b y following steps:

F or Microsoft Windows XP

1. Right click "My Computer" in the desktop

2. Select the "properties" menu item

3. Select "Advanced" tab

4. Click button "Environment Variables"

5. Select "Path" and insert the JRE bin directory.

When Java is work ing , following can be observed :

E nter DOS command shell, and enter java. It show s information about how to use.

FILELISTS:

Below frame structure comes from the IDE eclipse:

 

jsmartpinl100 .jar JPOS device service control for SmartPIN L100 Device

com_idtech_connector_PINConnector.dll PINPad JNI DLL

SmartPIN _ L100 _OPOS SmartPIN L100 SDK, extension DLL to access USBHID or RS232

cfg_SmartPIN L100 _Interface.xml Interface configure file.

The .DLL and .XML files should be located in the directory in the PATH environment specified. For example, if the current working directory is included in the PATH variable:

PATH=%PATH%;

So, the file s can be moved to current directory.

jpos.xml jpos configure file, jpos register file. There are several entries in this file, with entry name: l ogicalName

“defaultPINPad”

"SmartPIN_L100_USBHID"

"SmartPIN_L100_RS232"

S pecific properties in the jpos.xml:

DeviceClass specify the class of current using device;

“DeviceName” specify the interface of current using device;

SDK specify the communication SDK of current using device.

“defaultPINPad”, “SmartPIN_L100_USBHID” this entry is a copy of one of other entry as the default name for POSTest program.

DeviceClass : PINPad

DeviceName : all is “ USBHID

SDK : all is “SmartPIN_L100_OPOS.dll”

“SmartPIN_L100_RS232”

DeviceClass : PINPad

DeviceName : RS 232

SDK : “SmartPIN_L100_OPOS.dll”

J pos/res/ jpos.properties jpos configure file, this specif ies jpos.xml

This file specify which configure file is used. By default, it specif ies the “jpos.xml” as the one.

Add jsignpayso.jar to your CLASSPATH or specify it in the javac / java command.

set CLASSPATH=%CLASSPATH%;yourDir \ jsmartpinl100.jar

For example: jsmartpinl100 .jar is placed in c:\so,

it should set CLASSPATH=%CLASSPATH%; c:\so\ jsmartpinl100.jar

Properties, Methods, Events

  1. PINPad

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

MaximumPINLength

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

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

Run POSTest

It's the official recommended JPOS compatible test program. The release version includes the program.

 

1. Unzip file " SmartPIN _ L100 _JPOS .zip " to a directory. S uch as I:\Users\admin\Desktop\Driver install , The Directory is like the following:

Enter " I:\Users\admin\Desktop\Driver install " Postest directory under the DOS command shell

Then enter subdirctory "POStest"

2. To run POSTest just like following:

Then a POStester program screen is shown.

 

 

3 . Click "PINPad" Tab

The logical name is the entry name in the jpos.xml file. Click "Open" button, and "Claim" , and check choices "Data event enabled", "Device enabled ":

Begin EFT Transaction and enablePINEntry , and then enter the PIN through the device:

Click End EFT Transaction , and c lick "Release" or "Close" to release or close the JPOS,

 

 

F or more detail please check the http://www.javapos.com and the release help files.

 

 

 

 

 

 

 

 

 

 

A S ample for using PINPad JPOS

1 . The following code is the sample of PINPad: