Skip to content

Commit 08e53b0

Browse files
arminkarmink
authored
Merge pull request #21 from yangjie11/EN
【增加】增加英文 readme
2 parents b099a84 + b8a6477 commit 08e53b0

File tree

2 files changed

+96
-35
lines changed

2 files changed

+96
-35
lines changed

‎README.md

+37-35
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,59 @@
11
# rw007
22

3-
## 1. 简介
3+
[中文页](README_ZH.md) | English
44

5-
**RW007**是由上海睿赛德电子科技有限公司开发基于Cortex-M4 WIFI SOC的SPI/UART 高速wifi模块。该仓库为**rw007**的SPI驱动
5+
## 1. Introduction
66

7-
**RW007**硬件设计简单，SPI模式下用户只需要预留1组SPI信号，一个中断输入，一个IO输出即可，包含电源和地总共8个引脚。
7+
**RW007** is a SPI/UART high-speed wifi module based on Cortex-M4 WIFI SOC developed by Shanghai Ruiside Electronic Technology Co., Ltd. The warehouse is the SPI driver of **rw007**
88

9-
### 1.1. 文件结构
9+
**RW007** The hardware design is simple. In SPI mode, users only need to reserve 1 set of SPI signals, one interrupt input, and one IO output, including a total of 8 pins for power and ground.
1010

11-
| 文件夹 | 说明 |
11+
### 1.1. File structure
12+
13+
| Folder | Description |
1214
| ---- | ---- |
13-
| src | 核心驱动源码，主要实现通信逻辑 |
14-
| inc | 头文件目录 |
15-
| example | 平台移植示例 |
15+
| src | Core driver source code, which mainly implements communication logic |
16+
| inc | Header file directory |
17+
| example | Platform porting example |
1618

17-
### 1.2 许可证
19+
### 1.2 License
1820

19-
at_device package 遵循 Apache 2.0 许可，详见 `LICENSE` 文件。
21+
The at_device package complies with the Apache 2.0 license, see the `LICENSE` file for details.
2022

21-
### 1.3 依赖
23+
### 1.3 Dependency
2224

2325
- RT-Thread 3.0+
24-
- RT-Thread LWIP 组件
25-
- RT-Thread SPI 驱动框架
26-
- RT-Thread PIN 驱动框架(示例平台代码依赖)
26+
- RT-Thread LWIP component
27+
- RT-Thread SPI driver framework
28+
- RT-Thread PIN driver framework (sample platform code dependency)
2729

28-
### 1.4 配置宏说明
30+
### 1.4 Configuration Macro Description
2931

30-
自动配置时相关配置宏将在env中被配置 手动配置参考如下
32+
The relevant configuration macros will be configured in env during automatic configuration. The manual configuration is as follows
3133

32-
类型说明
34+
Type description
3335

34-
- bool: 定义生效 未定义 不生效
35-
- string: 字符串
36-
- int: 数值
36+
- bool: definition is valid, undefined, not valid
37+
- string: string
38+
- int: number
3739

38-
|宏|类型|功能|
40+
|Macro|Type|Function|
3941
|--|--|--|
40-
|PKG_USING_RW007|bool|开启rw007驱动，使用该软件包则需要定义该宏|
41-
|RW007_USING_STM32_DRIVERS|bool|使能STM32平台移植示例|
42-
|RW007_USING_IMXRT_DRIVERS|bool|使能IMXRT平台移植示例|
43-
|RW007_SPI_BUS_NAME|string|example中使用的SPI总线设备名称|
44-
|RW007_CS_PIN|int|example中使用的SPI 片选引脚在pin驱动中的序号|
45-
|RW007_BOOT0_PIN|int|example中使用的BOOT0引脚在pin驱动中的序号(与SPI的CLK是同一引脚复用)|
46-
|RW007_BOOT1_PIN|int|example中使用的BOOT1引脚在pin驱动中的序号(与SPI的CS是同一引脚复用)|
47-
|RW007_INT_BUSY_PIN|int|example中使用的INT/BUSY引脚在pin驱动中的序号|
48-
|RW007_RST_PIN|int|example中使用的RST引脚在pin驱动中的序号|
42+
|PKG_USING_RW007|bool|Enable rw007 driver, use this software package, you need to define this macro|
43+
|RW007_USING_STM32_DRIVERS|bool|Enable STM32 platform migration example|
44+
|RW007_USING_IMXRT_DRIVERS|bool|Enable IMXRT platform migration example|
45+
|RW007_SPI_BUS_NAME|string|The SPI bus device name used in example|
46+
|RW007_CS_PIN|int|The serial number of the SPI chip select pin used in the example in the pin driver|
47+
|RW007_BOOT0_PIN|int|The serial number of the BOOT0 pin used in the example in the pin driver (the same pin is multiplexed with the CLK of SPI)|
48+
|RW007_BOOT1_PIN|int|The serial number of the BOOT1 pin used in the example in the pin driver (the same pin is multiplexed with the CS of SPI)|
49+
|RW007_INT_BUSY_PIN|int|The serial number of the INT/BUSY pin used in the example in the pin driver|
50+
|RW007_RST_PIN|int|The serial number of the RST pin used in the example in the pin driver|
4951

50-
## 2. 注意事项
52+
## 2. Matters needing attention
5153

52-
由于存在引脚复用情况，所以bsp的SPI的驱动需要引脚配置在Config时进行。
54+
Because of the pin multiplexing situation, the driver of the bsp SPI needs to be configured during Config.
5355

54-
## 4. 联系方式
56+
## 4. Contact
5557

56-
- 维护：RT-Thread 开发团队
57-
- 主页：https://github.com/RT-Thread-packages/rw007
58+
- Maintenance: RT-Thread development team
59+
- Homepage: https://github.com/RT-Thread-packages/rw007

‎README_ZH.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# rw007
2+
3+
中文页 | [English](README.md)
4+
5+
## 1. 简介
6+
7+
**RW007**是由上海睿赛德电子科技有限公司开发基于Cortex-M4 WIFI SOC的SPI/UART 高速wifi模块。该仓库为**rw007**的SPI驱动
8+
9+
**RW007**硬件设计简单，SPI模式下用户只需要预留1组SPI信号，一个中断输入，一个IO输出即可，包含电源和地总共8个引脚。
10+
11+
### 1.1. 文件结构
12+
13+
| 文件夹 | 说明 |
14+
| ---- | ---- |
15+
| src | 核心驱动源码，主要实现通信逻辑 |
16+
| inc | 头文件目录 |
17+
| example | 平台移植示例 |
18+
19+
### 1.2 许可证
20+
21+
at_device package 遵循 Apache 2.0 许可，详见 `LICENSE` 文件。
22+
23+
### 1.3 依赖
24+
25+
- RT-Thread 3.0+
26+
- RT-Thread LWIP 组件
27+
- RT-Thread SPI 驱动框架
28+
- RT-Thread PIN 驱动框架(示例平台代码依赖)
29+
30+
### 1.4 配置宏说明
31+
32+
自动配置时相关配置宏将在env中被配置 手动配置参考如下
33+
34+
类型说明
35+
36+
- bool: 定义生效 未定义 不生效
37+
- string: 字符串
38+
- int: 数值
39+
40+
|宏|类型|功能|
41+
|--|--|--|
42+
|PKG_USING_RW007|bool|开启rw007驱动，使用该软件包则需要定义该宏|
43+
|RW007_USING_STM32_DRIVERS|bool|使能STM32平台移植示例|
44+
|RW007_USING_IMXRT_DRIVERS|bool|使能IMXRT平台移植示例|
45+
|RW007_SPI_BUS_NAME|string|example中使用的SPI总线设备名称|
46+
|RW007_CS_PIN|int|example中使用的SPI 片选引脚在pin驱动中的序号|
47+
|RW007_BOOT0_PIN|int|example中使用的BOOT0引脚在pin驱动中的序号(与SPI的CLK是同一引脚复用)|
48+
|RW007_BOOT1_PIN|int|example中使用的BOOT1引脚在pin驱动中的序号(与SPI的CS是同一引脚复用)|
49+
|RW007_INT_BUSY_PIN|int|example中使用的INT/BUSY引脚在pin驱动中的序号|
50+
|RW007_RST_PIN|int|example中使用的RST引脚在pin驱动中的序号|
51+
52+
## 2. 注意事项
53+
54+
由于存在引脚复用情况，所以bsp的SPI的驱动需要引脚配置在Config时进行。
55+
56+
## 4. 联系方式
57+
58+
- 维护：RT-Thread 开发团队
59+
- 主页：https://github.com/RT-Thread-packages/rw007

0 commit comments

Comments
 (0)