城市轨道交通联网收费系统车票处理单元应用程序接口示例.docx

《城市轨道交通联网收费系统车票处理单元应用程序接口示例.docx》由会员分享，可在线阅读，更多相关《城市轨道交通联网收费系统车票处理单元应用程序接口示例.docx（19页珍藏版）》请在第一文库网上搜索。

1、附录A应用程序接口示例A. 1蜂鸣器APIA. 1. 1 Beep Key OpenBeep Key Open 包括:a) 原型:S16_t BeepKeyOpen (void)；b)描述：打开BeepKey (蜂鸣器)设备；c)参数:无。A. 1.2 Beep Key CIoseBeep Key Close 包括：d) 原型:S16 t BeepKeyClose(void)；e)描述：关闭BeepKey (蜂鸣器)设备；f)参数：无。A. 1.3 BeepBeep包括：g) 原型：S16 t Beep(U32 t BeepLev, U32 t Delay50Ms)；h)描述：蜂鸣器开始鸣叫；

2、i)参数：1) U32_t BeepLev： Beep音调(0 - 6) 其中6蜂鸣声音最响;2) U32_t Dolay50Ms： 蜂鸣的声音长度。A.1.4函数返回值无特殊说明时，函数返回0为成功，其他为失败。A. 2 LED灯APILedLight 包括：j) 原型：S16_t LedLight(U32_t index, U32_t mode)；k)描述：控制LED灯；1)参数：1) U32_t index： LED灯的索引位置，从1开始；2) U32 t mode：灯状态0表不熄灭，1表不亮。A.3以太网APIA. 3. 1 TCP I P Comm0penTCPIP CommOpen

3、 包括：in) 原型:S32_t TCPIP_CommOpen( U8_t * pPortDescriptor, U8_t *pOpenParams,S32t dwPortAttr, S32_t nTimeout, S32_t *pErrCode )；)描述：建立TCP连接；o)参数：1) U8_t *pPortDescriptor： Linux 网络设备描述符字符串(/deveth”,“devethl)；2) U8_t *pOpenParams： IP地址和端口号字符串具体格式IP： PORT比如,z192. 167. 1. 22:2000如果作为服务器,IP地址可以忽略；3) S32_t

4、dwPortAttr：工作模式：0表示本地服务器端口；1表示连接远程服务器的客户机；2表示连接本地服务器的客户机；4) S32_t nTimeout：连接超时时间澹(单位毫秒)；5) S32 t pErrCode：出错返回码，参考本标准部分的“函数返回码”。P)返回值：网络句柄网络句柄包括：1) =0出错句柄无效；2) 0正确句柄有效。A. 3. 2 TCP IP_CommAcceptTCPIP_ComiMccept 包括：q)原型:S32 t TCPTP_CommAccept (S32_t hPort )；r)描述:服务器监控TCP/IP端口的TCP/IP连接；s)参数：S32_t hPor

5、t ： 服务器端口号；t)返回值：网络句柄：。表示出错句柄无效；大于0表示正确句柄 有效。A. 3. 3 TCP IP_CommReadTCPTP CommRead 包括：u) 原型：S32_t TCPlP_ConnnRead ( S32_t hPort, U8_t *pBuffer, S32_t nBytesToRead)；v)描述：向已打开TCP/IP端口读数据；w)参数:1） S32 t hPort：端口句柄；2） U8_t pBuffer：接收数据所放数据指针；3） S32_t nBytesToRead：希望接收的数据个数；x）返回值：实际从PORT端口读的数据个数。A. 3.4 TC

6、P I P_CommWr i teTCPIP_CommWrite 包括：y） 原型：Tnt TCPIPCommWri te（ S32t hPort,U8t *pBuffer, S32tnBytesToWrite）；z）描述：向已打开TCP/IP端口写入数据；aa）参数：1） S32_t hPort： 端口句柄；2） U8_t *PBuffer：发送数据所放数据指针；3） S32_t nBytesToWrite：希望发送的数据个数；bb）返回值：实际向PORT端口发送的数据个数。A. 3. 5 TCP IP_CommControITCP T PCommCon t ro 1 包括：cc）原型：S3

7、2 t TCPTP CommControl （ S32 t hPort, S32 t nCmd, void *pBuffer, S32 tnDataLength）；dd）描述：向已打开TCP/IP端口通过命令发送控制信息；ee）参数：1） S32 thPort： 端口句柄；2） S32tnCmd：发送命令字节具体规划如下：1表示获取上次TCP/IP端口操作失败的错误码（适合服务器和客户器）；2表示获取向端口发送的信息数据（适合服务器和客户器）；3表示设置通信超时间（单位ms）（适合服务器和客户器）；4表示获取通信超时间；5表示清除发送缓冲区数据；6表示清除接收缓冲区数据；7表示设置最大可连接客

8、户机的个数；8表示获取最大可连接客户机的个数；9表示获取当前已经连接的客户机的个数；10表示获取当前服务器所能连接客户机器最大个数能力；其他值表示为预留；3） void *pBuffer：输入数据指针；4） S32_t nDataLength：输入数据长度：当nCmd时候，pBuffer：错误码，nDataLength：固定4个字节；当nCmd=2时候,pBuffer：输入信息指针，nDataLength：输入信息长度；当nCmd=3、4时候,pBuffer：输入超时信息结构指针,nDataLength：输入超时信息结构长度；当 nCmd =5 6 时候，pBuffer： NULL, nDat

9、aLength： NULL；当 nCmd =7 8、9、10 时候，pBuffer：个数,nDataLength：固定 4 个字节。A. 3. 6 TCP IP_CommCIoseTCPIP_CommClose 包括：ff)原型：S32_t TCPIP_CommClose ( S32_t hPort )；gg)描述：关闭已打开端口并释放端口资源；hh)参数：S32_t hPort :端口句柄;ii)返回值：1) 0表不关闭成功；2)小于0表示关闭失败。A.3.7函数返回码无特殊说明时，函数返回0为成功，其他为失败。A. 4 串口APIA. 4. 1 Ser i al_Comm0penSeria

10、l Comm0pen 包括；jj)原型：S32_t Serial_CommOpen( U8_t *pPortDescriptor, U8_t *p0penParams,S32_t dwPortAttr, S32_t nTieout, S32_t *pErrCode)；kk)描述：打开串口函数；11)参数.1) U8_t *pPortDescriptor： Linux 串口设备描述符字符串；串口 0： 7devttyS0Z串口 1： dev/ttySl”；串口 2： /dev/ttyS2；串口 3： /dev/ttyS3；串口 4： /dev/ttyS4”；2) U8_t *pOpenParam

11、s：串口参数字符串具体格式如：9600, n, 8, 1；3) S32 t dwPortAttr：工作模式；=0本地服务器端口；=1连接远程服务器的客户机；=2连接本地服务器的客户机；4) S32 t nTimeout：连接超时时间(单位毫秒)；5) S32_t *pErrCode：出错返回码，参考本标准部分的“函数返回码”；mm)返回值：网络句柄1) =0出错句柄无效；2) 0正确句柄有效。A. 4. 2 Ser i al_CommReadSerial_ConnnRead 包括：nn)原型：S32 t Serial CommRead(S32 t hPort, U8_t *pBuffer, S

12、32 tnBytesToRead)；oo)描述：向已打开TCP/IP端口读数据；PP)参数：1) S32 t hPort ：端口句柄；2) U8_t *pBuffer：接收数据所放数据指针；3) S32_t nBytesToRead：希望接收的数据个数；qq)返回值：实际从PORT端口读的数据个数。A. 4. 3 Ser ial_CommWr iteSerial_CommWrite 包括：rr)原 型：S32 t Serial CommWrite ( S32 t hPort, U8 t *pBuffer, S32 tnBytesToWrite)；ss)描述：向已打开TCP/IP端口写入数据;t

13、t)参数：1) S32_t hPort：端口句柄;2) U8_t *pBuffer：发送数据所放数据指针；3) S32_t nBytesToWrite：希望发送的数据个数；uu)返回值：实际向PORT端口发送的数据个数。A. 4. 4 Ser i al_CommControISerial CommControl 包括：vv)原型：S32_t Serial_CommControl ( S32_t hPort, S32_t nCd, void *pBuffer,S32 t nDataLength ；ww)描述：向已打开串口端口通过命令发送控制信息；)参数:S32_t hPort ： 端 口句柄；S

14、32_t nCmd ：发送命令字节具体规划如下：=1获取上次TCP/IP端口操作失败的错误码（适合服务器和客户器）；二2获取向端口发送的信息数据（适合服务器和客户器）；二3设置通信超时间（单位ms）（适合服务器和客户器）；=4获取通信超时间；=5清除发送缓冲区数据；二6清除接收缓冲区数据；=7设置最大可连接客户机的个数；=8获取最大可连接客户机的个数；=9获取当前已经连接的客户机的个数；二10获取当前服务器所能连接客户机器最大个数能力；二其他保留以后使用；void *pBuffer ：输入数据指针；S32_t nDataLength ：输入数据长度：当nCmd =1时：pBuffer ：错误码

15、；nDataLength :固定4个字节；当nCmd = 2时：pBuffer ：输入信息指针；nDataLength ：输入信息长度；当nCmd =3s 4时:pBuffer ：输入超时信息结构指针;nDataLength ：输入超时信息结构长度；当 nCmd =5、6 时：pBuffer ： NULL ； nDataLength : NULL ；当 nCmd =7、8、9、10 时：pBuffer ：个数；nDataLength ：固定 4 个字节。A. 4. 5 Ser i a I _CommC I oseSerial_ConunClose 包括：yy）原型：S32 t Serial CommClose（ S32 t hPort）；zz）描述：关闭已打开端口并释放端口资源；aaa）参数：S32_t hPort ：端口句柄。