Skip to content

Commit 9631c85

Browse files
PeterJhonRbb666
authored andcommitted
update README
1 parent 1c3e45b commit 9631c85

File tree

103 files changed

+1817
-520
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+1817
-520
lines changed

projects/Edgi-Talk_ADC/Edgi_Talk_M33_ADC/README.md

Lines changed: 66 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,85 @@
11
# Edgi-Talk_ADC Example Project
22

3+
[**中文**](./README_zh.md) | **English**
4+
35
## Introduction
46

5-
This example project is based on the **Edgi-Talk platform** and runs on the **RT-Thread real-time operating system**.
6-
It demonstrates how to use the **ADC (Analog-to-Digital Converter)**.
7-
Through this project, users can quickly experience ADC data acquisition and processing functions, providing a reference for developing analog signal acquisition applications.
8-
During operation, the blue indicator LED blinks periodically, indicating that the system has started and is running normally.
7+
This example project is based on the **Edgi-Talk platform**, running on the **RT-Thread real-time operating system**, and demonstrates how to use the **ADC (Analog-to-Digital Converter)**.
8+
Through this project, users can quickly experience ADC data acquisition and processing, providing a reference for developing analog signal acquisition applications.
9+
During runtime, the blue indicator LED blinks periodically, indicating that the system has started and is running properly.
10+
11+
### 1. Overview of ADC
12+
13+
**ADC (Analog-to-Digital Converter)** is a device or module that converts continuous analog signals into discrete digital signals, serving as a core component in modern digital control, signal processing, and measurement systems.
14+
15+
* **Function**: Converts continuous signals such as voltage or current into digital values for processing by a microcontroller (MCU), DSP, or FPGA.
16+
* **Key Specifications**:
17+
18+
* **Resolution**: The number of bits in the ADC output, representing the number of distinguishable levels. Edgi uses **12-bit** resolution, i.e., 2^12 = 4096 levels.
19+
* **Sampling Rate**: The number of samples the ADC takes per second, determining the range of detectable signal frequencies.
20+
* **Input Range**: The range of analog voltages the ADC can handle.
21+
* **Accuracy**: Indicates how closely the ADC output matches the actual input signal, affected by noise, nonlinearity, and offset errors.
22+
23+
### 2. ADC Working Principle
24+
25+
ADC operation typically involves the following stages:
26+
27+
1. **Sampling and Holding (Sample & Hold, S/H)**
28+
29+
* Captures the analog signal at a specific moment and holds it steady to ensure stability during conversion.
30+
2. **Quantization**
31+
32+
* Divides the analog signal into discrete levels, each corresponding to a digital code.
33+
* A 12-bit ADC divides the input voltage range into 4096 levels, with quantization precision expressed as ΔV = VREF / 4096.
34+
3. **Encoding**
35+
36+
* Converts the quantized level into binary code for output.
37+
38+
## Hardware Description
39+
40+
### Connection Interface
41+
42+
![alt text](figures/1.png)
43+
44+
### BTB Connector
45+
46+
![alt text](figures/2.png)
47+
48+
### MCU Pins
49+
50+
![alt text](figures/3.png)
51+
52+
### Physical Board Location
53+
54+
![alt text](figures/4.png)
955

1056
## Software Description
1157

1258
* The project is developed based on the **Edgi-Talk** platform.
1359

14-
* It uses **RT-Thread** as the operating system kernel.
60+
* Uses **RT-Thread** as the operating system kernel.
1561

1662
* Example features:
1763

1864
* ADC initialization and sampling
1965
* LED indicator blinking
20-
* ADC sampling results printed through the serial port
66+
* ADC sampling results printed via serial port
2167

22-
* The project structure is clear, making it easy for users to understand the ADC driver and RT-Thread thread mechanism.
68+
* The project has a clear structure, making it easy for users to understand the ADC driver and RT-Thread threading mechanism.
2369

2470
## Usage Instructions
2571

2672
### Compilation and Download
2773

28-
1. Open the project and complete the build process.
29-
2. Connect the development board to the PC using the **onboard DAP downloader** via USB.
30-
3. Use the programming tool to flash the generated firmware onto the development board.
74+
1. Open the project and complete the compilation.
75+
2. Connect the board’s USB port to the PC using the **onboard debugger (DAP)**.
76+
3. Use the programming tool to flash the generated firmware onto the board.
3177

32-
### Running Results
78+
### Runtime Behavior
3379

34-
* After flashing, power on the development board to run the example project.
35-
* The **blue indicator LED** blinks every 500ms, indicating normal system scheduling.
36-
* The ADC sampling results of the battery voltage will be printed through the serial port, as shown below:
80+
* After flashing, power on the board to run the example.
81+
* The **blue indicator LED** blinks every 500 ms, indicating normal system operation.
82+
* ADC samples battery voltage and prints results to the serial port as shown below:
3783

3884
```
3985
Value is: 3.123 V
@@ -43,22 +89,22 @@ During operation, the blue indicator LED blinks periodically, indicating that th
4389

4490
## Notes
4591

46-
* To modify the project’s **graphical configuration**, open the configuration file with the following tool:
92+
* To modify the **graphical configuration** of the project, open the configuration file using the following tool:
4793

4894
```
4995
tools/device-configurator/device-configurator.exe
5096
libs/TARGET_APP_KIT_PSE84_EVAL_EPC2/config/design.modus
5197
```
5298
* After making changes, save the configuration and regenerate the code.
5399

54-
## Boot Process
100+
## Boot Sequence
55101

56102
The system boot sequence is as follows:
57103

58104
```
59105
+------------------+
60106
| Secure M33 |
61-
| (Secure Core) |
107+
| (Secure Core) |
62108
+------------------+
63109
|
64110
v
@@ -74,12 +120,12 @@ The system boot sequence is as follows:
74120
+-------------------+
75121
```
76122

77-
⚠️ Please strictly follow the above flashing sequence; otherwise, the system may fail to run properly.
123+
⚠️ Please strictly follow the boot sequence above when flashing firmware, or the system may fail to start properly.
78124

79125
---
80126

81-
* If the example project does not run properly, it is recommended to first build and flash the **Edgi-Talk_M33_S_Template** project to ensure that the initialization and core startup process works correctly before running this example.
82-
* To enable the M55 core, open the configuration in the **M33 project**:
127+
* If the example project does not run correctly, compile and flash the **Edgi-Talk_M33_S_Template** project first to ensure proper initialization and core startup sequence before running this example.
128+
* To enable the M55 core, configure the **M33 project** as follows:
83129

84130
```
85131
RT-Thread Settings --> Hardware --> select SOC Multi Core Mode --> Enable CM55 Core

projects/Edgi-Talk_ADC/Edgi_Talk_M33_ADC/README_zh.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,44 @@
11
# Edgi-Talk_ADC 示例工程
22

3+
**中文** | [**English**](./README.md)
4+
35
## 简介
46

57
本示例工程基于 **Edgi-Talk 平台**,运行于 **RT-Thread 实时操作系统**,用于演示 **ADC(模数转换器)** 的使用方法。
68
通过本工程,用户可以快速体验 ADC 数据采集与处理功能,为后续开发模拟信号采集应用提供参考。
79
运行时,蓝色指示灯周期性闪烁,表示系统已正常启动并运行。
810

11+
### 1. ADC概述
12+
13+
**ADC(Analog-to-Digital Converter)** 是将连续的模拟信号转换为离散的数字信号的器件或模块,是现代数字控制系统、信号处理和测量系统中的核心部件。
14+
15+
- **功能**:把电压、电流等连续信号转换为数字值,以便微控制器(MCU)、DSP 或 FPGA 进行处理。
16+
- **重要指标**
17+
- **分辨率(Resolution)**:ADC输出的数字位数,表示可区分的电平数。Edgi为 **12位**,即 2^12 = 4096 个不同电平。
18+
- **采样率(Sampling Rate)**:ADC每秒采样次数,影响可捕捉的信号频率范围。
19+
- **输入范围(Input Range)**:ADC能处理的模拟电压范围。
20+
- **精度(Accuracy)**:表示ADC输出与实际输入信号的接近程度,受噪声、非线性、偏移误差影响。
21+
22+
### 2. ADC工作原理
23+
24+
ADC通常分为几个阶段:
25+
26+
1. **采样与保持(Sample & Hold, S/H)**
27+
- 将连续变化的模拟信号在采样瞬间固定,保证后续转换过程中信号不变。
28+
2. **量化(Quantization)**
29+
- 将模拟信号划分为离散电平,每个电平对应一个数字编码。
30+
- 12位ADC将输入电压范围分为 4096 个电平,量化精度可以表示为:ΔV = VREF / 4096。
31+
3. **编码(Encoding)**
32+
- 将量化后的电平转换成二进制代码输出。
33+
## 硬件说明
34+
### 连接接口
35+
![alt text](figures/1.png)
36+
### BTB座子
37+
![alt text](figures/2.png)
38+
### MCU引脚
39+
![alt text](figures/3.png)
40+
### 实物图位置
41+
![alt text](figures/4.png)
942
## 软件说明
1043

1144
* 工程基于 **Edgi-Talk** 平台开发。
49.8 KB
Loading
33.6 KB
Loading
154 KB
Loading
704 KB
Loading

projects/Edgi-Talk_AHT20/Edgi_Talk_M33_AHT20/README.md

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,64 @@
11
# Edgi-Talk_M33_AHT20 Example Project
22

3+
[**中文**](./README_zh.md) | **English**
4+
35
## Introduction
46

57
This example project is based on the **Edgi-Talk platform** and demonstrates how to drive and use the **AHT20 temperature and humidity sensor**.
6-
Through this project, users can quickly experience AHT20 data acquisition and processing, and view the sampled results via the serial terminal on the development board.
8+
Through this project, users can quickly experience AHT20 data acquisition and processing, and view the sampled results via the serial port on the development board.
9+
10+
### AHT10 Software Package Overview
11+
12+
The AHT10 software package provides basic functions for using the AHT10 temperature and humidity sensor, and also includes an optional software-based moving average filter.
13+
For more details, please refer to the README file in the AHT10 software package.
14+
15+
## Hardware Description
16+
17+
### Sensor Connection Interface
18+
19+
![alt text](figures/1.png)
20+
21+
### Level Shifting
22+
23+
![alt text](figures/2.png)
24+
25+
### BTB Connector
26+
27+
![alt text](figures/3.png)
28+
29+
### MCU Pins
30+
31+
![alt text](figures/4.png)
32+
33+
### Physical Board Location
34+
35+
![alt text](figures/5.png)
736

837
## Software Description
938

1039
* The project is developed based on the **Edgi-Talk** platform.
1140

12-
* The example includes the following features:
41+
* Example functionalities include:
1342

1443
* AHT20 initialization and communication via I²C
15-
* Temperature and humidity data reading and parsing
16-
* Serial printing of sampled data
44+
* Temperature and humidity data acquisition and parsing
45+
* Displaying sampled data via serial output
1746

18-
* The project structure is clear, making it easy for users to understand I²C driver implementation and sensor interfacing.
47+
* The project has a clear structure, helping users understand I²C driver usage and sensor interfacing.
1948

2049
## Usage Instructions
2150

2251
### Compilation and Download
2352

24-
1. Open the project and complete the build process.
25-
2. Connect the development board to the PC via the **onboard DAP downloader (USB interface)**.
26-
3. Use a programming tool to flash the generated firmware onto the development board.
53+
1. Open the project and complete the compilation.
54+
2. Connect the board’s USB port to the PC using the **onboard debugger (DAP)**.
55+
3. Use the programming tool to flash the generated firmware onto the development board.
2756

28-
### Running Results
57+
### Runtime Behavior
2958

30-
* After flashing, power on the development board to run the example project.
31-
* The system will initialize the AHT20 and start sampling temperature and humidity data.
32-
* The sampling results will be printed through the serial terminal, as shown below:
59+
* After flashing, power on the board to run the example project.
60+
* The system will initialize the AHT20 sensor and begin sampling temperature and humidity data.
61+
* The sampled data will be printed via the serial terminal, as shown below:
3362

3463
```
3564
\ | /
@@ -47,23 +76,23 @@ msh >[I/aht10] AHT10 has been initialized!
4776

4877
## Notes
4978

50-
* To modify the project’s **graphical configuration**, open the configuration file using the following tool:
79+
* To modify the **graphical configuration** of the project, open the configuration file using the following tool:
5180

5281
```
5382
tools/device-configurator/device-configurator.exe
5483
libs/TARGET_APP_KIT_PSE84_EVAL_EPC2/config/design.modus
5584
```
5685

57-
* After making changes, save the configuration and regenerate the code.
86+
* After editing, save the configuration and regenerate the code.
5887

59-
## Boot Process
88+
## Boot Sequence
6089

6190
The system boot sequence is as follows:
6291

6392
```
6493
+------------------+
6594
| Secure M33 |
66-
| (Secure Core) |
95+
| (Secure Core) |
6796
+------------------+
6897
|
6998
v
@@ -79,12 +108,12 @@ The system boot sequence is as follows:
79108
+-------------------+
80109
```
81110

82-
⚠️ Please strictly follow the above flashing sequence; otherwise, the system may fail to run properly.
111+
⚠️ Please strictly follow the boot sequence above when flashing firmware; otherwise, the system may fail to start properly.
83112

84113
---
85114

86-
* If the example project does not run properly, it is recommended to first build and flash the **Edgi-Talk_M33_S_Template** project to ensure the initialization and core startup process works correctly before running this example.
87-
* To enable the M55 core, open the configuration in the **M33 project**:
115+
* If the example project does not run correctly, compile and flash the **Edgi-Talk_M33_S_Template** project first to ensure proper initialization and core startup sequence before running this example.
116+
* To enable the M55 core, configure the **M33 project** as follows:
88117

89118
```
90119
RT-Thread Settings --> Hardware --> select SOC Multi Core Mode --> Enable CM55 Core

projects/Edgi-Talk_AHT20/Edgi_Talk_M33_AHT20/README_zh.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,26 @@
11
# Edgi-Talk_M33_AHT20 示例工程
22

3+
**中文** | [**English**](./README.md)
4+
35
## 简介
46

57
本示例工程基于 **Edgi-Talk平台**,演示 **AHT20 温湿度传感器** 的驱动和使用方法。
68
通过本工程,用户可以快速体验 AHT20 的数据采集与处理,并在开发板上通过串口查看采样结果。
79

10+
### AHT10 软件包简介
11+
AHT10 软件包提供了使用温度与湿度传感器 aht10 基本功能,并且提供了软件平均数滤波器可选功能,如需详细了解该软件包,请参考 AHT10 软件包中的 README。
12+
13+
## 硬件说明
14+
### 传感器连接接口
15+
![alt text](figures/1.png)
16+
### 电平转换
17+
![alt text](figures/2.png)
18+
### BTB座子
19+
![alt text](figures/3.png)
20+
### MCU引脚
21+
![alt text](figures/4.png)
22+
### 实物图位置
23+
![alt text](figures/5.png)
824
## 软件说明
925

1026
* 工程基于 **Edgi-Talk** 平台开发。
38.8 KB
Loading
63.2 KB
Loading

0 commit comments

Comments
 (0)