1313_ Pyserial installation and document generation

All learning summary ： GreyZhang/g_serial: Some serial learning notes which may be usefull in embedded system debugging. (github.com)

Serial port should be a very historical Technology , It should be widely used in the field of embedded . Because of the particularity of my own work , Engaged in automotive electronics , The development of previous years is a relatively mature software and hardware development platform that contacts others , Therefore, this aspect is basically not used in the process of work . When I really think serial port is a good thing, I'm actually playing with my Arduino When , It is very straightforward to find this way .

Nearly period of time , Serial port has given me a lot of help when I do software debugging . however , I think there is something missing in this , The main disadvantage should be that there is no Arduino So convenient . Maybe , I should find something on the upper computer , String my debugging and testing together . such , Find one. python The serial port transceiver scheme supported by script has become my first choice . I have found the ： pyserial/pyserial: Python serial port access library (github.com)

The first is to install , pip install pyserial That's all right. . This installation is relatively simple , In the download repo There is another document in the compressed package that needs to be generated by yourself .

The document is located in the directory above , There are already written Makefile It can be done directly make Generate . however , You need to install a document generation tool when generating . Tools are based on python Realized Sphinx. When I first tried to install , Maybe the network quality is very poor , Failed all the time . later , A small script that I have been using before is enabled .

This is a small script for package management , For specific code, please refer to the end of the article . Now it looks like , It seems that the network quality has improved . The first installation is almost successful .

After the document management tool is successfully installed , You can switch to documentation Below directory , perform make html To generate html Documents . If in windows In the environment of , Pay attention to the need for bash Command environment support . The following is an implementation effect ：

If you want to generate pdf, With the aid of latex. such , Input make latex You can generate . My computer WSL Configuration of the latex Environment , Here try to generate pdf file . Still in the directory above , Input make latex.

end of execution , There will be similar hints . There may be some warnings , But see that the final generation is successful , Leave it alone for the time being . Next , Switch to latex Continue to generate under the directory of the configuration file pdf.

such , It was generated pdf file .

above , Is the result of the generated document .

This time I'm in a bit of a hurry , It's getting late, and it's time to rest . For the time being, do the installation of this tool and the record of document generation , Later debugging .

Additional information and code ：

python Forced installation of packages ：

#!/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')