酒店門(mén)鎖管理系統(tǒng)接口說(shuō)明

1、深圳市同創(chuàng)新佳科技有限公司技術(shù)文件 LS-PMS酒店門(mén)鎖管理系統(tǒng)集成發(fā)卡接口說(shuō)明書(shū)Hotel Locks Management SystemPMS Integrate Keycards EncodeSDK User Guide版本號(hào)：2.0版本號(hào)發(fā)布日期制定審核批準(zhǔn)V1.02009-03-31V2.02010-06-26目 錄1目的和范圍42系統(tǒng)組成4Windows API接口與TCP/IP接口.4系統(tǒng)結(jié)構(gòu)43Windows API接口4接口特點(diǎn)以及接口使用條件4Windows API接口文件說(shuō)明5Windows API接口函數(shù)庫(kù)說(shuō)明54Windows API接口函數(shù)說(shuō)明5Init 接口初始化

2、5IssueCard 發(fā)行客人卡6ReadCard 讀取客人卡7CancelCard 注銷(xiāo)客人卡7Windows API接口示例使用說(shuō)明85Windows API接口返回值說(shuō)明116. TCP/IP接口116.1 接口特點(diǎn)以及接口使用條件116.2 TCP/IP接口文件如下表:117 TCP/IP數(shù)據(jù)通訊協(xié)議1272 信息格式127.3 命令詳解14前 言本說(shuō)明書(shū)由深圳市同創(chuàng)新佳科技有限公司提出。本說(shuō)明書(shū)主要起草單位：深圳市同創(chuàng)新佳科技有限公司技術(shù)部。本說(shuō)明書(shū)主要起草人：顏煒東、凌彬。本說(shuō)明書(shū)于2009年3月25日首次制定。修訂記錄版本號(hào)修訂內(nèi)容日期批準(zhǔn)1.0首次制定2009-3-252.0新

3、增示例應(yīng)用說(shuō)明，接口適用版本2010-06-26LS-PMS酒店門(mén)鎖管理系統(tǒng)集成發(fā)卡接口說(shuō)明書(shū)Hotel Locks Management System PMS Integration Keycards Encode SDK User Guide1 目的和范圍該接口主要為酒店管理軟件與我公司的讀寫(xiě)卡設(shè)備提供標(biāo)準(zhǔn)的接口，以便酒店管理軟件可以通過(guò)該接口對(duì)我公司設(shè)備進(jìn)行操作。2 系統(tǒng)組成Windows API接口與TCP/IP接口.系統(tǒng)結(jié)構(gòu)Windows API接口系統(tǒng)結(jié)構(gòu):發(fā)卡機(jī)PMSICDLLTCP/IP接口系統(tǒng)結(jié)構(gòu):發(fā)卡機(jī)服務(wù)器PMS客戶端Client.exeICDLL.dllCpmputer

4、.mdbServer.exe3 Windows API接口接口特點(diǎn)以及接口使用條件該接口具有單機(jī)與網(wǎng)絡(luò)2種接口，其特點(diǎn)是不管是單機(jī)還是網(wǎng)絡(luò)接口，每個(gè)接口都必須安裝一臺(tái)發(fā)卡機(jī)，只能在安裝了發(fā)卡機(jī)的電腦上調(diào)用ICDLL動(dòng)態(tài)庫(kù)完成制卡操作。正常使用該接口必須滿足如下要求：3.1.1首先安裝 創(chuàng)佳門(mén)鎖公司提供的門(mén)鎖軟件，正常運(yùn)行軟件，發(fā)行各種設(shè)置卡（包括：授權(quán)卡、時(shí)鐘卡、房號(hào)卡），使用設(shè)置卡完成門(mén)鎖設(shè)置（如果有多臺(tái)電腦發(fā)卡，則每臺(tái)電腦都必須安裝我們門(mén)鎖軟件并注冊(cè)，然后用主電腦上的授權(quán)卡恢復(fù)授權(quán)，詳細(xì)操作請(qǐng)參考門(mén)鎖設(shè)置說(shuō)明）。3.1.2使用前先調(diào)用初始化函數(shù)初始化軟件使用環(huán)境即調(diào)用init函數(shù)3.1.3

5、使用windows98/2000/XP操作系統(tǒng).3.1.4 動(dòng)態(tài)庫(kù)ICDLL.dllWindows API接口文件說(shuō)明Windows API接口文件如表:文件名文件說(shuō)明Demo.exe接口示例可執(zhí)行文件.ICDLLVer4.2ICDLL.dll接口函數(shù)庫(kù)文件,IC門(mén)鎖,適用門(mén)鎖管理軟件IC-NK2.0以上，發(fā)卡機(jī)型號(hào)RW-IC-32C。.RFDLLUSB接口ICDLL.dll接口函數(shù)庫(kù)文件,RF門(mén)鎖, 適用門(mén)鎖管理軟件LS-RF-CN-ALL-ALL Ver8.0以上，發(fā)卡機(jī)型號(hào)RW-RF-34U.RFDLLver6.33兼容ICDLL.dll接口函數(shù)庫(kù)文件,RF門(mén)鎖, 適用門(mén)鎖管理軟件RF-

6、NK6.33前升級(jí)為L(zhǎng)S-RF-CN-ALL-ALL Ver8.0以上版本時(shí)使用，其主要用于新老線路板混合使用的酒店，發(fā)卡機(jī)型號(hào)RW-RF-32C.RFDLLver8.1ICDLL.dll接口函數(shù)庫(kù)文件,RF門(mén)鎖, 適用門(mén)鎖管理軟件LS-RF-CN-ALL-ALL Ver8.0以上，發(fā)卡機(jī)型號(hào)RW-RF-32C.MFDLLVer3.3ICDLL.dll接口函數(shù)庫(kù)文件,MF門(mén)鎖，適用門(mén)鎖管理軟件LS-MF-CN-U-WL Ver3.0-3.3，發(fā)卡機(jī)型號(hào)RW-M1-32C.MFDLLVer3.5ICDLL.dll接口函數(shù)庫(kù)文件,MF門(mén)鎖，適用門(mén)鎖管理軟件LS-MF-CN-U-WL Ver3.5，

7、發(fā)卡機(jī)型號(hào)RW-M1-32C附加說(shuō)明:.表示Demo.exe所在目錄Windows API接口函數(shù)庫(kù)說(shuō)明ICDLL.dll接口函數(shù)庫(kù)包括4個(gè)函數(shù)，用于控制發(fā)卡機(jī)發(fā)行客人卡及讀取客人卡。函數(shù)調(diào)用采用stdcall方式，PMS集成應(yīng)遵循該Windows API標(biāo)準(zhǔn)。函數(shù)名函數(shù)說(shuō)明Init接口初始化IssueCard發(fā)行客人卡ReadCard讀取客人卡CancelCard注銷(xiāo)客人卡(功能卡無(wú)法用該函數(shù)注銷(xiāo))4 Windows API接口函數(shù)說(shuō)明Init 接口初始化函數(shù)說(shuō)明用于初始化環(huán)境變量。根據(jù)安裝的門(mén)鎖管理軟件使用數(shù)據(jù)庫(kù)設(shè)定版本類(lèi)型；設(shè)定門(mén)鎖軟件的安裝目錄。PMS每次運(yùn)行后，調(diào)用其它接口函數(shù)前須調(diào)

8、用一次，若門(mén)鎖管理軟件安裝目錄和類(lèi)型沒(méi)有發(fā)生變化則只需調(diào)用一次。語(yǔ)法 Delphifunction Init(SoftType:integer; So:PChar ):Boolean;語(yǔ)法 C#public static extern Boolean init(int SoftType,string So);語(yǔ)法-PBFunction boolean init (integer SoftType,ref string So)語(yǔ)法-VBFunction init Lib ICDLL.dll (ByVal SoftType As Integer, ByVal So As String) As Bo

9、olean參數(shù)in整型數(shù)，安裝的門(mén)鎖管理軟件類(lèi)型版本。 = 0；ACESS數(shù)據(jù)庫(kù)類(lèi)型版本； = 1；SQL2000數(shù)據(jù)庫(kù)類(lèi)型版本。in字符指針，指向門(mén)鎖管理軟件安裝路徑字符串。返回值布爾值 True or False示例delphiinit(0,pchar( C:Program FilesRF systemRF system)示例c#init(0,”C:Program FilesRF systemRF system”)示例pbinit(0,” C:Program FilesRF systemRF system”)示例vbinit(0,” C:Program FilesRF systemRF s

10、ystem”)附加說(shuō)明此路徑為鎖管軟件的安裝路徑IssueCard 發(fā)行客人卡函數(shù)說(shuō)明用于發(fā)行客人卡。發(fā)行成功后，更新數(shù)據(jù)庫(kù)，記錄相應(yīng)客人信息、發(fā)卡操作員信息。返回發(fā)行結(jié)果。語(yǔ)法 Delphifunction IssueCard(RoomNo, GuestInfo:ShortString, OpInfo: pchar, Loss:Integer; CheckIn, CheckOut: pchar):Integer;語(yǔ)法 c#public static extern int IssueCard(string RoomNo, string GuestInfo, string OpInfo, int

11、 Loss, DateTime CheckIn, DateTime CheckOut);語(yǔ)法 PBfunction long IssueCard (ref string RoomNo,ref string GuestInfo,ref string OpInfo, int Loss,ref string CheckIn,ref string CheckOut) Library icdll.dll語(yǔ)法 VBPublic Declare Function IssueCard Lib ICDLL.dll (ByVal RoomNo As String, ByVal GuestInfo As Strin

12、g, ByVal OpInfo As String, ByVal Loss As Integer, ByVal CheckIn As String, ByVal CheckOut As String) As Integer參數(shù)in字符指，房間號(hào)，長(zhǎng)度不大于20。注意須與門(mén)鎖管理軟件設(shè)定房間號(hào)碼一致，且不能為空。in字符指，客人信息，可以為空。in字符指，操作員信息，可以為空。in整數(shù)型，指示是否需要設(shè)定掛失。設(shè)定掛失，該卡首次開(kāi)門(mén)后之前發(fā)行的客人卡即失效。一般新客人入住發(fā)行首張客人卡須設(shè)定掛失；復(fù)制發(fā)行已入住客人卡不得設(shè)定掛失，除非已入住客人主動(dòng)掛失后重發(fā)客人卡。= 0；不設(shè)定掛失；= 1；設(shè)

13、定掛失。in字符指針，入住時(shí)間。格式y(tǒng)ymmddhhmmin字符指針，退房時(shí)間。格式y(tǒng)ymmddhhmm返回值= 0，1，2，3，4，9，10，11，15，85，86，87，89示例delphiIssueCard（pchar(8101),pchar(張三),pchar(李四),0, pchar(0904011011), pchar(0904021011)）示例c#IssueCard（”8101”,”張三”,”李四”,0, 2009-1-1 8：00：00, 2009-1-2 12：00）示例pbIssueCard（”8101”,”張三”,”李四”,0, “0901010800”, “09010

14、21200”）示例vbIssueCard（”8101”,”張三”,”李四”,0, “0901010800”, “0901021200”）附加說(shuō)明1、房號(hào)為鎖管軟件中房號(hào)設(shè)置中設(shè)置的房號(hào)，可在主界面中或者房號(hào)設(shè)置界面中找到。2、酒店第一個(gè)入住的客人發(fā)行的是新卡3、酒店發(fā)行同住的客人時(shí)發(fā)行的是加卡（復(fù)制卡）4、酒店發(fā)行新卡時(shí)，傳入的入住時(shí)間為第一個(gè)客人的入住時(shí)間，掛失標(biāo)志位必須為1。5、酒店發(fā)行加卡（復(fù)制卡）時(shí)，傳入的入住時(shí)間為在住的上一個(gè)客人的新卡的入住時(shí)間，掛失標(biāo)志必須為0。6、當(dāng)酒店有客人在住，但是客人把卡片弄丟了，要補(bǔ)卡，此時(shí)酒店必須發(fā)行的是新卡。7、補(bǔ)卡完成后再次發(fā)行同住卡片則必須發(fā)行加

15、卡（復(fù)制卡）。8、卡片要被掛失2張卡之間的入住時(shí)間必須相差大于1分鐘，而且時(shí)間較晚的卡必須帶有掛失標(biāo)志。9、如果酒店使用退房卡，則鎖管軟件中的系統(tǒng)設(shè)置中的提前發(fā)卡必須設(shè)置為不提前（具體設(shè)置請(qǐng)參考使用手冊(cè)中的系統(tǒng)設(shè)置部分）。ReadCard 讀取客人卡函數(shù)說(shuō)明用于讀取客人卡信息。讀取成功后，讀取卡片上信息并查詢數(shù)據(jù)庫(kù)對(duì)應(yīng)卡片發(fā)卡時(shí)記錄的客人信息、發(fā)卡操作員信息。返回讀取結(jié)果。語(yǔ)法 Delphifunction ReadCard(RoomNo, GuestInfo, OpInfo, CheckIn, CheckOut, CardNo:pchar):Integer;語(yǔ)法 C#public stati

16、c extern int ReadCard(StringBuilder RoomNo, StringBuilder GuestInfo, StringBuilder OpInfo, StringBuilder CheckIn, StringBuilder CheckOut, StringBuilder CardNo);語(yǔ)法 PBFunction long ReadCard (ref string RoomNo, ref string GuestInfo, ref string OpInfo, ref string CheckIn, ref string CheckOut, ref string

17、 CardNo) Library ICDLL.dll語(yǔ)法 VBPublic Declare Function ReadCard Lib ICDLL.dll (ByVal RoomNo As String, ByVal GuestInfo As String, ByVal OpInfo As String, ByVal CheckIn As String, ByVal CheckOut As String, ByVal CardNo As String) As Integer參數(shù)Out 字符指針，房間號(hào)。Out字符指針，客人信息。Out 字符指針，操作員信息。Out 字符指針，入住時(shí)間。Out

18、字符指針，退房時(shí)間。Out 字符指針，卡號(hào)(MF為物理卡號(hào),RF為流水號(hào),IC為我廠出廠時(shí)的一個(gè)固定的序號(hào))返回值= 0，1，2，3，4，7，9，10，15，85，86，87，89示例delphiReadCard(RoomNo,GuestInfo,OpInfo,CheckIn,CheckOut,CardNo)示例c#ReadCard(RoomNo, GuestInfo, OpInfo, CheckIn, CheckOut, CardNo)示例pbReadCard(RoomNo, GuestInfo, OpInfo, CheckIn, CheckOut, CardNo)示例vbReadCard(

19、RoomNo, GuestInfo, OpInfo, CheckIn, CheckOut, CardNo)CancelCard 注銷(xiāo)客人卡函數(shù)說(shuō)明注銷(xiāo)客人卡,使卡片回復(fù)新卡狀態(tài)，并更新數(shù)據(jù)庫(kù)。該函數(shù)不能注銷(xiāo)功能卡語(yǔ)法 Delphifunction CancelCard(OpInfo:pchar):Integer;語(yǔ)法 C#public static extern int CancelCard(string OpInfo);語(yǔ)法 PBfunction int CancelCard (ref string OpInfo) library “icdll.dll”語(yǔ)法 VBPublic Declare

20、 Function CancelCard Lib “ICDLL.dll” (ByVal OpInfo As String) As Integer參數(shù)in字符指針，操作員信息。返回值= 0，1，2，3，4，7，9，10，15，85，86，87，88，89示例delphiCancelCard(pchar(張三)示例c#CancelCard(“張三”)示例pbCancelCard(“張三”)示例vbCancelCard(“張三”)Windows API接口示例使用說(shuō)明打開(kāi)軟件接口說(shuō)明示例文件，根據(jù)安裝的鎖管軟件找到相應(yīng)的動(dòng)態(tài)庫(kù)文件，選擇軟件類(lèi)型，如果鎖管軟件為單機(jī)版則軟件類(lèi)型選擇ACESS,如果為網(wǎng)

21、絡(luò)類(lèi)型則選擇SQL2000：在桌面的鎖管軟件快捷方式上右鍵-屬性 單擊 查找目標(biāo) 按鈕。將地址欄中的地址復(fù)制到示例當(dāng)中的軟件安裝路徑：然后單擊初始化按鈕進(jìn)行初始化，初始化完成之后即可對(duì)卡片進(jìn)行讀寫(xiě)注銷(xiāo)等操作5 Windows API接口返回值說(shuō)明返回值返回值說(shuō)明及故障原因排錯(cuò)方法0操作成功1無(wú)卡。查看卡片位置是否放好2非法卡。人工注銷(xiāo)后，重新發(fā)行使用。3授權(quán)錯(cuò)誤。必須返回廠或代理商處重新初始化4串口通信錯(cuò)誤。發(fā)卡機(jī)串口連接中斷；串口被其它程序占用；連續(xù)多次調(diào)用函數(shù)時(shí)未插入延時(shí)。檢查發(fā)卡機(jī)連接；更改門(mén)鎖管理軟件串口或其它程序串口設(shè)置；連續(xù)調(diào)用函數(shù)時(shí)插入500毫秒以上延時(shí)。7新卡。讀卡或注銷(xiāo)時(shí)返回

22、的一個(gè)值，表示該卡無(wú)須注銷(xiāo)9非客人卡。使用門(mén)鎖管理軟件進(jìn)行注銷(xiāo)卡操作。(接口只提供客人卡操作，非客人卡則會(huì)提示此信息)10調(diào)用錯(cuò)誤。檢查調(diào)用函數(shù)語(yǔ)法、輸入?yún)?shù)類(lèi)型、拼寫(xiě)。11房號(hào)不存在檢查傳入的房間號(hào)碼是否正確15數(shù)據(jù)庫(kù)連接錯(cuò)誤。檢查Init函數(shù)輸入?yún)?shù)；SQL數(shù)據(jù)庫(kù)用戶密碼設(shè)定（此為和門(mén)鎖軟件數(shù)據(jù)庫(kù)同步連接，如果傳入?yún)?shù)錯(cuò)誤則無(wú)法建立連接）。85系統(tǒng)日前錯(cuò)誤。重新計(jì)算升遷號(hào)86未計(jì)算升遷號(hào)。計(jì)算升遷號(hào)87系統(tǒng)過(guò)期。重新計(jì)算升遷號(hào)89升遷號(hào)被破壞。重新計(jì)算升遷號(hào)6. TCP/IP接口6.1 接口特點(diǎn)以及接口使用條件該接口特點(diǎn)在于可以通過(guò)網(wǎng)絡(luò)控制安裝了發(fā)卡機(jī)設(shè)備的電腦完成發(fā)卡，無(wú)須在每臺(tái)電腦上安

23、裝發(fā)卡機(jī)設(shè)備。正常使用該接口必須滿足如下要求：6.1.1首先安裝 創(chuàng)佳門(mén)鎖公司提供的門(mén)鎖軟件，正常運(yùn)行軟件，發(fā)行各種設(shè)置卡（包括：授權(quán)卡、時(shí)鐘卡、房號(hào)卡），使用設(shè)置卡完成門(mén)鎖設(shè)置（如果有多臺(tái)電腦發(fā)卡，則每臺(tái)電腦都必須安裝我們門(mén)鎖軟件并注冊(cè)，然后用主電腦上的授權(quán)卡恢復(fù)授權(quán)，詳細(xì)操作請(qǐng)參考門(mén)鎖設(shè)置說(shuō)明）。6.1.2使用windows98/2000/XP操作系統(tǒng).6.2 TCP/IP接口文件如下表:文件名文件說(shuō)明Server.exe服務(wù)端可執(zhí)行文件(在服務(wù)器端運(yùn)行，唯一)Client.exe客戶端可執(zhí)行文件(在客戶端運(yùn)行，每個(gè)客戶端一個(gè))Computer.mdb數(shù)據(jù)庫(kù)（客戶端與網(wǎng)絡(luò)端都需要）.ICD

24、LLICDLL.dll客戶端庫(kù)文件,IC門(mén)鎖.RFDLLICDLL.dll客戶端庫(kù)文件,RF門(mén)鎖.MFDLLICDLL.dll客戶端庫(kù)文件,MF門(mén)鎖附加說(shuō)明:.表示server.exe文件所在目錄該協(xié)議采用TCP/IP協(xié)議，接口使用方利用Socket Client按照固定格式發(fā)送數(shù)據(jù)和指令，接口系統(tǒng)（Socket Server）實(shí)時(shí)響應(yīng)。接口網(wǎng)絡(luò)系統(tǒng)包括服務(wù)端（server.exe, computer.MDB）與客戶端（client.exe,icdll.dll, computer.mdb）兩部分。服務(wù)端完成通信管理、參數(shù)設(shè)置、客戶端管理等功能，接口網(wǎng)絡(luò)只能有一個(gè)服務(wù)管理端（即服務(wù)端只能安裝一臺(tái)

25、計(jì)算機(jī)）。客戶端是發(fā)卡端，完成發(fā)卡與信息顯示功能，安裝在發(fā)卡工作站或讀卡與信息顯示工作站上。客戶端數(shù)量不受任何限制，可以安裝在所有需要發(fā)卡的工作站上，不同工作站也可以共用一個(gè)客戶端發(fā)卡。酒店管理系統(tǒng)與接口服務(wù)端通信，接口服務(wù)端接收指令并分配到指定客戶端執(zhí)行?？蛻舳藞?zhí)行命令后將執(zhí)行狀態(tài)反饋到服務(wù)端，服務(wù)端再將執(zhí)行狀態(tài)轉(zhuǎn)換為應(yīng)答信息回應(yīng)酒店管理系統(tǒng)。7 TCP/IP數(shù)據(jù)通訊協(xié)議 7.1控制字符STX（0x02）：用于標(biāo)記數(shù)據(jù)記錄的開(kāi)始。ETX（0x03）：用于標(biāo)記數(shù)據(jù)記錄的結(jié)束。RS （0x7C）：即分割符|，用于標(biāo)記新字段（域）的開(kāi)始，其后緊跟字段標(biāo)識(shí)碼。7.2 信息格式信息格式為：ddssff

26、data。信息域說(shuō)明dd目標(biāo)地址，目標(biāo)（客戶端）地址(此地址為服務(wù)器添加客戶端數(shù)據(jù)中的發(fā)行機(jī)編號(hào))ss源地址，標(biāo)明信息來(lái)源(此地址為服務(wù)器添加客戶端數(shù)據(jù)中的發(fā)行機(jī)編號(hào))ff命令或應(yīng)答代碼data數(shù)據(jù)區(qū)（非必須）目標(biāo)地址：2字節(jié)，有效值00-99，接收信息的目的地址或指定執(zhí)行命令的客戶端。源地址：2字節(jié)，有效值00-99（00系統(tǒng)保留），標(biāo)明信息來(lái)源。例子說(shuō)明：假如在server.exe中添加了客戶端2個(gè)客戶端 發(fā)行機(jī)編號(hào) 01 電腦名稱為 c1 , 發(fā)行機(jī)編號(hào) 02 電腦名稱為 c2,如果從c1電腦要在c2電腦上發(fā)行卡，則dd 為 02 ss 為 01.命令代碼：1字節(jié)，ASCII碼，指定執(zhí)行

27、的命令。B-客人退房（注銷(xiāo)卡）E-讀卡G-客人入?。òl(fā)卡）I-新客人入?。òl(fā)卡，同時(shí)將在住客人退房）應(yīng)答代碼：1-2字節(jié)，ASCII碼，指定命令執(zhí)行的結(jié)果。0-成功完成1-未確定的錯(cuò)誤2-錯(cuò)誤的（無(wú)效的）目標(biāo)地址3-無(wú)效的命令代碼4-串口錯(cuò)誤5-發(fā)行機(jī)正忙6-無(wú)效的客房7-新卡8-發(fā)行機(jī)等候超時(shí)10-無(wú)效的時(shí)間11-客戶端沒(méi)有連接12-客戶端通信錯(cuò)誤數(shù)據(jù)區(qū)（data）：數(shù)據(jù)可根據(jù)需要給出不同數(shù)據(jù)，格式為：|data。|（0x7C即分割符|）標(biāo)明字段（域）開(kāi)始。字段（域）標(biāo)識(shí)，1-2字節(jié)ASCII碼，標(biāo)明字段（域）數(shù)據(jù)意義。字段ID說(shuō)明數(shù)據(jù)長(zhǎng)度格式示例R(0x52)房號(hào)1-7803D(0x44)客人入住時(shí)間12yyyymmddhhnn2O(0x4F)客人預(yù)離時(shí)間12yyyymmddhhnn2N(0x4E)客人姓