城市轨道交通自动售检票系统API接口规范
DB 11/T 1164.5—XXXX 11 附录A (资料性) API 接口规范 A.1引言 本附录定义了车票处理单元API接口的技术规范,包括函数的命名规则、参数定义、返回值 以及 异常处理等。 A.2蜂鸣器API A.2.1Beep Key Open Beep Key Open 包括: a)原型:S16_t BeepKeyOpen(void); b)描述:打开 BeepKey(蜂鸣器)设备; c)参数:无。 A.2.2Beep Key Close Beep Key Close 包括: a)原型:S16_t BeepKeyClose(void); b)描述:关闭 BeepKey(蜂鸣器)设备; c)参数:无。 A.2.3Beep Beep 包括: a)原型:S16_t Beep(U32_t BeepLev, U32_t Delay50Ms); b)描述:蜂鸣器开始鸣叫; c)参数: 1)U32_t BeepLev:Beep 音调(0 --- 6) 其中 6 蜂鸣声音最响; 2)U32_t Delay50Ms: 蜂鸣的声音长度。 A.2.4函数返回值 无特殊说明时,函数返回0为成功,其他为失败。 A.3LED灯API LedLight 包括: a)原型:S16_t LedLight(U32_t index, U32_t mode); DB 11/T 1164.5—XXXX 12 b)描述:控制 LED 灯; c)参数: 1)U32_t index:LED 灯的索引位置,从 1 开始; 2)U32_t mode: 灯状态 0 表示熄灭,1 表示亮。 A.4以太网API A.4.1TCPIP_CommOpen TCPIP CommOpen 包括: a)原型:S32_t TCPIP_CommOpen( U8_t * pPortDescriptor, U8_t *pOpenParams, S32_t dwPortAttr, S32_t nTimeout, 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_t nTimeout: 连接超时时间澹(单位毫秒); 5)S32_t *pErrCode:出错返回码,参考本标准部分的“函数返回码”。 d)返回值:网络句柄 网络句柄包括: 1)=0 出错句柄 无效; 2)0 正确句柄 有效。 A.4.2TCPIP_CommAccept TCPIP_CommAccept 包括: a)原型:S32_t TCPIP_CommAccept(S32_t hPort ); b)描述:服务器监控 TCP/IP 端口的 TCP/IP 连接; c)参数: S32_t hPort: 服务器端口号; d)返回值: 网络句柄: DB 11/T 1164.5—XXXX 13 0 表示出错句柄 无效; 大于 0 表示正确句柄 有效。 A.4.3TCPIP_CommRead TCPIP_CommRead 包括: a)原型:S32_t TCPIP_CommRead( S32_t hPort,U8_t *pBuffer,S32_t nBytesToRead); b)描述:向已打开 TCP/IP 端口读数据; c)参数: 1)S32_t hPort:端口句柄; 2)U8_t *pBuffer:接收数据所放数据指针; 3)S32_t nBytesToRead:希望接收的数据个数; d)返回值:实际从 PORT 端口读的数据个数。 A.4.4TCPIP_CommWrite TCPIP_CommWrite 包括: a)原型:Int TCPIP_CommWrite( S32_t hPort,U8_t *pBuffer, S32_t nBytesToWrite); b)描述:向已打开 TCP/IP 端口写入数据; c)参数: 1)S32_t hPort: 端口句柄; 2)U8_t *pBuffer: 发送数据所放数据指针; 3)S32_t nBytesToWrite:希望发送的数据个数; d)返回值:实际向 PORT 端口发送的数据个数。 A.4.5TCPIP_CommControl TCPIP_CommControl 包括: a)原型: S32_t TCPIP_CommControl( S32_t hPort, S32_t n, void *pBuffer, S32_t nDataLength); b)描述:向已打开 TCP/IP 端口通过命令发送控制信息; c)参数: 1)S32_thPort:端口句柄; 2)S32_tn: 发送命令字节具体规划如下: 1 表示获取上次 TCP/IP 端口操作失败的错误码(适合服务器和客户器); 2 表示获取向端口发送的信息数据(适合服务器和客户器); 3 表示设置通信超时间(单位 ms)(适合服务器和客户器); 4 表示获取通信超时间; DB 11/T 1164.5—XXXX 14 5 表示清除发送缓冲区数据; 6 表示清除接收缓冲区数据; 7 表示设置最大可连接客户机的个数; 8 表示获取最大可连接客户机的个数; 9 表示获取当前已经连接的客户机的个数; 10 表示获取当前服务器所能连接客户机器最大个数能力; 其他值表示为预留; 3)void *pBuffer:输入数据指针; 4)S32_tnDataLength:输入数据长度: 当 n =1 时候,pBuffer:错误码,nDataLength:固定 4 个字节; 当 n =2 时候,pBuffer:输入信息指针,nDataLength:输入信息长度; 当 n =3、4 时候,pBuffer:输入超时信息结构指针,nDataLength:输入超时信息结构 长度; 当 n =5、6 时候,pBuffer:NULL,nDataLength:NULL; 当 n =7、8、9、10 时候,pBuffer:个数,nDataLength:固定 4 个字节。 A.4.6TCPIP_CommClose TCPIP_CommClose 包括: a)原型:S32_t TCPIP_CommClose( S32_t hPort ); b)描述:关闭已打开端口并释放端口资源; c)参数: S32_t hPort:端口句柄; d)返回值: 1)0 表示关闭成功; 2)小于 0 表示关闭失败。 A.4.7函数返回码 无特殊说明时,函数返回0为成功,其他为失败。 A.5串口API A.5.1Serial_CommOpen Serial_CommOpen 包括; a)原型:S32_t Serial_CommOpen