Scribd
Upload
261 views4 pages

CLock Interface v1.2

The ORBITA Locking System API v1.2 provides functions for connecting to locking systems, initializing authorization, accessing guest cards, and reading from and writing data to cards. It connects to a database to synchronize data and supports Ultralight and Mifare One card types. Functions are provided for operations like connecting/disconnecting devices, verifying and reading cards, and writing, deleting or duplicating card data.

Uploaded by

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

CLock Interface v1.2

The ORBITA Locking System API v1.2 provides functions for connecting to locking systems, initializing authorization, accessing guest cards, and reading from and writing data to cards. It connects to a database to synchronize data and supports Ultralight and Mifare One card types. Functions are provided for operations like connecting/disconnecting devices, verifying and reading cards, and writing, deleting or duplicating card data.

Uploaded by

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

ORBITA Locking System API v1.

 Introduction
This is a dynamic link library file that can be invoked by other programming
languages. The API is used to issue guest card, and supports Ultralight、Mifare
one(S50) card types.
The API needs to keep connection with locking system database in order to
synchronize data. This attachment included testing database, Can open and access
some data through Microsoft Access. When enter authorization code “111111” for
function “init” invocation, The API will connect to test database automatically.
In formal environment, please first write path of locking system database to file
“dbpath.ini”. Then Invoke function “dv_get_auth_code” to get authorization code.
This testing program connected with actual database, please test it.

[in]means input parameter,[out]means output parameter.

 Device function

1、__int16 __stdcall dv_connect(__int16 beep);


Function
Connect encoder.
Parameters
beep:[in] Value is 1,Encoder buzzer beep.
Return
Succeed then return 0.

2、__int16 __stdcall dv_disconnect();


Function
Disconnect encoder.
Return
Succeed then return 0.

 Initialization authorization

3、__int16 __stdcall init(unsigned char* auth);


Function
Initialization authorization. Just invoke one time in entire application.
Please invoke it after invoked “dv_connect”.
Parameters
auth:[in] Enter authorization code. Please put an setup card on encoder, then
invoke function “dv_get_auth_code” to get.
Return
Succeed then return 0.

 Access Card Function

4、__int16 __stdcall dv_check_card();


Return
Negative number is error code; positive number is card type; 1: Ultralight, 2:
Mifare one.

5、__int16 __stdcall dv_verify_card(__int16* type);


Function
Verify card.
Parameters
type:[out] Return card type value. 1: Ultralight; 2: Mifare one.
Return
Succeed then return 0.

6、__int16 __stdcall dv_get_auth_code(unsigned char* auth);


Function
To gain authorization code of setup card.
Parameters
auth:[out] Return authorization code, 6 characters.
Return
Succeed then return 0.

7、__int16 __stdcall dv_get_card_number(unsigned char* cardno);


Function
Get card number from any card.
Parameters
cardno:[out] Return card number. 6 characters.
Return
Succeed then return 0.
8、__int16 __stdcall dv_read_card(
unsigned char* cardtype,
unsigned char* cardno,
unsigned char* building,
unsigned char* room,
unsigned char* commdoors,
unsigned char* arrival,
unsigned char* departure,
unsigned char* guest);

Function
Reads guest card data.
Parameters
cardtype:[out] Returns card type name.
cardno:[out] Returns card number, 6 characters.
building:[out] Returns Building name.
room:[out] Returns room number,4 characters.
commdoors:[out] Return common doors address, Range is 00-FF.
Control 8 areas.(8 bit binary.)
arrival:[out] Returns check-in time,Format:yyyy-MM-dd hh:mm:ss.
departure:[out] Returns check-out time, Format:yyyy-MM-dd hh:mm:ss.
guest:[out] Returns guest name.
Return
Succeed then return 0.

9、__int16 __stdcall dv_write_card(


unsigned char* room,
unsigned char* commdoors,
unsigned char* arrival,
unsigned char* departure,
unsigned char* guest,
unsigned char* oper,
__int16 mode);

Function
Write guest card.
Parameters
room:[in] Enter room number,4 characters.
commdoors[in] Enter common doors, Range is 00-FF. Control 8 areas.(8 bit binary.)
arrival:[in] Enter check-in time, Format:yyyy-MM-dd hh:mm:ss.
departure:[in] Enter check-out time, Format:yyyy-MM-dd hh:mm:ss.
guest:[in] Enter guest name.
oper:[in] Enter operator name.
mode:[in] Enter 1 or 0. 1: new card, 0: duplicate card.
Return
Succeed then return 0.

10、__int16 __stdcall dv_delete_card(unsigned char* room);

Function
Delete card.
Parameters
room:[out] If type is the guest card, Returns room number.
Return
Succeed then return 0.

 Error codes list


Value Description
-1 Interface error
-2 Connect encoder failed
-3 Register encoder failed
-4 Buzzer mute
-5 Not supported card type
-6 Wrong card password
-7 Wrong supplier password
-8 Wrong card type
-9 Wrong authorization code
-10 Find card request failed
-11 Find card failed
-12 Load card password failed
-13 Read device information failed
-14 Read card failed
-15 Write card failed
-30 Database connection failed
-31 Sql execute failed
-40 Card number not exist
-41 Authorization code mismatch

You might also like