1 Star 0 Fork 1

RT-Thread_YOC / ap3216c

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

AP3216C 软件包

1 介绍

AP3216C 软件包提供了使用接近感应(ps)与光照强度(als)传感器 ap3216c 基本功能,并且提供了硬件中断的可选功能。本文介绍该软件包的基本功能,以及 Finsh/MSH 测试命令等。

  • 光照强度 :支持 4 个量程
  • 接近感应 :支持 4 种增益
  • 中断触发 :光照强度及接近感应同时支持 高于阈值低于阈值 的两种硬件中断触发方式

1.1 目录结构

名称 说明
ap3216c.h 传感器使用头文件
ap3216c.c 传感器使用源代码
SConscript RT-Thread 默认的构建脚本
README.md 软件包使用说明
ap3216c_datasheet.pdf 官方数据手册

1.2 许可证

AP3216C 软件包遵循 Apache-2.0 许可,详见 LICENSE 文件。

1.3 依赖

依赖 RT-Thread I2C 设备驱动框架。

2 获取软件包

使用 ap3216c 软件包需要在 RT-Thread 的包管理器中选择它,具体路径如下:

RT-Thread online packages
    peripheral libraries and drivers  --->
        [*] ap3216c: a digital ambient light and a proximity sensor ap3216c driver library  --->
        [*]   Enable hardware interrupt
        (47)    The number of the sensor hardware interrupt pin
               Version (latest)  --->

每个功能的配置说明如下:

  • ap3216c: a digital ambient light and a proximity sensor ap3216c driver library:选择使用 ap3216c 软件包;
  • Enable hardware interrupt:使能硬件中断功能;
  • The number of the sensor hardware interrupt pin:传感器硬件中断的引脚号;
  • Version:配置软件包版本,默认最新版本。

然后让 RT-Thread 的包管理器自动更新,或者使用 pkgs --update 命令更新包到 BSP 中。

3 使用 ap3216c 软件包

按照前文介绍,获取 ap3216c 软件包后,就可以按照 下文提供的 API 使用传感器 ap3216cFinsh/MSH 命令进行测试,详细内容如下。

3.1 API

3.1.1 初始化

ap3216c_device_t ap3216c_init(const char *i2c_bus_name)

根据总线名称,自动初始化对应的 ap3216c 设备,具体参数与返回说明如下表

参数 描述
name i2c 设备名称
返回 描述
!= NULL 将返回 ap3216c 设备对象
= NULL 查找失败

3.1.2 反初始化

void ap3216c_deinit(ap3216c_device_t dev)

如果设备不再使用,反初始化将回收 ap3216c 设备的相关资源,具体参数说明如下表

参数 描述
dev ap3216c 设备对象

3.1.3 读取光照强度

float ap3216c_read_ambient_light(ap3216c_device_t dev)

通过 ap3216c 传感器读取光照强度测量值,返回浮点型光照强度值(单位:lux),具体参数与返回说明如下表

参数 描述
dev ap3216c 设备对象
返回 描述
!= 0.0 测量光照强度值
=0.0 测量失败

在读取光照强度过程中,默认量程为 AP3216C_ALS_RANGE_20661,如需修改,请参照下文的设置参数 API 进行设置,可配置的量程列表如下

enum als_range
{
    AP3216C_ALS_RANGE_20661, // 量程对应精度为 0.35   lux/count.
    AP3216C_ALS_RANGE_5162,  // 量程对应精度为 0.0788 lux/count.
    AP3216C_ALS_RANGE_1291,  // 量程对应精度为 0.0197 lux/count.
    AP3216C_ALS_RANGE_323,   // 量程对应精度为 0.0049 lux/count.
};

3.1.4 读取接近感应

uint16_t ap3216c_read_ps_data(ap3216c_device_t dev)

通过 ap3216c 传感器读取接近感应测量值,返回 16 位接近感应值,具体参数与返回说明如下表

参数 描述
dev ap3216c 设备对象
返回 描述
!= 0 测量接近感应值
=0 测量物体不在传感器探测范围内

在读取接近感应过程中,计算出接近感应值,默认测量增益为 AP3216C_ALS_GAIN2。如需修改,请参照下文的设置参数 API 进行设置,可配置的增益列表如下

enum als_gain
{
    AP3216C_ALS_GAIN1, //一倍检测增益
    AP3216C_ALS_GAIN2, //二倍检测增益
    AP3216C_ALS_GAIN4, //四倍检测增益
    AP3216C_ALS_GAIN8, //八倍检测增益
};

3.1.5 设置参数

rt_err_t ap3216c_set_param(ap3216c_device_t dev, ap3216c_cmd_t cmd, rt_uint8_t value)

通过 ap3216c 传感器设置参数,具体参数与返回说明如下表

参数 描述
dev ap3216c 设备对象
cmd 将要设置参数的命令
value 将要设置命令的值
返回 描述
RT_EOK 设置参数成功
-RT_ERROR 设置参数错误

通过设置命令,设置不同的命令类型,如果设置与默认相同,则不需要重新设置,具体命令类型与默认如下所示

AP3216C_SYSTEM_MODE,          //系统配置(默认 : 0b000)
AP3216C_INT_PARAM,            //中断清除方式(默认 : 0b0)
AP3216C_ALS_RANGE,            //ALS 量程范围(默认 : 0b00)
AP3216C_ALS_PERSIST,          //ALS 中断过滤次数(默认 : 0b0000)
AP3216C_ALS_CALIBRATION,      //ALS 校准(默认 : 0x40)
AP3216C_ALS_LOW_THRESHOLD_L,  //ALS 最小阈值低位字节(默认 : 0x00)
AP3216C_ALS_LOW_THRESHOLD_H,  //ALS 最小阈值高位字节(默认 : 0x00)
AP3216C_ALS_HIGH_THRESHOLD_L, //ALS 最大阈值低位字节(默认 : 0xFF)
AP3216C_ALS_HIGH_THRESHOLD_H, //ALS 最大阈值高位字节(默认 : 0xFF)
AP3216C_PS_INTEGRATED_TIME,   //PS 或者 IR 转换时间(默认 : 0000)
AP3216C_PS_AGAIN,             //PS 检测增益 (默认 : 0b01)
AP3216C_PS_PERSIST,           //PS 中断过滤次数(默认 : 0b01)
AP3216C_PS_LED_CONTROL,       //IR LED 发送时间(默认 : 0b01)
AP3216C_PS_LED_DRIVER_RATIO,  //IR LED 驱动电流比率(默认 : 0b11)
AP3216C_PS_INT_MODE,          //PS 中断模式(默认 : 0x01)
AP3216C_PS_MEAN_TIME,         //PS 平均采集时间(默认 : 0x00)
AP3216C_PS_WAITING_TIME,      //PS 采集等待实际(默认 : 0x00)
AP3216C_PS_CALIBRATION_L,     //PS 校准阈值低位字节(默认 : 0x00)
AP3216C_PS_CALIBRATION_H,     //PS 校准阈值高位字节(默认 : 0x00)
AP3216C_PS_LOW_THRESHOLD_L,   //PS 最小阈值低位字节(默认 :0x00)
AP3216C_PS_LOW_THRESHOLD_H,   //PS 最小阈值高位字节(默认 :0x00)
AP3216C_PS_HIGH_THRESHOLD_L,  //PS 最大阈值低位字节(默认 :0xff)
AP3216C_PS_HIGH_THRESHOLD_H,  //PS 最大阈值高位字节(默认 :0xff)

例如 ,需要设置 ALS 量程为 AP3216C_ALS_RANGE_20661,使用命令如下

ap3216c_set_param(dev, AP3216C_ALS_RANGE, AP3216C_ALS_RANGE_20661);  //dev 为设备对象

3.1.6 获取参数

rt_err_t ap3216c_get_param(ap3216c_device_t dev, ap3216c_cmd_t cmd, rt_uint8_t *value)

通过 ap3216c 传感器获取设置参数,具体参数与返回说明如下表

参数 描述
dev ap3216c 设备对象
cmd 将要获取参数的命令
value 将要获取命令的参数
返回 描述
RT_EOK 获取参数成功
-RT_ERROR 获取参数错误

3.1.7 设置 als 硬件中断回调函数

void ap3216c_int_als_cb(ap3216c_device_t dev, rt_bool_t enabled, ap3216c_threshold_t threshold, ap3216c_int_cb int_cb)

该功能为可选功能,支持使用硬件中断功能,配置相应的中断阈值与中断噪音过滤次数,具体参数与返回说明如下表

参数 描述
dev ap3216c 设备对象
enabled 是否使能注册中断回调
threshold 中断阈值与过滤次数
int_cb 中断回调函数

表中 threshold 为中断阈值与中断噪音过滤次数结构体,内容如下

struct ap3216c_threshold
{
    rt_uint16_t min;        /* als 16 bits, ps 10 bits available(0-1 bit and 8-15 bit ) */
    rt_uint16_t max;        /* als 16 bits, ps 10 bits available(0-1 bit and 8-15 bit ) */
    rt_uint8_t noises_time; /* filter special noises trigger interrupt */
}
  • 注:
  • 最大阈值与最小阈值在 als 中是16位,在 pa 中只有 10 位有效。

表中 int_cb 为用户自定义函数,函数结构如下

typedef void (*ap3216c_int_cb)(void *args)

3.1.8 设置 ps 硬件中断回调函数

void ap3216c_int_ps_cb(ap3216c_device_t dev, rt_bool_t enabled, ap3216c_threshold_t threshold, ap3216c_int_cb int_cb)

同设置 als 硬件中断回调函数功能一样,为可选功能,支持使用硬件中断功能,配置相应的中断阈值与中断噪音过滤次数,具体参数与返回说明如下表

参数 描述
dev ap3216c 设备对象
enabled 是否使能注册中断回调
threshold 中断阈值与过滤次数
int_cb 中断回调函数

3.2 Finsh/MSH 测试命令

ap3216c 软件包提供了丰富的测试命令,项目只要在 RT-Thread 上开启 Finsh/MSH 功能即可。在做一些基于 ap3216c 的应用开发、调试时,这些命令会非常实用,它可以准确的读取指传感器测量的光照强度与接近感应。具体功能可以输入 ap3216c ,可以查看完整的命令列表

msh />ap3216c
Usage:
ap3216c probe <dev_name>   - probe sensor by given name
ap3216c read               - read sensor ap3216c data
msh />

3.2.1 在指定的 i2c 总线上探测传感器

当第一次使用 ap3216c 命令时,直接输入 ap3216c probe <dev_name> ,其中 <dev_name> 为指定的 i2c 总线,例如:i2c1。如果有这个传感器,就不会提示错误;如果总线上没有这个传感器,将会显示提示找不到相关设备,日志如下:

msh />ap3216c probe i2c1      #探测成功,没有错误日志
msh />
msh />ap3216c probe i2c88     #探测失败,提示对应的 I2C 设备找不到
[E/ap3216c] can't find ap3216c device on 'i2c88'
msh />

3.2.2 读取数据

探测成功之后,输入 ap3216c read 即可获取光照强度与接近感应检测值,包括提示信息,日志如下:

msh />ap3216c read            #接近没有探测到物体
object is not proximity of sensor
ap3216c measure current brightness: 25.9 (lux)  
msh /> 
msh />ap3216c read            #接近有物体
ap3216c read current ps data      : 219
ap3216c measure current brightness: 1.0(lux) 
msh /> 

4 注意事项

暂无。

5 联系方式

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

AP3216C 软件包提供了使用接近感应(ps)与光照强度(als)传感器 ap3216c 基本功能 展开 收起
C
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C
1
https://gitee.com/rt-thread_-yoc/ap3216c.git
git@gitee.com:rt-thread_-yoc/ap3216c.git
rt-thread_-yoc
ap3216c
ap3216c
master

搜索帮助