Skip to content

Commit b090fa0

Browse files
arminkarmink
committed
【增加】07/08/09 例程遗漏的 package
Signed-off-by: armink <[email protected]>
1 parent db10ae8 commit b090fa0

File tree

24 files changed

+3642
-3
lines changed

24 files changed

+3642
-3
lines changed

‎examples/07_driver_temp_humi/.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
build
1414
Debug
1515
documentation/html
16-
packages/
1716
*~
1817
*.o
1918
*.obj

‎examples/07_driver_temp_humi/packages/SConscript‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import os
2+
from building import *
3+
4+
objs = []
5+
cwd = GetCurrentDir()
6+
list = os.listdir(cwd)
7+
8+
for item in list:
9+
if os.path.isfile(os.path.join(cwd, item, 'SConscript')):
10+
objs = objs + SConscript(os.path.join(item, 'SConscript'))
11+
12+
Return('objs')

‎examples/07_driver_temp_humi/packages/aht10-v1.0.0/LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
202+

‎examples/07_driver_temp_humi/packages/aht10-v1.0.0/README.md‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
# AHT10 软件包
2+
3+
## 1 介绍
4+
5+
AHT10 软件包提供了使用温度与湿度传感器 `aht10` 基本功能，并且提供了软件平均数滤波器可选功能。本文介绍该软件包的基本功能，以及 `Finsh/MSH` 测试命令等。
6+
7+
基本功能主要由传感器 `aht10` 决定：在输入电压为 `1.8v-3.3v` 范围内，测量温度与湿度的量程、精度如下表所示
8+
9+
| 功能 | 量程 | 精度 |
10+
| ---- | ---- | ---- |
11+
| 温度 | `-40℃ - 85℃` |`±0.5℃`|
12+
| 湿度 | `0% - 100%` |`±3%`|
13+
14+
### 1.1 目录结构
15+
16+
| 名称 | 说明 |
17+
| ---- | ---- |
18+
| aht10.h | 传感器使用头文件 |
19+
| aht10.c | 传感器使用源代码 |
20+
| SConscript | RT-Thread 默认的构建脚本 |
21+
| README.md | 软件包使用说明 |
22+
| aht10_datasheet.pdf | 官方数据手册 |
23+
24+
### 1.2 许可证
25+
26+
AHT10 软件包遵循 Apache-2.0 许可，详见 LICENSE 文件。
27+
28+
### 1.3 依赖
29+
30+
依赖 `RT-Thread I2C` 设备驱动框架。
31+
32+
## 2 获取软件包
33+
34+
使用 `aht10` 软件包需要在 RT-Thread 的包管理器中选择它，具体路径如下：
35+
36+
```
37+
RT-Thread online packages
38+
peripheral libraries and drivers --->
39+
[*] aht10: digital humidity and temperature sensor aht10 driver library --->
40+
[*] Enable support filter function
41+
Version (latest) --->
42+
```
43+
44+
45+
每个功能的配置说明如下：
46+
47+
- `aht10: digital humidity and temperature sensor aht10 driver library`：选择使用 `aht10` 软件包；
48+
- `Enable support filter function`：开启采集温湿度软件平均数滤波器功能；
49+
- `Version`：配置软件包版本，默认最新版本。
50+
51+
然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。
52+
53+
## 3 使用 aht10 软件包
54+
55+
按照前文介绍，获取 `aht10` 软件包后，就可以按照 下文提供的 API 使用传感器 `aht10` 与 `Finsh/MSH` 命令进行测试，详细内容如下。
56+
57+
### 3.1 API
58+
59+
#### 3.1.1 初始化
60+
61+
`aht10_device_t aht10_init(const char *i2c_bus_name)`
62+
63+
根据总线名称，自动初始化对应的 AHT10 设备，具体参数与返回说明如下表
64+
65+
| 参数 | 描述 |
66+
| :----- | :----------------------- |
67+
| name | i2c 设备名称 |
68+
| **返回** | **描述** |
69+
| != NULL | 将返回 aht10 设备对象 |
70+
| = NULL | 查找失败 |
71+
72+
#### 3.1.2 反初始化
73+
74+
void aht10_deinit(aht10_device_t dev)
75+
76+
如果设备不再使用，反初始化将回收 aht10 设备的相关资源，具体参数说明如下表
77+
78+
| 参数 | 描述 |
79+
| :--- | :------------- |
80+
| dev | aht10 设备对象 |
81+
82+
#### 3.1.3 读取温度
83+
84+
float aht10_read_temperature(aht10_device_t dev)
85+
86+
通过 `aht10` 传感器读取温度测量值，返回浮点型温度值，具体参数与返回说明如下表
87+
88+
| 参数 | 描述 |
89+
| :------- | :------------- |
90+
| dev | aht10 设备对象 |
91+
| **返回** | **描述** |
92+
| != 0.0 | 测量温度值 |
93+
| =0.0 | 测量失败 |
94+
95+
#### 3.1.4 读取湿度
96+
97+
float aht10_read_humidity(aht10_device_t dev)
98+
99+
通过 `aht10` 传感器读取湿度测量值，返回浮点型湿度值，具体参数与返回说明如下表
100+
101+
| 参数 | 描述 |
102+
| :------- | :------------ |
103+
| dev | aht10设备对象 |
104+
| **返回** | **描述** |
105+
| != 0.0 | 测量湿度值 |
106+
| =0.0 | 测量失败 |
107+
108+
### 3.2 Finsh/MSH 测试命令
109+
110+
aht10 软件包提供了丰富的测试命令，项目只要在 RT-Thread 上开启 Finsh/MSH 功能即可。在做一些基于 `aht10` 的应用开发、调试时，这些命令会非常实用，它可以准确的读取指传感器测量的温度与湿度。具体功能可以输入 `aht10` ，可以查看完整的命令列表
111+
112+
```
113+
msh />aht10
114+
Usage:
115+
aht10 probe <dev_name> - probe sensor by given name
116+
aht10 read - read sensor aht10 data
117+
msh />
118+
```
119+
120+
#### 3.2.1 在指定的 i2c 总线上探测传感器
121+
122+
当第一次使用 `aht10` 命令时，直接输入 `aht10 probe <dev_name>` ，其中 `<dev_name>` 为指定的 i2c 总线，例如：i2c0。如果有这个传感器，就不会提示错误；如果总线上没有这个传感器，将会显示提示找不到相关设备，日志如下：
123+
124+
```
125+
msh />aht10 probe i2c1 #探测成功，没有错误日志
126+
msh />
127+
msh />aht10 probe i2c88 #探测失败，提示对应的 I2C 设备找不到
128+
[E/aht10] can't find aht10 device on 'i2c88'
129+
msh />
130+
```
131+
132+
#### 3.2.2 读取数据
133+
134+
探测成功之后，输入 `aht10 read` 即可获取温度与湿度，包括提示信息，日志如下：
135+
136+
```
137+
msh />aht10 read
138+
read aht10 sensor humidity : 54.7 %
139+
read aht10 sensor temperature: 27.3
140+
msh />
141+
```
142+
143+
## 4 注意事项
144+
145+
暂无。
146+
147+
## 5 联系方式
148+
149+
* 维护：[Ernest](https://github.com/ErnestChen1)
150+
* 主页：https://github.com/RT-Thread-packages/aht10
151+

‎examples/07_driver_temp_humi/packages/aht10-v1.0.0/SConscript‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
2+
from building import *
3+
4+
cwd = GetCurrentDir()
5+
src = Glob('*.c') + Glob('*.cpp')
6+
path = [cwd]
7+
8+
group = DefineGroup('aht10', src, depend = ['PKG_USING_AHT10'], CPPPATH = path)
9+
10+
Return('group')

0 commit comments

Comments
 (0)