1313_pyserial的安装以及文档的生成

全部学习汇总： GreyZhang/g_serial: Some serial learning notes which may be usefull in embedded system debugging. (github.com)

串口应该算是一个很有历史的技术了，在嵌入式的领域中应该有着极其广泛的应用。由于我自己工作的特殊性，从事了汽车电子，前几年的开发又是接触的别人的相对成熟的软硬件开发平台，因此这方面在工作的过程中就基本上没有用到。我真正觉得串口是一个好东西的时候其实是在我玩我的Arduino的时候，发现这种方式还是非常直接干脆的。

近段时间，串口在我做软件调试的时候给了我很大的帮助。但是，我觉得这个还是欠缺了点什么，主要的欠缺点应该就是没有Arduino那样的便捷。或许，我应该找一个上位机的东西，把我的调试以及测试串成块。这样，找一个python脚本支持的串口收发方案就成了我的首选。我找到了： pyserial/pyserial: Python serial port access library (github.com)

首先就是安装， pip install pyserial就可以了。这一个安装相对来说简单，在下载下来的repo压缩包中还有一个文档需要自己做生成。

文档位于上面的目录中，已经有写好的Makefile可以直接进行make生成。不过，在生成的时候需要安装一个文档生成工具。工具就是基于python实现的Sphinx。我第一次尝试安装的时候，可能网络质量很差，一直失败。后来，启用了我之前一直用的一个小脚本。

这是包管理的小脚本，具体的代码可以参考文章最后。现在看上去，似乎网络质量有了一定的改善。第一次安装基本都有快要成功的感觉了。

文档管理工具安装成功之后，可以切换到documentation目录下面，执行make html来生成html的文档。如果在windows的环境下执行，得注意需要有bash命令环境支持。以下是一个执行的效果：

如果要生成pdf，可以借助于latex。这样，输入make latex就可以生成。我的电脑WSL中配置了latex的环境，这里尝试生成一下pdf文档。还是在上面的目录，输入make latex。

执行结束，会有类似的提示。可能中间有一些警告，但是看到最后的生成成功，暂且不去管了。接下来，切换到latex配置文件的目录下继续生成pdf。

这样，就生成了pdf文档。

以上，是生成的文档的结果。

这一次的时间有点赶，时间不早了也该休息了。暂且做这个工具的安装以及文档生成的记录，后面的调试再说。

附加信息以及代码：

python包的强制安装：

#!/usr/bin/python

import os

def SmartInstall(lib_name):

installed_flg = False

num = int(1)

while installed_flg == False:

print("the %dth time try to install %s" % (num, lib_name))

num = int(num + 1)

try:

exec('import ' + lib_name)

installed_flg = True

except:

os.system("pip install -U %s" % lib_name)

SmartInstall('sphinx')