Scribd
Upload
205 views6 pages

Interface Description

The document provides documentation on functions in a DLL for interacting with a USB port and performing hotel door lock operations. It includes functions for initializing the USB, sounding a buzzer, issuing and reading guest cards, erasing cards, reporting lost cards, and retrieving card data including type, room number, and check-out time. All functions take a USB device ID as the first parameter and have C++ prototypes specified.

Uploaded by

Hezron Moch
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
205 views6 pages

Interface Description

The document provides documentation on functions in a DLL for interacting with a USB port and performing hotel door lock operations. It includes functions for initializing the USB, sounding a buzzer, issuing and reading guest cards, erasing cards, reporting lost cards, and retrieving card data including type, room number, and check-out time. All functions take a USB device ID as the first parameter and have C++ prototypes specified.

Uploaded by

Hezron Moch
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 6

Call the library:

Provided under the 32-bit Windows Dynamic Link Library


proRFL.DLL

Detailed description of the function to use

//------------------------------------------------ -----------------------------------//

Function: Reading DLL version of the USB port operations do not


involve

C + + Prototype: int __stdcall GetDLLVersion (uchar * bufVer)

Back to: DLL version

//------------------------------------------------ -----------------------------------//

Features: Open USB

C + + Prototype: int __stdcall initializeUSB (uchar d12)

Parameters:

d12  USB type, for proUSB fixed to 1

Return: 0 success, otherwise fail

Note: The following functions are to use this parameter, are


fixed to 1

//------------------------------------------------ -----------------------------------//

Function: Card device tweet soon as

C + + Prototype: int __stdcall Buzzer (uchar d12, unsigned char t)

Parameters:

d12  USB type, for proUSB fixed to 1

t  tweet time, multiplied by 10 ms


Return: 0 success, otherwise fail

//------------------------------------------------ -----------------------------------//

Function: Release "guest card", also known as "guest card" or "house card"

C + + prototype: int __stdcall GuestCard (uchar d12, int dlsCoID, uchar


CardNo, uchar dai, uchar LLock, uchar pdoors, uchar BDate [10], uchar
EDate [10], uchar LockNo [8], uchar * cardHexStr)

Parameters:

d12  USB type, for proUSB fixed to 1

dlsCoID  Hotel logo, the card can be read from the


existing

CardNo  The same card up to 16 minutes, each issued a


card with a

Dai  Guests on behalf of, 0 - 255 for the card after the
card front cover, generally fixed at 0

LLock  Locked flag, one able to open locked, 0 can not


open locked

pdoors  Public door signs, one able to open public doors, 0


can not open

BDate  Card for 10-digit string that contains years day


hours, each two

Example: '0905201345 ', said 2009/05/20 13:45

EDate  Check-out time is 10-digit string, including years


on after midnight, each 2

LockNo  Room No. 8 digits string define the room from the
door where access to the software

cardHexStr  Back to the card data strings

Return: 0 success, otherwise fail


//------------------------------------------------ -----------------------------------//

Function: read card data

C + + Prototype: int __stdcall ReadCard (uchar d12, uchar * buffData)

d12  USB type, for proUSB fixed to 1

buffData  Back to the card data string, the data indicated


that the first 551,501 successful

The first 25 characters from the beginning of the 8


characters is the only card number, also known as the card's
ID number

Return: 0 success, otherwise fail

//------------------------------------------------ -----------------------------------//

Function: write-off card

C + + Prototype: int __stdcall CardErase (uchar d12, int dlsCoID,


unsigned char * cardHexStr)

d12  USB type, for proUSB fixed to 1

dlsCoID  Hotel logo, the card can be read from the


existing

cardHexStr  Back to the card data string

Return: 0 success, otherwise fail

//------------------------------------------------ -----------------------------------//

Function: report of loss card

C + + Prototype: int __stdcall LimitCard (uchar d12, int dlsCoID, uchar


CardNo, uchar dai, uchar BDate [10], uchar LCardNo [4], uchar *
cardHexStr)

Parameters:
d12  USB type, for proUSB fixed to 1

dlsCoID  Hotel logo, the card can be read from the


existing

CardNo  The same card up to 16 minutes, each issued a


card with a

Dai  Generation, 0 - 255 for the card after the card front
cover, generally fixed at 0

BDate  Card for 10-digit string that contains years day


hours, each two

Example: '0905201345 ', said 2009/05/20 13:45

uchar LCardNo  Lost card card serial number, 4 bytes, the


time from the card, card type, card number etc.

cardHexStr  Back to the card data string

Return: 0 success, otherwise fail

//------------------------------------------------ -----------------------------------//

Function: read card type

C + + Prototype: int __stdcall GetCardTypeByCardDataStr (unsigned


char * cardHexStr, unsigned char * CardType)

cardHexStr à function returns the card data


string

Return: 0 success, otherwise fail

CardType == '0 'control card

CardType == '1 'record cards

CardType == '2 'room set up card

CardType == '3 'Clock Set Card

CardType == '4 'limit card, also known as loss report card


CardType == '5 'Regional Settings Card No.

CardType == '6 'guest card

CardType == '7 'Check Card

CardType == '8 'regional cards

CardType == '9 'unknown card, do not have this card type

CardType == 'A' Emergency Card

CardType == 'B' Explorer Card

CardType == 'C' Loudong card

CardType == 'D' Floor cards

CardType == 'E' unknown card, do not have this card type

CardType == 'F' blank cards

//------------------------------------------------ -----------------------------------//

Function: read guest card room number

C + + Prototype: int __stdcall GetGuestLockNoByCardDataStr (int


dlsCoID, unsigned char * cardHexStr, unsigned char * LockNo)

dlsCoID  Current hotel hotel logo

cardHexStr à function returns the card data


string

Return: 0 success, otherwise fail

1 - card data string is invalid

2 - Non of the hotel card

3 - not the guest card

LockNo: room number, 8-digit strings, with GuestCard function

//------------------------------------------------ -----------------------------------//
Function: read guest card, check-out time

C + + Prototype: int __stdcall GetGuestETimeByCardDataStr (int


dlsCoID, unsigned char * cardHexStr, unsigned char * ETime)

dlsCoID  Current hotel hotel logo

cardHexStr à function to return the card


data string

Return: 0 success, otherwise fail

1 - card data string is invalid

2 - Non of the hotel card

3 - not the guest card

ETime: Check-out time, 10-digit string, namely years day


hours, each two

//------------------------------------------------ -----------------------------------//

You might also like