是为《智能机电系统实践》课程项目，目的在于实现一个能对物品进行识别、抓取、运输、卸载的机器人。该课程又名机械制图实践，在计算设计之外强调实际制造。因此，应用可行性（及应用效率）而非理论可行性是本项目更加关注之处。
Note
本仓库主要存储算法代码，同时也存储一部分其他材料。
- 新的代码请在
src创建新文件夹并放入。 - 代码要用到的数据请在
assets创建新文件夹并放入，零碎的数据可放入assets/miscellaneous。（加工数据时，请不要删除旧的数据，而是创建一个新文件夹并将加工后的数据放入） - 文档类材料请放入
doc。当系统设计发生增添或删减时，请及时更新文档。如果有值得额外说明的问题，可以在其中增加新文件加以注释。
Tip
若是深陷迷茫，不妨运行Trium_Intro。
assets-- 一些图片，以及会在算法中用到的非代码数据。doc-- 一些其他材料，如设计方案等。关于文档的更多信息请参考README.md。src-- 源代码。algorithm-- 一些算法，部署于树莓派4B。communication-- 通信相关的代码，如串口、摄像头等。archive-- 代码存档，包括有趣的尝试和备份代码。关于STM32部分的代码请参考README.md。
paper-- Git Submodule, 链接到论文的LaTex代码仓库。
A typical pythonic documentation should behave like this:
def func(arg1: int, arg2: str) -> bool:
"""
Here is the function's brief introduction. The imperative mood instead of the declarative mood is recommended.
- You may add some detailed description here. It is optional, and can have a flexible format.
Args:
arg1 (int): Description of the first argument.
arg2 (str): Description of the second argument.
Returns:
value (bool): Always True.
Note:
Some additional notes may be placed here, such as problems to be solved, etc.
"""
value = True
return valueThis documentation style guide is based on Google Python Style Guide. It is a simplified version, and thus the example part is omitted since we are not writing a complicated project.
A commit message should be clear and concise in order that problem dealing can be more efficient. It ought to be in the following format:
<type>(<scoop>): <subject>
// <BLANK LINE>
<body>
// <BLANK LINE>
<footer>
<type>: The type of the commit, such asfeat,fix,docs,style,refactor,test,chore, etc.<scoop>(optional) : The scope of the commit, such asalgorithm,communication,archive, etc.<subject>: A brief summary of the commit. It should be in the imperative mood withoutdot (.)at the end of a line.<body>(optional) : A detailed description of the commit.<footer>(optional) : A footer for the commit, such asBREAKING CHANGE,ISSUES CLOSED, etc.
Note
Although pull requests are different from commits, you may follow the same format when writing a pull request.
Warning
禁止†升天†
