酒店門鎖管理系統(tǒng)接口說明

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

2、數(shù)說明8Init 接口初始化8IssueCard 發(fā)行客人卡9ReadCard 讀取客人卡10CancelCard 注銷客人卡11Windows API接口示例使用說明115Windows API接口返回值說明146. TCP/IP 接口156.1接口特點(diǎn)以及接口使用條件156.2 TCP/IP接口文件如下表:157 TCP/IP 數(shù)據(jù)通訊協(xié)議167 2 信息格式167.3命令詳解18專業(yè)資料.前言本說明書由深圳市同創(chuàng)新佳科技有限公司提出。本說明書主要起草單位：深圳市同創(chuàng)新佳科技有限公司技術(shù)部。本說明書主要起草人：顏煒東、凌彬。本說明書于2009 年 3 月 25 日首次制定。修訂記錄版本號修

3、訂內(nèi)容日期批準(zhǔn)1.0首次制定2009-3-252.0新增示例應(yīng)用說明，接口適用版本2010-06-26專業(yè)資料.專業(yè)資料.LS-PMS 酒店門鎖管理系統(tǒng)集成發(fā)卡接口說明書Hotel Locks Management System PMS Integration Keycards EncodeSDK User Guide1目的和范圍該接口主要為酒店管理軟件與我公司的讀寫卡設(shè)備提供標(biāo)準(zhǔn)的接口，以便酒店管理軟件可以通過該接口對我公司設(shè)備進(jìn)行操作。2系統(tǒng)組成Windows API接口與 TCP/IP 接口 .系統(tǒng)結(jié)構(gòu)Windows API接口系統(tǒng)結(jié)構(gòu):PMS發(fā)卡機(jī)ICDLLTCP/IP 接口系統(tǒng)結(jié)構(gòu):

4、PMS服務(wù)器發(fā)卡機(jī)客戶端專業(yè)資料.Server.exeClient.exeICDLL.dllCpmputer.mdb3Windows 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)庫完成制卡操作。正常使用該接口必須滿足如下要求：首先安裝創(chuàng)佳門鎖公司提供的門鎖軟件，正常運(yùn)行軟件，發(fā)行各種設(shè)置卡（包括：授權(quán)卡、時(shí)鐘卡、房號卡），使用設(shè)置卡完成門鎖設(shè)置（如果有多臺(tái)電腦發(fā)卡，則每臺(tái)電腦都必須安裝我們門鎖軟件并注冊，然后用主電腦上的授權(quán)卡恢復(fù)授權(quán)，詳細(xì)操作請參考門鎖設(shè)置說明）

5、。3.1.2使用前先調(diào)用初始化函數(shù)初始化軟件使用環(huán)境即調(diào)用init 函數(shù)3.1.3使用 windows98/2000/XP操作系統(tǒng) .3.1.4動(dòng)態(tài)庫 ICDLL.dllWindows API接口文件說明Windows API接口文件如表 :文件名文件說明專業(yè)資料.Demo.exe接口示例可執(zhí)行文件.ICDLLVer4.2ICDLL.dll接口函數(shù)庫文件,IC 門鎖,適用門鎖管理軟件IC-NK2.0 以上，發(fā)卡機(jī)型號 RW-IC-32C 。.RFDLLUSB 接口 ICDLL.dll接口函數(shù) 庫文件 ,RF 門鎖 , 適 用門鎖 管理軟 件LS-RF-CN-ALL-ALLVer8.0 以上，發(fā)

6、卡機(jī)型號RW-RF-34U.RFDLLver6.33 兼容 ICDLL.dll接口函數(shù) 庫文件 ,RF 門鎖 , 適 用門鎖 管理軟 件RF-NK6.33 前升級為 LS-RF-CN-ALL-ALL Ver8.0以上版本時(shí)使用，其主要用于新老線路板混合使用的酒店，發(fā)卡機(jī)型號 RW-RF-32C.RFDLLver8.1ICDLL.dll接口函數(shù) 庫文件 ,RF 門鎖 , 適 用門鎖 管理軟 件LS-RF-CN-ALL-ALLVer8.0 以上，發(fā)卡機(jī)型號RW-RF-32C.MFDLLVer3.3ICDLL.dll接口函數(shù)庫文件,MF 門鎖，適用門鎖管理軟件LS-MF-CN-U-WLVer3.0-

7、3.3 ， 發(fā) 卡 機(jī) 型 號.MFDLLVer3.5ICDLL.dllRW-M1-32C,MF 門鎖，適用門鎖管理軟件接口函數(shù)庫文件LS-MF-CN-U-WLVer3.5 ， 發(fā) 卡 機(jī) 型 號RW-M1-32C附加說明 :表示 Demo.exe所在目錄Windows API接口函數(shù)庫說明ICDLL.dll接口函數(shù)庫包括4 個(gè)函數(shù)，用于控制發(fā)卡機(jī)發(fā)行客人卡及讀取客人卡。函數(shù)調(diào)用采用stdcall方式， PMS 集成應(yīng)遵循該Windows API標(biāo)準(zhǔn)。函數(shù)名函數(shù)說明Init接口初始化IssueCard發(fā)行客人卡ReadCard讀取客人卡CancelCard注銷客人卡 (功能卡無法用該函數(shù)注銷)

8、4Windows API接口函數(shù)說明Init 接口初始化函數(shù)說明用于初始化環(huán)境變量。根據(jù)安裝的門鎖管理軟件使用數(shù)據(jù)庫設(shè)定版本類型；設(shè)定門鎖軟件的安裝目錄。 PMS 每次運(yùn)行后，調(diào)用其它接口函數(shù)前須調(diào)用一次，若門鎖管理軟件安裝目錄和類型沒有發(fā)生變化則只需調(diào)用一次。語法function Init(SoftType:integer; SoftPath:PChar ):Boolean;Delphi專業(yè)資料.語法 C#public static extern Boolean init(int SoftType,string SoftPath);語法 -PBFunction boolean init (i

9、nteger SoftType,ref string SoftPath)語法 -VBFunction initLib "ICDLL.dll" (ByValSoftTypeAs Integer, ByValSoftPath As String) As Boolean參數(shù)< SoftType >in整型數(shù)，安裝的門鎖管理軟件類型版本。= 0 ； ACESS 數(shù)據(jù)庫類型版本；< SoftPath >in= 1 ； SQL2000數(shù)據(jù)庫類型版本。字符指針，指向門鎖管理軟件安裝路徑字符串。返回值布爾值 True or False示例 delphiinit(0,

10、pchar( C:RF system )示例 c#init(0, ” C:RF system”)示例 pbinit(0,” C:RF system”)示例 vbinit(0,” C:RF system”)附加說明此路徑為鎖管軟件的安裝路徑IssueCard 發(fā)行客人卡函數(shù)說明用于發(fā)行客人卡。發(fā)行成功后，更新數(shù)據(jù)庫，記錄相應(yīng)客人信息、發(fā)卡操作員信息。返回發(fā)行結(jié)果。語 法 function IssueCard(RoomNo, GuestInfo:ShortString, OpInfo:Delphipchar, Loss:Integer; CheckIn, CheckOut: pchar):Inte

11、ger;語法 c#public static extern int IssueCard(string RoomNo, string GuestInfo,string OpInfo, int Loss, DateTime CheckIn, DateTime CheckOut);語法 PBfunction long IssueCard (ref string RoomNo,ref stringGuestInfo,ref string OpInfo, int Loss,ref string CheckIn,ref stringCheckOut) Library "icdll.dll&quo

12、t;語法 VBPublic Declare Function IssueCard Lib "ICDLL.dll" (ByVal RoomNoAs String, ByVal GuestInfo As String, ByVal OpInfo As String, ByValLoss As Integer, ByVal CheckIn As String, ByVal CheckOut AsString) As Integer參數(shù)<RoomNo>in字符指，房間號，長度不大于20 。注意須與門鎖管理軟件設(shè)定房間號碼一致，且不能為空。<GuestInfo>

13、;in字符指，客人信息，可以為空。<OpInfo>in字符指，操作員信息，可以為空。<Loss>in整數(shù)型，指示是否需要設(shè)定掛失。設(shè)定掛失，該卡首次開門后之前發(fā)行的客人卡即失效。一般新客人入住發(fā)行首張客人卡須設(shè)定掛失； 復(fù)制發(fā)行已入住客人卡不得設(shè)定掛失，除非已入住客人主動(dòng)掛失后重發(fā)客人卡。= 0 ；不設(shè)定掛失；<CheckIn>in= 1 ；設(shè)定掛失。yymmddhhmm字符指針，入住時(shí)間。格式<CheckOut>in字符指針，退房時(shí)間。格式y(tǒng)ymmddhhmm返回值= 0 ， 1，2，3，4，9，10 ，11 ，15 ，85 ，86，87 ，8

14、9示例 delphiIssueCard （ pchar(8101 ),pchar( 張 三 ),pchar( 李 四 ),0,pchar( 0904011011), pchar( 0904021011 )）專業(yè)資料.示例 c#IssueCard（” 8101 ” ,”張三”,”李四”,0, 2009-1-18 ： 00 ： 00,2009-1-2 12： 00 ）示例 pbIssueCard（ ” 8101 ” ,” 張 三 ” ,” 李 四 ” ,0,“ 0901010800” ,“ 0901021200 ”）示例 vbIssueCard（ ” 8101 ” ,” 張 三 ” ,” 李 四

15、” ,0,“ 0901010800” ,“ 0901021200 ”）附加說明1、房號為鎖管軟件中房號設(shè)置中設(shè)置的房號，可在主界面中或者房號設(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ā)行加卡（復(fù)制卡）。8、卡片要被掛失2 張卡之間的入住時(shí)間必須相差大

16、于1 分鐘，而且時(shí)間較晚的卡必須帶有掛失標(biāo)志。9、如果酒店使用退房卡，則鎖管軟件中的系統(tǒng)設(shè)置中的提前發(fā)卡必須設(shè)置為不提前（具體設(shè)置請參考使用手冊中的系統(tǒng)設(shè)置部分）。ReadCard 讀取客人卡函數(shù)說明用于讀取客人卡信息。讀取成功后，讀取卡片上信息并查詢數(shù)據(jù)庫對應(yīng)卡片發(fā)卡時(shí)記錄的客人信息、發(fā)卡操作員信息。返回讀取結(jié)果。語 法 function ReadCard(RoomNo, GuestInfo, OpInfo, CheckIn,DelphiCheckOut, CardNo:pchar):Integer;語法 C#public static extern int ReadCard(StringB

17、uilder RoomNo,StringBuilder GuestInfo, StringBuilder OpInfo, StringBuilder CheckIn,StringBuilder CheckOut,StringBuilderCardNo);語法 PBFunction long ReadCard (ref string RoomNo, ref string GuestInfo,ref string OpInfo, ref string CheckIn, ref string CheckOut, ref stringCardNo) Library "ICDLL.dll&qu

18、ot;語法 VBPublic Declare Function ReadCard Lib "ICDLL.dll" (ByVal RoomNoAs String, ByVal GuestInfo As String, ByVal OpInfo As String, ByValCheckIn As String, ByVal CheckOut As String, ByVal CardNo AsString) As Integer參數(shù)<RoomNo>Out字符指針，房間號。<GuestInfo>Out字符指針，客人信息。<OpInfo>Out

19、字符指針，操作員信息。<CheckIn>Out字符指針，入住時(shí)間。<CheckOut>Out字符指針，退房時(shí)間。<CardNo>Out字符指針，卡號 (MF 為物理卡號 ,RF 為流水號 ,IC為我廠出廠時(shí)的一個(gè)固定的序號)返回值= 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)專

20、業(yè)資料.示例 pbReadCard(RoomNo,GuestInfo,OpInfo,CheckIn,CheckOut,CardNo)示例 vbReadCard(RoomNo,GuestInfo,OpInfo,CheckIn,CheckOut,CardNo)CancelCard 注銷客人卡函數(shù)說明注銷客人卡 ,使卡片回復(fù)新卡狀態(tài)，并更新數(shù)據(jù)庫。該函數(shù)不能注銷功能卡語 法 function CancelCard(OpInfo:pchar):Integer;Delphi語法 C#public static extern int CancelCard(string OpInfo);語法 PBfunct

21、ion int CancelCard (ref string OpInfo) library“ icdll.dll”語法 VBPublic Declare Function CancelCard Lib“ ICDLL.dll” (ByValOpInfo As String) As Integer參數(shù)<OpInfo>in字符指針，操作員信息。返回值= 0 ，1，2，3，4， 7，9，10 ，15 ，85 ，86，87 ，88 ，89示例 delphiCancelCard(pchar( 張三 )示例 c#CancelCard(“張三” )示例 pbCancelCard(“張三” )示例

22、 vbCancelCard(“張三” )Windows API接口示例使用說明打開軟件接口說明示例文件，專業(yè)資料.根據(jù)安裝的鎖管軟件找到相應(yīng)的動(dòng)態(tài)庫文件，選擇軟件類型， 如果鎖管軟件為單機(jī)版則軟件類型選擇 ACESS, 如果為網(wǎng)絡(luò)類型則選擇SQL2000 ：專業(yè)資料.在桌面的鎖管軟件快捷方式上右鍵- 屬性單擊查找目標(biāo)按鈕。專業(yè)資料.將地址欄中的地址復(fù)制到示例當(dāng)中的軟件安裝路徑：然后單擊初始化按鈕進(jìn)行初始化，初始化完成之后即可對卡片進(jìn)行讀寫注銷等操作5Windows API接口返回值說明返回值返回值說明及故障原因排錯(cuò)方法0 操作成功1無卡。查看卡片位置是否放好2非法卡。人工注銷后，重新發(fā)行使用。

23、3授權(quán)錯(cuò)誤。必須返回廠或代理商處重新初始化串口通信錯(cuò)誤。發(fā)卡機(jī)串口連接中檢查發(fā)卡機(jī)連接；更改門鎖管理軟4斷；串口被其它程序占用；連續(xù)多件串口或其它程序串口設(shè)置；連續(xù)次調(diào)用函數(shù)時(shí)未插入延時(shí)。調(diào)用函數(shù)時(shí)插入500 毫秒以上延時(shí)。7新卡。讀卡或注銷時(shí)返回的一個(gè)值，表示該卡無須注銷非客人卡。使用門鎖管理軟件進(jìn)行注銷卡操9作。 (接口只提供客人卡操作，非客人卡則會(huì)提示此信息 )10調(diào)用錯(cuò)誤。檢查調(diào)用函數(shù)語法、 輸入?yún)?shù)類型、拼寫。11房號不存在檢查傳入的房間號碼是否正確15數(shù)據(jù)庫連接錯(cuò)誤。檢查 Init 函數(shù)輸入?yún)?shù)； SQL 數(shù)據(jù)庫用戶密碼設(shè)定（此為和門鎖軟件專業(yè)資料.數(shù)據(jù)庫同步連接，如果傳入?yún)?shù)錯(cuò)誤

24、則無法建立連接）。85系統(tǒng)日前錯(cuò)誤。重新計(jì)算升遷號86未計(jì)算升遷號。計(jì)算升遷號87系統(tǒng)過期。重新計(jì)算升遷號89升遷號被破壞。重新計(jì)算升遷號6. TCP/IP 接口6.1接口特點(diǎn)以及接口使用條件該接口特點(diǎn)在于可以通過網(wǎng)絡(luò)控制安裝了發(fā)卡機(jī)設(shè)備的電腦完成發(fā)卡，無須在每臺(tái)電腦上安裝發(fā)卡機(jī)設(shè)備。正常使用該接口必須滿足如下要求：首先安裝創(chuàng)佳門鎖公司提供的門鎖軟件，正常運(yùn)行軟件，發(fā)行各種設(shè)置卡（包括：授權(quán)卡、時(shí)鐘卡、房號卡），使用設(shè)置卡完成門鎖設(shè)置（如果有多臺(tái)電腦發(fā)卡，則每臺(tái)電腦都必須安裝我們門鎖軟件并注冊，然后用主電腦上的授權(quán)卡恢復(fù)授權(quán)，詳細(xì)操作請參考門鎖設(shè)置說明） 。使用 windows98/2000/

25、XP操作系統(tǒng) .6.2 TCP/IP接口文件如下表:文件名文件說明Server.exe服務(wù)端可執(zhí)行文件(在服務(wù)器端運(yùn)行，唯一 )Client.exe客戶端可執(zhí)行文件(在客戶端運(yùn)行，每個(gè)客戶端一Computer.mdb個(gè) )數(shù)據(jù)庫（客戶端與網(wǎng)絡(luò)端都需要）.ICDLLICDLL.dll客戶端庫文件 ,IC 門鎖.RFDLLICDLL.dll客戶端庫文件 ,RF 門鎖專業(yè)資料.MFDLLICDLL.dll客戶端庫文件 ,MF 門鎖附加說明 :表示 server.exe文件所在目錄該協(xié)議采用TCP/IP 協(xié)議，接口使用方利用SocketClient按照固定格式發(fā)送數(shù)據(jù)和指令，接口系統(tǒng)（ Socket

26、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)計(jì)算機(jī)）?？蛻舳耸前l(fā)卡端，完成發(fā)卡與信息顯示功能， 安裝在發(fā)卡工作站或讀卡與信息顯示工作站上?？蛻舳藬?shù)量不受任何限制，可以安裝在所有需要發(fā)卡的工作站上，不同工作站也可以共用一個(gè)客戶端發(fā)卡。酒店管理系統(tǒng)與接口服務(wù)端通信，接口服務(wù)端接收指令并分配到指定客戶端執(zhí)行?？蛻舳藞?zhí)行命令后將執(zhí)行狀態(tài)反饋到服務(wù)端，服務(wù)端再將執(zhí)行狀態(tài)轉(zhuǎn)

27、換為應(yīng)答信息回應(yīng)酒店管理系統(tǒng)。7 TCP/IP 數(shù)據(jù)通訊協(xié)議7.1 控制字符STX（ 0x02 ）：用于標(biāo)記數(shù)據(jù)記錄的開始。ETX（ 0x03 ）：用于標(biāo)記數(shù)據(jù)記錄的結(jié)束。RS （ 0x7C ）：即分割符 |，用于標(biāo)記新字段（域）的開始，其后緊跟字段標(biāo)識(shí)碼。7.2信息格式信息格式為：<STX>ddssffdata<ETX>。專業(yè)資料.信息域說明dd目標(biāo)地址，目標(biāo)（客戶端）地址(此地址為服務(wù)器添加客戶端數(shù)據(jù)中的發(fā)行機(jī)編號)ss源地址，標(biāo)明信息來源(此地址為服務(wù)器添加客戶端數(shù)據(jù)中的發(fā)行機(jī)編號 )ff命令或應(yīng)答代碼data數(shù)據(jù)區(qū)（非必須）目標(biāo)地址： 2 字節(jié)，有效值00-99

28、 ，接收信息的目的地址或指定執(zhí)行命令的客戶端。源地址： 2 字節(jié)，有效值00-99 （ 00 系統(tǒng)保留），標(biāo)明信息來源。例子說明：假如在server.exe中添加了客戶端2 個(gè)客戶端發(fā)行機(jī)編號01電腦名稱為 c1 , 發(fā)行機(jī)編號02 電腦名稱為c2, 如果從 c1 電腦要在 c2 電腦上發(fā)行卡， 則 dd為 02ss 為 01.命令代碼： 1 字節(jié)， ASCII 碼，指定執(zhí)行的命令。B- 客人退房（注銷卡）E- 讀卡G- 客人入?。òl(fā)卡）I- 新客人入住（發(fā)卡，同時(shí)將在住客人退房）應(yīng)答代碼： 1-2 字節(jié)， ASCII 碼，指定命令執(zhí)行的結(jié)果。0- 成功完成1- 未確定的錯(cuò)誤2- 錯(cuò)誤的（無效

29、的）目標(biāo)地址3- 無效的命令代碼專業(yè)資料.4- 串口錯(cuò)誤5- 發(fā)行機(jī)正忙6- 無效的客房7- 新卡8- 發(fā)行機(jī)等候超時(shí)10- 無效的時(shí)間11- 客戶端沒有連接12- 客戶端通信錯(cuò)誤數(shù)據(jù)區(qū)（ data ）：數(shù)據(jù)可根據(jù)需要給出不同數(shù)據(jù)，格式為：|<FI>data。|（ 0x7C 即分割符| ）標(biāo)明字段（域）開始。<FI> 字段（域）標(biāo)識(shí)，1-2 字節(jié) ASCII 碼，標(biāo)明字段（域）數(shù)據(jù)意義。字段 ID說明數(shù)據(jù)長度格式示例R(0x52)房號1-7803D(0x44)客人入住時(shí)間12yyyymmddhhn2004050812n00O(0x4F)客人預(yù)離時(shí)間12yyyymmddhhn2004100112n00N(0x4E)客人姓名1-30C(0x43)發(fā)卡數(shù)量1僅數(shù)字7.3命令詳解以下示例中LIS（ Locstar Interface System）代表創(chuàng)佳接口系統(tǒng)，PMS 代表酒店管理系統(tǒng)接口， < > 括號括起來的部分代表1 字節(jié)的控制字符。專業(yè)資料.客人入住 / 退房命令新客人入?。?I ）：此命令首先將指定房間內(nèi)所有客人退房（僅數(shù)據(jù)庫操作，不注銷客人卡）再發(fā)行新的客人卡。此命令僅適用于第一位客人入住，在同一房間添加