Skip to content
This repository was archived by the owner on May 22, 2025. It is now read-only.

Commit 890e0da

Browse files
committed
update English version README file
1 parent 803226a commit 890e0da

File tree

2 files changed

+98
-33
lines changed

2 files changed

+98
-33
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,63 @@
11
# UV-Master
22

3-
本项目是基于嵌入式系统的高模块化、高移植性的水下机器人控制程序,采用抽象层分离逻辑与硬件,兼容多种控制平台。
3+
English | [简体中文](README_CN.md)
44

5-
## 一、功能
5+
This project is a highly modular and portable underwater robot control program based on embedded systems. It separates logic from hardware using an abstraction layer, is compatible with multiple control platforms, and has been successfully tested on hardware platforms based on Allwinner H3 and WCH CH32V307.
66

7-
1. 远程控制机器人
8-
2. 算法提供定向、定深功能
9-
3. 收集传感器数据
10-
4. 可选外设(灯、机械臂、声纳等)
11-
5. 网络OTA
7+
## I. Features
128

13-
## 二、项目结构
9+
1. Remote control of the robot
10+
2. Algorithms providing directional and depth control
11+
3. Sensor data collection
12+
4. Optional peripherals (lights, manipulator arms, sonar, etc.)
13+
5. Network OTA (Over-The-Air) updates
1414

15-
<img src="./doc/diagram.png" alt="控制程序" style="zoom: 67%;" />
15+
## II. Project Structure
1616

17-
### 通信抽象层(CAL
17+
### Communication Abstraction Layer (CAL)
1818

19-
目前仅有 HTTP 服务端搭配 JsonRPC 协议一种方案。
19+
Currently, only one solution is available, which involves an HTTP server coupled with the JsonRPC protocol.
2020

21-
#### 接口
21+
#### Interfaces
2222

23-
tcp_server.c
23+
- tcp_server.c
2424

25-
#### 驱动
25+
#### Drivers
2626

27-
rpc_cjson.c
27+
- rpc_cjson.c
2828

29-
#### 应用
29+
#### Applications
3030

31-
uvm_cal.c
31+
- uvm_cal.c
3232

33-
### 硬件抽象层(HAL
33+
### Hardware Abstraction Layer (HAL)
3434

35-
目前接口部分仅有 Linux 系统相关硬件驱动。
35+
The interface part currently includes hardware drivers specific to Linux systems.
3636

37-
#### 接口
37+
#### Interfaces
3838

39-
interface_xxx.c(内容为 utils 内各接口函数调用)
39+
- interface_xxx.c (contains calls to various utility interface functions)
4040

41-
#### 驱动
41+
#### Drivers
4242

43-
driver_xxx.c
43+
- driver_xxx.c
4444

45-
#### 应用
45+
#### Applications
4646

47-
xxx.c
47+
- xxx.c
4848

49-
### 配置管理器(CFG
49+
### Configuration Manager (CFG)
5050

51-
目前仅有基于 Linux 文件系统下的配置管理。
51+
Currently, configuration management is based on the Linux file system.
5252

53-
#### 接口
53+
#### Interfaces
5454

55-
uvm_cfg_intf.c
55+
- uvm_cfg_intf.c
5656

57-
#### 驱动
57+
#### Drivers
5858

59-
cfg_xxx.c
59+
- cfg_xxx.c
6060

61-
#### 应用
61+
#### Applications
6262

63-
uvm_cfg.c
63+
- uvm_cfg.c

README_CN.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# UV-Master
2+
3+
[English](README.md) | 简体中文
4+
5+
本项目是基于嵌入式系统的高模块化、高移植性的水下机器人控制程序,采用抽象层分离逻辑与硬件,兼容多种控制平台,并已在基于 Allwinner H3 和 WCH CH32V307 的硬件平台中测试成功。
6+
7+
## 一、功能
8+
9+
1. 远程控制机器人
10+
2. 算法提供定向、定深功能
11+
3. 收集传感器数据
12+
4. 可选外设(灯、机械臂、声纳等)
13+
5. 网络OTA
14+
15+
## 二、项目结构
16+
17+
<img src="./doc/diagram.png" alt="控制程序" style="zoom: 67%;" />
18+
19+
### 通信抽象层(CAL)
20+
21+
目前仅有 HTTP 服务端搭配 JsonRPC 协议一种方案。
22+
23+
#### 接口
24+
25+
tcp_server.c
26+
27+
#### 驱动
28+
29+
rpc_cjson.c
30+
31+
#### 应用
32+
33+
uvm_cal.c
34+
35+
### 硬件抽象层(HAL)
36+
37+
目前接口部分仅有 Linux 系统相关硬件驱动。
38+
39+
#### 接口
40+
41+
interface_xxx.c(内容为 utils 内各接口函数调用)
42+
43+
#### 驱动
44+
45+
driver_xxx.c
46+
47+
#### 应用
48+
49+
xxx.c
50+
51+
### 配置管理器(CFG)
52+
53+
目前仅有基于 Linux 文件系统下的配置管理。
54+
55+
#### 接口
56+
57+
uvm_cfg_intf.c
58+
59+
#### 驱动
60+
61+
cfg_xxx.c
62+
63+
#### 应用
64+
65+
uvm_cfg.c

0 commit comments

Comments
 (0)