更新了大量文档

This commit is contained in:
NeoZng
2023-06-03 21:58:21 +08:00
parent ff5028036a
commit 253f391cd5
17 changed files with 141 additions and 74 deletions

View File

@@ -0,0 +1,3 @@
# tfminiplus
北醒激光单点激光雷达模块的简单实现。目前使用iic阻塞通信耗时和速度都太慢需修改为中断读取bsp_iic已经提供相应的接口。

View File

@@ -25,6 +25,7 @@ CAN comm是用于CAN多机通信的模块。你不需要关心实现的协议
CANCommInstance *CANCommInit(CANComm_Init_Config_s* comm_config);
void CANCommSend(CANCommInstance *instance, uint8_t *data);
void *CANCommGet(CANCommInstance *instance);
uint8_t CANCommIsOnline(CANCommInstance *instance);
```
第一个函数将会初始化一个CANComm实例返回其指针。使用CANComm进行通信的应用应该保存返回的指针。初始化需要传入一个初始化结构体。请在应用初始化的时候调用该函数。推荐的结构体配置方式如下
@@ -139,4 +140,3 @@ CAN comm的通信协议如下
流程图如下:![未命名文件](../../assets/CANcomm.png)

View File

@@ -42,6 +42,7 @@ void DaemonTask()
else if (dins->callback) // 等于零说明超时了,调用回调函数(如果有的话)
{
dins->callback(dins->owner_id); // module内可以将owner_id强制类型转换成自身类型从而调用特定module的offline callback
// @todo 为蜂鸣器/led等增加离线报警的功能,非常关键!
}
}
}

View File

@@ -4,4 +4,9 @@
注意LK电机在使用多电机发送的时候只支持一条总线上至多4个电机多电机模式下LK仅支持发送id 0x280为接收ID为0x140+id.
要设置为多电机模式请通过串口连接电机并使用该文件夹下的LK motor tool.exe进行配置。
要设置为多电机模式请通过串口连接电机并使用该文件夹下的LK motor tool.exe进行配置。
## LK的其他电机
若使用其他LK电机唯一需要修改的是确定编码器的精度即LKMotorDecode()部分的速度反馈和编码器反馈解析。

View File

@@ -4,10 +4,8 @@
请使用字库软件制作自己的图标和不同大小的ascii码.
> 后续尝试移植一些图形库使得功能更加丰富
> oled主要作调试和log/错误显示等使用
> 可以提供给视觉和机械的同学调试接口,方便他们通过显示屏进行简单的设置
*可以引入RoboMaster oled,或额外增加一个编码器用于控制oled界面并设定一些功能.*

View File

@@ -1,6 +1,6 @@
# 标准命令
这是一个体力活也是一个艺术品。请把不同的控制命令module进行封装以转化成标准的消息类型包括云台角度速度底盘速度发射频率是否发射等信息供RobotCMD应用或其他应用使用。
这是一个体力活也是一个艺术品。请把不同的控制命令module进行封装以转化成标准的消息类型包括云台角度速度底盘速度发射频率是否发射等信息供RobotCMD应用或其他应用使用。通过这种方式开发者可以更专注于cmd命令的编写而不需要为每台机器人/不同的控制器编写命令转换。
是否将下面的模块都放到standard_cmd文件夹下似乎没有必要。
@@ -13,5 +13,4 @@
## key and mouse
## 图传链路
这似乎和键鼠是同一套,不过走的是串口,可能需要额外添加支持模块
图传链路的数据解析似乎和键鼠是同一套协议,不过走的是串口,可能需要额外添加支持模块

View File

@@ -1,7 +1,9 @@
# univsersal communication
@todo
unicomm旨在为通信提供一套标准的协议接口屏蔽底层的硬件差异使得上层应用可以定制通信协议包括包长度/可变帧长/帧头尾/校验方式等。
不论底层具体使用的是什么硬件接口,硬件的每一帧传输完数据放在缓冲区之后,就没有任何区别了。 此模块实际上就是对缓冲区的rawdata进行操作包括查找帧头计算包长度校验错误等。
不论底层具体使用的是什么硬件接口,实际上每一帧传输完并把数据放在缓冲区之后,就没有任何区别了。 此模块实际上就是对缓冲区的rawdata进行操作包括查找帧头计算包长度校验错误等。
完成之后可以将module/can_comm移除把原使用了cancomm的应用迁移到此模块。
完成之后可以将module/can_comm、视觉的通信协议seasky_protocol和master_process等移除把原使用了cancomm的应用迁移到此模块。

3
modules/vofa/vofa.md Normal file
View File

@@ -0,0 +1,3 @@
# vofa
**除非迫不得已否则强烈不推荐使用vofa进行调试。应通过bsp_log输出日志或使用ozone可视化。**