城市轨道交通自动售检票系统API接口规范.pdfVIP

DB11/T1164.5—XXXX

附录A

（资料性）

API接口规范

A.1引言

本附录定义了车票处理单元API接口的技术规范，包括函数的命名规则、参数定义、返回值以及

异常处理等。

A.2蜂鸣器API

A.2.1BeepKeyOpen

BeepKeyOpen包括：

a)原型：S16_tBeepKeyOpen(void)；

b)描述：打开BeepKey（蜂鸣器）设备；

c)参数：无。

A.2.2BeepKeyClose

BeepKeyClose包括：

a)原型：S16_tBeepKeyClose(void)；

b)描述：关闭BeepKey（蜂鸣器）设备；

c)参数：无。

A.2.3Beep

Beep包括：

a)原型：S16_tBeep(U32_tBeepLev,U32_tDelay50Ms)；

b)描述：蜂鸣器开始鸣叫；

c)参数：

1)U32_tBeepLev：Beep音调（06）其中6蜂鸣声音最响；

2)U32_tDelay50Ms：蜂鸣的声音长度。

A.2.4函数返回值

无特殊说明时，函数返回0为成功，其他为失败。

A.3LED灯API

LedLight包括：

a)原型：S16_tLedLight(U32_tindex,U32_tmode)；

11

DB11/T1164.5—XXXX

b)描述：控制LED灯；

c)参数：

1)U32_tindex：LED灯的索引位置，从1开始；

2)U32_tmode：灯状态0表示熄灭，1表示亮。

A.4以太网API

A.4.1TCPIP_CommOpen

TCPIPCommOpen包括：

a)原型：S32_tTCPIP_CommOpen(U8_t*pPortDescriptor,U8_t*pOpenParams,S32_tdwPortAttr,

S32_tnTimeout,S32_t*pErrCode)；

b)描述：建立TCP连接；

c)参数：

1)U8_t*pPortDescriptor：Linux网络设备描述符字符串（/dev/eth0,/dev/eth1）；

2)U8_t*pOpenParams：IP地址和端口号字符串具体格式IP：PORT比如192.167.1.22:2000

如果作为服务器，IP地址可以忽略；

3)S32_tdwPortAttr：

工作模式：

0表示本地服务器端口；

1表示连接远程服务器的客户机；

2表示连接本地服务器的客户机；

4)S32_tnTimeout：连接超时时间澹(单位毫秒)；

5)S32_t*pErrCode：出错返回码，参考本标准部分的“函数返回码”。

d)返回值：网络句柄

网络句柄包括：

1)=0出错句柄无效；

2)0正确句柄有效。

A.4.2TCPIP_CommAccept

TCPIP_CommAccept包括：

a)原型：S32_tTCPIP_CommAccept(S32_thPort)；

b)描述：服务器监控TCP/IP端口的TCP/IP连接；

c)参数：

S32_thPort：服务器端口号；

d)返回值：

网络句柄：