Difference between revisions of "APITestPage"

Revision as of 06:16, 22 October 2018

1 函数库(libfriendlyarm-hardware.so)接口说明

在应用层，可透过上一章节中的HardwareControler类来调用libfriendlyarm-hardware.so库中的接口，下面中列出HardwareControler类中的接口的定义，这些接口都是类方法，因此不需要创建HardwareControler对象实例：

1.1 通用的输入输出接口

接口名称	参数与返回值说明	功能说明
int open( String devName , int flags)	参数说明： devName: 要写入数据的 flags: 打开文件的方式，例如可读可写还是只读打开，可选值需参考 FileCtlEnum.java 返回值说明： 成功返回文件描述符，出错返回-1。	打开设备。
int ioctlWithIntValue ( int fd, int cmd, int value)	参数说明： fd:设备文件描述符 cmd: ioctl命令 value:命令参数，限整数 返回值说明： 成功返回0，出错返回-1。	执行设备的ioctl操作
int write( int fd, byte[] data)	参数说明： fd: 要写入数据的文件描述符 data: 要写入的数据 返回值说明： 成功返回写入的字节数，出错返回-1。	向打开的设备或文件中写数据。
int ioctlWithIntValue ( int fd, int cmd, int value)	参数说明： fd:设备文件描述符 cmd: ioctl命令 value:命令参数，限整数 返回值说明： 成功返回0，出错返回-1。	执行设备的ioctl操作
int read( int fd, byte[] buf, int len)	参数说明： fd: 要读出数据的文件描述符 buf: 存储数据的缓冲区 len: 要读取的字节数 返回值说明： 成功返回读取的字节数，出错返回-1，如果在调read之前已到达文件末尾，则这次read返回0。	从打开的设备或文件中读取数据。
int select( int fd, int sec, int usec)	参数说明： fd: 要查询的文件描述符 sen: 阻塞等待数据多长时间（单位：秒） usec: 阻塞等待数据多长时间 （单位：纳秒，1毫秒=1000纳秒） 返回值说明： 如果fd有数据可读，返回1, 如果没有数据可读，返回0，出错时返回-1。	查询打开的设备或文件是否有数据可读。
void close(int fd)	参数说明： fd: 要关闭的文件描述符 返回值说明： 无	关闭指定的文件描述符

1.2 串口通讯的接口说明

接口名称	参数与返回值说明	功能说明
int openSerialPortEx( String devName, long baud, int dataBits, int stopBits, String parityBit， String flowCtrl )	参数说明： devName: 串口设备文件名，可选的值有： /dev/ttyS4 baud: 波特率 dataBits: 数据位 (取值 5~8，一般用8 ) stopBits: 停止位 (取值 1~2，一般用1 ) parityBit: 奇偶校验位(取值为单个字母，O表示奇校验，E表示偶校验，N表示无校验) flowCtrl: 数据流控制(取值为单个字母，H表示硬件流控制，S表示软件流控制，N表示不使用数据流控制) 返回值说明： 成功打开串口时，将返回串口的文件描述符，用该描述符可进行 read、write和select等操作，如果打开失败，则返回 -1	打开指定的串口设备，并返回文件描述符。

接口的使用说明：

先通过调用openSerialPortEx 打开串口设备，然后可以在线程中、或者用 timer 通过调用 select 接口轮询串口设备是否有数据到来，如果有，则调用 read 接口读取数据。

要往串口中写入数据，调用 write 接口即可。
串口使用完毕后，需要调用 close 关闭串口。

1.3 开关LED的接口说明

接口名称	参数与返回值说明	功能说明
int setLedState( int ledID, int ledState )	参数说明： ledID： 指定要开关哪一个LED (取值0~3) ledState: 1表示亮，0表示灭 返回值说明： 成功返回0，失败返回-1	该接口用于开关LED灯。

1.4 让PWM蜂鸣器发声和停止发声的接口说明

接口名称	参数与返回值说明	功能说明
int PWMPlay(int frequency);	参数说明： frequency: 要发声的频率 返回值说明： 成功返回0，失败返回-1	按指定的频率让蜂鸣器发声
int PWMStop();	参数说明： 无 返回值说明： 成功返回0，失败返回-1	让蜂鸣器停止发声

1.5 读取ADC的转换结果的接口说明

接口名称	参数与返回值说明	功能说明
int readADC()	参数说明： 无 返回值说明： 成功返回ADC转换的结果，失败返回-1	读取第一个通道的ADC转换结果
int readADCWithChannel(int channel)	参数说明： channel: 读取指定通道的ADC的值 返回值说明： 成功返回ADC转换的结果，失败返回-1	读取指定通道的ADC转换的结果
int[] readADCWithChannels(int[] channels);	参数说明： channels: 要读取通道的ADC频道数组 返回值说明： 成功返回多个ADC结果（数组），错误返回空	一次性读取多个频道的结果，性能好

1.6 I2C接口说明

在使用如下接口之前，首先需要使用open接口打开I2C设备，如下所示, 操作完成后，记得用HardwareControler.close关闭：

int fd = HardwareControler.open("/dev/i2c-0", FileCtlEnum.O_RDWR);

以下接口需要该fd作来参数进行操作：

-

接口名称	参数与返回值说明	功能说明
int setI2CSlave(int fd, int slave);	参数说明： fd: I2C设备的文件描述符 slave: I2C设备地址，例如EEPROM设备一般是0x50 返回值说明： 成功返回0，失败返回-1	设置要操作的I2C设备地址，例如EEPROM设备一般是0x50
int setI2CTimeout(int fd, int timeout)	参数说明： fd: I2C设备的文件描述符 timeout: 超时时间 返回值说明： 成功返回0，失败返回-1	设置超时时间(ioctl I2C_TIMEOUT)
int setI2CRetries(int fd, int retries)	参数说明： fd: I2C设备的文件描述符 retries: 重试次数 返回值说明： 成功返回0，失败返回-1	设置重试次数(ioctl I2C_RETRIES)
int writeByteToI2C(int fd, int pos, byte byteData, int wait_ms)	参数说明： fd: I2C设备的文件描述符 pos: 字节位置 byteData:要写入的数据 wait_ms: 等待指定的时间(毫秒) 返回值说明： 成功返回0，失败返回-1	写一个字节的数据到I2C设备的指定位置,并等待指定的时间(毫秒)
int readByteFromI2C(int fd, int pos, int wait_ms);	参数说明： fd: I2C设备的文件描述符 pos: 字节位置 wait_ms: 等待指定的时间(毫秒) 返回值说明： 成功返回0，失败返回-1	从I2C设备指定的位置读一个字节的数据，并等待指定的时间(毫秒)