Scribd
Upload
6 views4 pages

CLock Interface v1.1

The ORBITA C Locking System SDK (Ver 1.1) provides an interface for issuing guest cards and supports Ultralight and Mifare one card types. It includes functions for connecting and disconnecting the encoder, checking and verifying cards, obtaining authorization codes, reading and writing card data, and deleting cards, with specific parameters and return values for each function. Additionally, it outlines a list of error codes for troubleshooting various issues that may arise during operation.

Uploaded by

info.lavendermansion
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
6 views4 pages

CLock Interface v1.1

The ORBITA C Locking System SDK (Ver 1.1) provides an interface for issuing guest cards and supports Ultralight and Mifare one card types. It includes functions for connecting and disconnecting the encoder, checking and verifying cards, obtaining authorization codes, reading and writing card data, and deleting cards, with specific parameters and return values for each function. Additionally, it outlines a list of error codes for troubleshooting various issues that may arise during operation.

Uploaded by

info.lavendermansion
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 C Locking System SDK

Ver 1.1

 Notice
This interface can only be used to issue guest cards, support Ultralight、Mifare
one(S50) card types provided by Orbita.
[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
Switch off encoder.
Return
Succeed then return 0.

 Access Card Function

3、__int16 __stdcall dv_check_card();


Return
Negative number is error code; positive number is card type; 1: Ultralight, 2:
Mifare one.
4、__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.

5、__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.

6、__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.

7、__int16 __stdcall dv_read_card(


unsigned char* auth,
unsigned char* cardno,
unsigned char* building,
unsigned char* room,
unsigned char* commdoors,
unsigned char* arrival,
unsigned char* departure
);

Function
Read data in guest card.
Parameters
auth:[in] Authorization code needed when read card, 6 characters.
cardno:[out] Card number returned, 6 characters.
building:[out] Building number returned,2 characters.
room:[out] Room number returned,4 characters.
commdoors:[out] Common doors returned, Range is 00-FF.
Control 8 areas.(8 bit binary.)
arrival:[out] Return check-in time,Format:yyyy-MM-dd hh:mm:ss. 19 characters.
departure:[out] Return check-out time, Same format with “arrival”.
Return
Succeed then return 0.

8、__int16 __stdcall dv_write_card(


unsigned char* auth,
unsigned char* building,
unsigned char* room,
unsigned char* commdoors,
unsigned char* arrival,
unsigned char* departure
);

Function
Write data into guest card.
Parameters
auth:[in] Authorization code,6 characters.
building:[in] Building number, 2 characters.
room:[in] Room number,4 characters.
commdoors[in] Common doors, Range is 00-FF. Control 8 areas.(8 bit binary.)
arrival:[in] Check-in time, Format:yyyy-MM-dd hh:mm:ss.19 characters.
departure:[in] Check-out time, Same format with “arrival”.
Return
Succeed then return 0.

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

Function
Delete card.
Parameters
room:[out] If type is the guest card, then return 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

You might also like