فهرست منبع

Add api docs structure

Wu Han 6 سال پیش
والد
کامیت
caf36b2ece
3فایلهای تغییر یافته به همراه50 افزوده شده و 1 حذف شده
  1. 0 0
      docs/README.md
  2. 49 0
      docs/api.md
  3. 1 1
      docs/samples.md

+ 0 - 0
docs/READNE.md → docs/README.md


+ 49 - 0
docs/api.md

@@ -0,0 +1,49 @@
+# RT-Robot API 介绍
+
+在各个模块硬件测试通过后,会一步步将稳定的 API 添加到这里,现在大家可以参照[例程](./samples.md)里面提供的方法进行初始化和控制。
+
+
+
+## 控制器 API (controller)
+
+不同手柄按键指令与机器人运动指令间的转换。
+
+
+
+## 机器人 API (robot)
+
+包括智能小车、机械臂、飞行器。
+
+### 智能小车 API (mobile_robot)
+
+#### 1 车底盘 API (chassis)
+
+
+
+##### 1.1 车轮 API (wheel)
+
+闭环车轮的运动。
+
+
+
+**1.1.1 电机 API (motor)**
+
+电机控制相关。
+
+**1.1.2 编码器 API (encoder)**
+
+获取编码器信息。
+
+**1.1.3 PID API (PID)**
+
+闭环控制。
+
+
+
+##### 1.2 动力学模型 API (kinematics)
+
+小车速度 (x, y, w) 与各个电机转速 (rpm1, rpm2, rpm3, rpm4) 之间的相互转换。
+
+
+
+#### 2 传感器 API (sensor)

+ 1 - 1
docs/samples.md

@@ -13,7 +13,7 @@
 
 
 下面是两轮差分控制的小车初始化示例代码:
 下面是两轮差分控制的小车初始化示例代码:
 
 
-```
+```C
 // 1. Initialize two wheels - left and right
 // 1. Initialize two wheels - left and right
 wheel_t* c_wheels = (wheel_t*) rt_malloc(sizeof(wheel_t) * 2);
 wheel_t* c_wheels = (wheel_t*) rt_malloc(sizeof(wheel_t) * 2);
 if (c_wheels == RT_NULL)
 if (c_wheels == RT_NULL)