中控售飯機(jī)SDK用戶手冊(cè)

1、案卷號(hào)日期用 戶 手 冊(cè)作者：完成日期：簽收人：簽收日期：修改情況記錄：版本號(hào)修改批準(zhǔn)人修改人安裝日期簽收人目錄1 SDK開發(fā)說明11.1 簡(jiǎn)介11.2 背景11.3 定義11.4 SDK 安裝1接口調(diào)用流程7l修改密碼（加密）7l初始化IC卡（清空IC卡）8l發(fā)卡8l讀卡9l充值102 數(shù)據(jù)結(jié)構(gòu)說明112.1 消費(fèi)機(jī)器數(shù)據(jù)結(jié)構(gòu)11l消費(fèi)機(jī)中數(shù)據(jù)表說明：11l數(shù)據(jù)添加格式162.2 卡片數(shù)據(jù)結(jié)構(gòu)162.3 狀態(tài)報(bào)告16l返回狀態(tài)碼及意義163 SDK開發(fā)函數(shù)說明183.1 消費(fèi)機(jī)器sdk開發(fā)函數(shù)183.2 卡操作sdk卡發(fā)函數(shù)18l1 ZK_PosClearICCard18l2ZK_PosIs

2、sueICCard18l3ZK_PosReadICCard19l4ZK_PosWriteICCardMoney19l5ZK_PosWriteICCardPassWord19l6ZK_PosUpdateParam20l7ZK_PosReadCardSerial204 開發(fā)建議201 SDK開發(fā)說明1.1 簡(jiǎn)介SDK：是針對(duì)獨(dú)立軟件開發(fā)商（ISV）和系統(tǒng)集成商（SI）的軟件開發(fā)及技術(shù)產(chǎn)品服務(wù)的需求，提供的消費(fèi)軟件系統(tǒng)與消費(fèi)機(jī)及IC卡讀寫器通訊的開發(fā)組件（SDK，Software Development Kit)1.2 背景 系統(tǒng)名稱：SDK消費(fèi)系統(tǒng)開發(fā)組件1.3 定義 參數(shù)KEY值卡密碼,格式為每

3、個(gè)字節(jié)密碼以逗號(hào)分隔如“FF,FF,FF,FF,FF,FF”， 每個(gè)字節(jié)是該數(shù)字的ASCII碼的16進(jìn)制表示形式，如：卡密碼是123456，那么轉(zhuǎn)化后為“31，32，33，34，35，36 ”， 所有函數(shù)的卡密碼格式相同，不在贅述1.4 SDK 安裝l 使用消費(fèi)機(jī)sdk接口函數(shù)需要用到多個(gè)動(dòng)態(tài)庫(kù)文件，詳見“消費(fèi)機(jī)dll庫(kù)”文件夾，把該文件夾的所以dll文件放到工程目錄下即可，具體應(yīng)用參考例程l 使用卡操作sdk時(shí)，采用ocx控件形式，需要安裝本公司提供的驅(qū)動(dòng)程序獲得控件庫(kù)文件。驅(qū)動(dòng)程序在“控件”文件夾中,安裝好驅(qū)動(dòng)后，默認(rèn)目錄（xp系統(tǒng)）在c:windowssystem32下找到以下兩個(gè)文件。

4、Biokey.ocx控件庫(kù)文件控件庫(kù)文件l 分別注冊(cè)控件控件庫(kù)文件：regsvr32.exe c:windowssystem32regsvr32.exe c:windowssystem32ZKO注意：Windows Vista客戶需要以管理員權(quán)限才能正確執(zhí)行regsvr32；l 注冊(cè)成功后，就可以在相應(yīng)的開發(fā)環(huán)境中導(dǎo)入控件。A：在Delphi 7 開發(fā)環(huán)境:第一步：ComponentImport Activex Control如下圖所示：進(jìn)入如下界面，按下圖所示操作，安裝兩個(gè)控件B：在Microsoft Visual Studio .NET 2003的VB項(xiàng)目中第一步：注冊(cè)控件，如下圖所示進(jìn)入

5、注冊(cè)界面然后進(jìn)入ActiveX控件測(cè)試容器界面，如下圖：選擇“文件注冊(cè)控件”，找到注冊(cè)文件，如下圖所示：注冊(cè)成功后，多了剛才注冊(cè)的選項(xiàng)，如下圖所示：第二步：添加控件到工具欄中，方法如下圖所示：添加好后，在控件里就添加好了該控件，如下圖所示：C：在中使用 第一步：注冊(cè)控件，方法跟VB的類似。 第二步：使用控件，操作如下圖所示在下圖中選擇要插入的控件：接口調(diào)用流程接口調(diào)用流程如下： 消費(fèi)機(jī)器接口調(diào)用流程 IC卡操作業(yè)務(wù)流程l 修改密碼（加密）連接發(fā)卡器讀取卡序列號(hào)成功修改主、備份扇區(qū)密碼結(jié)束YN沒有找到IC卡或卡是否損壞判斷是否白卡白卡YNl 初始化IC卡（清空IC卡）連接發(fā)卡器讀取卡序列號(hào)成功清

6、空主、備份扇區(qū)密碼結(jié)束YN沒有找到IC卡或卡是否損壞l 發(fā)卡連接發(fā)卡器讀取卡序列號(hào)成功判斷是否白卡結(jié)束YN沒有找到IC卡或卡是否損壞白卡Y判斷各參數(shù)正確這不是一張空白卡，不能發(fā)卡。請(qǐng)將該卡先初始化!發(fā)卡寫主扇區(qū)NYN成功發(fā)卡寫備份扇區(qū)成功清空主扇區(qū)卡信息塊NNYYl 讀卡連接發(fā)卡器讀取卡序列號(hào)成功解析數(shù)據(jù)結(jié)束YN沒有找到IC卡或卡是否損壞讀主扇區(qū)數(shù)據(jù)成功YN讀備份扇區(qū)數(shù)據(jù)成功YNl 充值NY讀卡成功寫主扇區(qū)金額結(jié)束YN判斷充值參數(shù)正確NY判斷是否同一張（讀兩次序列號(hào)）同一卡NY成功讀主扇區(qū)金額成功且寫=讀寫備份扇區(qū)金額成功讀備份扇區(qū)金額成功且寫=讀執(zhí)行次數(shù) 10YYYYNNNN2 數(shù)據(jù)結(jié)構(gòu)說明

7、2.1消費(fèi)機(jī)器數(shù)據(jù)結(jié)構(gòu)l 消費(fèi)機(jī)中數(shù)據(jù)表說明：1UserInfo：（用戶信息表）字段名說明SysID系統(tǒng)卡號(hào)UserID用戶編號(hào)PIN用戶工號(hào)CardNo卡號(hào)Name姓名PassWord差額密碼SegNoUserType用戶類型(1黑名單,0白名單)Privage權(quán)限(1管理員,0普通用戶)2Template：(指紋信息)3OpLog：（管理日志）字段名說明OPID操作員IDTIME操作時(shí)間OP操作編碼4PosLog：（消費(fèi)記錄）字段名說明SysID系統(tǒng)卡號(hào)CardNo卡號(hào)PosTime消費(fèi)時(shí)間PosMoney消費(fèi)金額Balance余額RecNo機(jī)器流水號(hào)CardRecID卡流水號(hào)State消

8、費(fèi)類型Mealtype餐別MealDate記餐日期OPID操作員ID5PRESSKEY(鍵值信息表)字段名說明KeyID鍵值編號(hào)Price價(jià)格6StoreInfo：（商品信息）字段名說明StoreNo商品編號(hào)Name商品名稱Bc條碼Price價(jià)格agio折扣7Mealtype：（餐別信息）字段名說明Mlid餐別編號(hào)Name餐別名稱Start開始時(shí)間End結(jié)束時(shí)間8TimeSeg：（就餐批次時(shí)間段信息）字段名說明SegID批次編號(hào)（1為固定時(shí)段）TsID時(shí)段編號(hào)Start開始時(shí)間End結(jié)束時(shí)間9FIXED（分段定值表）字段名說明TsID時(shí)段編號(hào)Start開始時(shí)間End結(jié)束時(shí)間Price價(jià)格10P

9、ayDetail：（商品消費(fèi)明細(xì)信息， 商品消費(fèi)時(shí)對(duì)應(yīng)消費(fèi)記錄的明細(xì)信息）字段名說明RecNo機(jī)器流水號(hào)StoreNo商品編號(hào)Price實(shí)收價(jià)格RecSum單筆消費(fèi)商品流水號(hào)11KEYDETAIL 鍵值消費(fèi)明細(xì)表字段名說明RecNo機(jī)器流水號(hào)KeyID鍵值編號(hào)Price實(shí)收價(jià)格RecSum單筆消費(fèi)商品流水號(hào)12TmPosLog：（記時(shí)消費(fèi)數(shù)據(jù)）字段名說明SysID卡號(hào)StartTme開始時(shí)間StartBanlance開始金額EndTime結(jié)束時(shí)間EndBanlance結(jié)束金額（余額）13CARDTYPE（卡類設(shè)置表）字段名說明SortID卡類序號(hào)Name卡類名稱rebate折扣Timemaxm

10、oney次消費(fèi)最大金額Daymaxmoney天消費(fèi)最大金額Mealmaxmoney餐消費(fèi)最大金額Daymaxtimes天消費(fèi)最大次數(shù)Mealmaxtimes餐消費(fèi)最大次數(shù)Lowlimit最小卡余額Maxlimit最大卡余額MealType可用餐別Enable是否可用limit有效天數(shù)BatchNo使用時(shí)段UseFinger是否使用指紋（1或0）14FULLVALUE（充值記錄表）字段名說明SysID系統(tǒng)卡號(hào)CardNo卡號(hào)CardRecNO卡流水號(hào)Money充值金額Balance余額LogType充值類型OPID操作員IDRecNo機(jī)器流水號(hào)15SUBSIDYLOG（補(bǔ)貼流水記錄表）字段名說明

11、SysID系統(tǒng)卡號(hào)CardNo卡號(hào)Batch補(bǔ)貼批號(hào)Money補(bǔ)貼金額allowDate補(bǔ)貼日期16SIDYLOG（已補(bǔ)貼記成功錄表）字段名說明SysID系統(tǒng)卡號(hào)CardNo卡號(hào)CardRecID卡流水號(hào)Batch補(bǔ)貼批號(hào)AllowTime補(bǔ)貼時(shí)間AllowMoney補(bǔ)貼金額Balance余額state補(bǔ)貼方式 0：清零補(bǔ)貼BaseBatch補(bǔ)貼基次RecNo機(jī)器流水號(hào)17SubSidy：（待補(bǔ)貼記錄表）字段名說明SysID系統(tǒng)卡號(hào)CardNo卡號(hào)Batch補(bǔ)貼批號(hào)AllowMoney補(bǔ)貼金額BaseBatch補(bǔ)貼基次allowDate補(bǔ)貼日期l 數(shù)據(jù)添加格式向消費(fèi)機(jī)中的表添加數(shù)據(jù)，是將記錄組

12、合成一個(gè)字符串發(fā)送到機(jī)器中的，字符串格式為：字段名=值（tab鍵）字段名=值記錄與記錄之間以換行符號(hào)連接如商品資料的一條記錄為“StoreNo=1 Name=包子Bc=464654646 Price=0.5 agio=80”，注意：字段之間是tab符號(hào)從消費(fèi)機(jī)讀取的格式也相同，需要自行解析字符串，得到每條記錄每個(gè)字段的數(shù)據(jù)。2.2 卡片數(shù)據(jù)結(jié)構(gòu)l 讀取卡片返回?cái)?shù)據(jù)的組成結(jié)構(gòu)數(shù)據(jù)格式采用“字段名1=值1，字段名2=值2”的形式字段名為上述余額扇區(qū)結(jié)構(gòu)說明中的字段名2.3 狀態(tài)報(bào)告l 返回狀態(tài)碼及意義-1:Result := 傳入?yún)?shù)非法; -2: Result := 主、備份扇區(qū)數(shù)據(jù)不一致; 1

13、: Result := 操作失敗; 2: Result := 數(shù)據(jù)丟包; 3: Result := 沒有選擇準(zhǔn)確的COM口; 4: Result := 和卡通訊超時(shí); 5, 7: Result := XOR校驗(yàn)出錯(cuò); $A: Result := 輸入的參數(shù)大于最大允許范圍，溢出; $80: Result := 參數(shù)設(shè)置成功; $81: Result := 參數(shù)設(shè)置失敗; $82: Result := 通訊超時(shí); $83: Result := 卡不存在; $84: Result := 接收卡數(shù)據(jù)出錯(cuò); $85: Result := 輸入?yún)?shù)或者輸入命令格式錯(cuò)誤; $87: Result := 未

14、知的錯(cuò)誤; $8A: Result := 在塊初始化中出現(xiàn)錯(cuò)誤; $8B: Result := 在防沖突過程中得到錯(cuò)誤的序列號(hào); $8C: Result := 密碼認(rèn)證沒通過; $8F: Result := 讀寫設(shè)備接收到了未定義的命令; $90: Result := 卡不支持這個(gè)命令; $91: Result := 命令格式有錯(cuò)誤; $92: Result := 在命令的FLAG參數(shù)中, 不支持OPTION模式; $93: Result := 要操作的BLOCK不存在; $94: Result := 要操作的對(duì)象已經(jīng)別鎖定, 不能進(jìn)行修改; $95: Result := 鎖定操作不成功; $

15、96: Result := 寫操作不成功;l 用途獲得接口函數(shù)執(zhí)行結(jié)果狀態(tài)描述內(nèi)容（適用與卡操作函數(shù)）3SDK開發(fā)函數(shù)說明3.1 消費(fèi)機(jī)器sdk開發(fā)函數(shù)詳細(xì)參閱dataapi接口使用指南3.2 卡操作sdk卡發(fā)函數(shù)l 1ZK_PosClearICCard【功能】對(duì)卡進(jìn)行初始化，清除卡片數(shù)據(jù)，將扇區(qū)字節(jié)寫為0X 00【需要參數(shù)說明】commHandle: int：無符號(hào)整型，發(fā)卡器端口資源句柄，默認(rèn)為0key: string：卡密碼。mainsec：整型，115，主扇區(qū)號(hào)，每個(gè)扇區(qū)的三個(gè)塊backsec：整型，115，備份扇區(qū)號(hào)，每個(gè)扇區(qū)的三個(gè)塊【返回值】=0：初始化成功0：其它見l 2ZK_P

16、osIssueICCard【功能】對(duì)卡寫數(shù)據(jù)，發(fā)放卡片【需要參數(shù)說明】commHandle：整型，發(fā)卡器設(shè)備句柄key：卡密碼overPwd：整型，六位數(shù)字，超額密碼Cardno：整型，1999999999，卡號(hào)money：整型，初始金額，1999900，cardtype：整型，199，卡片類別號(hào)batchNo：整型，卡片版本號(hào)miansec：整型，115，主扇區(qū)號(hào)backsec：整型，115，備份扇區(qū)號(hào)【返回值】 =0：發(fā)卡成功0：其它見l 3ZK_PosReadICCard【功能】讀取卡片數(shù)據(jù)，數(shù)據(jù)包括卡號(hào)，余額等信息【參數(shù)說明】commHandle：整型，發(fā)卡器設(shè)備句柄，0key：卡密碼

17、miansec：整型，115，主扇區(qū)號(hào)backsec：整型，115，備份扇區(qū)號(hào)Data：字符串，返回讀取的數(shù)據(jù)，數(shù)據(jù)格式采用“字段名1=值1，字段名2=值2”的形式 【返回值】返回字符串”字段名1=值,字段名1=值”，可以判斷字符串是否包含或字符串長(zhǎng)度，不包含則失敗，其它見l 4ZK_PosWriteICCardMoney【功能】對(duì)卡片寫入金額充值，主扇區(qū)和備份扇區(qū)的 第二和第三塊需要寫成相同的數(shù)據(jù)?！緟?shù)說明】commHandle：無符號(hào)整型，發(fā)卡器設(shè)備句柄key：卡密碼 Money：整型，1999900，寫入金額mainsect：整型。115，存儲(chǔ)數(shù)據(jù)的主扇區(qū)號(hào)backsec：整型，115

18、，備份扇區(qū)號(hào)【返回值】 =0：充值成功 1：其它見l 5ZK_PosWriteICCardPassWord【功能】修改卡密碼【參數(shù)說明】commHandle：整型，發(fā)卡器設(shè)備句柄oldkey：六位數(shù)字字符串，原卡密碼newkey：六位數(shù)字字符串，新密碼mainsect：整型。115，存儲(chǔ)數(shù)據(jù)的主扇區(qū)號(hào)backsec：整型，115，備份扇區(qū)號(hào)【返回值】 =0：成功 1：其它見l 6ZK_PosUpdateParam【功能】修改卡片參數(shù)，可以修改卡片超額密碼、發(fā)卡日期、卡類【參數(shù)說明】commHandle：無符號(hào)整型，發(fā)卡器設(shè)備句柄key：卡密碼overPwd: 整型，新超額密碼issueDate:字符串，新發(fā)卡日期，如：2011-10-08cardType：整型，new卡類mainSec: intbackSec: int【返回值】 =0：成功 1：失敗，其它見l 7ZK_PosReadCardSerial【功能】讀取卡片序列號(hào)【參數(shù)說明】commHandle：整型，發(fā)卡器設(shè)備句柄【返回值】字符串，正常為卡號(hào)可以通過判斷字符串長(zhǎng)度大于4，其它見4開發(fā)建議l 準(zhǔn)備工作合作伙伴必須通過中控科技或是中控科技代理商，取得SDK開發(fā)包和相關(guān)文檔，及相關(guān)技術(shù)支持。 l 開發(fā)建議 獲取