NEW: Add help documentation

Author: flame.yu

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/_static/image-20220921203219873.png

@@ -0,0 +1,130 @@
+
+
+## Arduino函数
+
+### 1 入口函数
+
+#### setup()
+
+Arduino控制器通电或复位后，即会开始执行setup() 函数中的程序，该部分只会执行一次。通常我们会在setup() 函数中完成Arduino的初始化设置，如配置I/O口状态，初始化串口等操作。
+
+#### loop()
+
+在setup() 函数中的程序执行完后，Arduino会接着执行loop() 函数中的程序。而loop()函数是一个死循环，其中的程序会不断的重复运行。通常我们会在loop() 函数中完成程序的主要功能，如驱动各种模块，采集数据等。
+
+### 2 数字输入/输出
+
+- [x] pinMode(pin, mode) 
+
+  在使用输入或输出功能前，你需要先通过pinMode() 函数配置引脚的模式为输入模式或输出模式。
+
+- [x] digitalWrite(pin, value)
+
+  配置成输出模式后，你还需要使用digitalWrite() 让其输出高电平或者是低电平。
+
+- [x] digitalRead(pin)
+
+  读取指定的电平值
+
+### 3 模拟输入/输出
+
+- [x] analogRead(pin) 
+
+  模拟输入引脚是带有ADC（Analog-to-Digital Converter，模数转换器）功能的引脚。
+  它可以将外部输入的模拟信号转换为芯片运算时可以识别的数字信号，从而实现读入模拟值的功能。
+  模拟输入功能需要使用analogRead() 函数。
+
+- [x] analogWrite(pin,value)
+
+  使用analogWrite() 函数实现PWM输出功能。
+  在analogWrite() 和analogRead() 函数内部，已经完成了引脚的初始化，因此不用在Setup() 函数中进行初始化操作。
+
+### 4 高级输入、输出
+
+- [ ] tone()
+
+  tone() 主要用于Arduino连接蜂鸣器或扬声器发声。可以让指定引脚产生一个占空比为50%的指定频率的方波。
+
+- [ ] pulseIn()
+
+  检测指定引脚上的脉冲信号宽度。
+  例如当要检测高电平脉冲时，pulseIn() 会等待指定引脚输入的电平变高，当变高后开始记时，直到输入电平变低，停止计时。
+  pulseln() 函数会返回这个脉冲信号持续的时间，即这个脉冲的宽度。
+  函数还可以设定超时时间。如果超过设定时间，仍未检测到脉冲，则会退出pulseIn()函数并返回0。
+  当没有设定超时时间时，pulseIn() 会默认1秒钟的超时时间。
+
+- [ ] attachInterrupt(pin, ISR, mode)
+
+  对中断引脚进行初始化配置，以开启Arduino的外部中断功能
+
+- [ ] detachInterrupt(pin)
+
+  如果你不需要使用外部中断了，你可以用中断分离函数detachInterrupt() 来关闭中断功能。
+
+### 5 时间控制
+
+- [x] millis()
+
+  获取Arduino通电后（或复位后）到现在的时间,单位毫秒ms
+
+- [x] micros()
+
+  获取Arduino通电后（或复位后）到现在的时间，单位微秒us
+
+- [x] delay( ms)
+
+  毫秒级延时
+
+- [x] micros()
+
+  微秒级延时
+
+### 6 串口通信函数
+
+- [x] Serial.begin(speed)
+- [x] Serial.print(val)
+- [x] Serial.println(val)
+- [x] Serial.read()
+
+### 7 I2C通信
+
+### 8 spi通信
+
+
+
+## 其他接口
+
+### HardwareSerial
+
+
+
+### HardwareTimer
+
+
+
+## 构建在核心中的库
+
+### SPI
+
+
+
+### I2C
+
+
+
+### Servo
+
+
+
+### Stepper
+
+
+
+### SoftwareSerial
+
+
+
+## 其他
+
+
+

docs/source/_static/logo_robomaster-o.png

@@ -0,0 +1,69 @@
+# 1. 开发环境搭建
+
+本指南将引导您在ArduinoIDE中进行RM通用扩展模块的开发。
+
+在此之前，我们需要安装Arduino开发环境。
+
+![image-20220921162822941](arduino-1.assets/image-20220921162822941.png)
+
+## 1.1 安装Arduino IDE
+
+如果您有安装过ArduinoIDE，请确认版本不低于1.8.12。
+
+如果还未安装，请先下载并安装[ArduinoIDE](https://www.arduino.cc/en/Main/Software)（[Windows](https://www.arduino.cc/en/Guide/Windows)、[Linux](https://www.arduino.cc/en/Guide/linux)、[Mac](https://www.arduino.cc/en/Guide/MacOSX)）。
+
+安装好Arduino IDE后，我们需要配置开发板环境，以便实现ArduinoIDE对RM扩展模块开发板的支持。
+
+## 1.2 添加开发板
+
+1 启动ArduinoIDE，单击`文件`，然后单击`首选项`（File->Preferences），打开以下页面。
+
+![arduino0001](arduino-1.assets/arduino0001.PNG)
+
+在 `附加开发板管理器网址`（*Additional Boards Managers URLs*）选项框中添加以下字段：
+
+```
+！！！Realse版本需修改
+https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
+```
+
+2 回到ArduinoIDE中，单击`工具（tools）`,然后选择`开发板（Board）`>`开发板管理器（Boards Manager）`。
+
+![arduino0002](arduino-1.assets/arduino0002.PNG)
+
+打开开发板管理器后，等待索引更新完成，向下拉找到`Robomaster Education Module`栏目，单击`安装（Install）`，等待安装完成后，关闭开发板管理器。
+
+![arduino0003](arduino-1.assets/arduino0003.PNG)
+
+再次打开`工具（tools）`->`开发板（Board）`，可以看到刚刚安装好的开发板`RoboMaster Education Series Boards`，选择所需的开发板`RM Expansion Module(RMEM01)`。
+
+![arduino0004](arduino-1.assets/arduino0004.PNG)
+
+至此，您已成功安装开发板支持！
+
+## 1.3 创建第一个草图
+
+首先，选中RM扩展模块开发板`RM Expansion Module(RMEM01)`。
+
+在下方的端口（Port）处选择开发板对应的端口。
+
+![arduino0005](arduino-1.assets/arduino0005.PNG)
+
+开发板对应端口可以在计算机管理中看到，其名称应该是如`USB串行设备（COMXX）`类似，括号中的`COM10`即为端口号。
+
+![image-20220909174444136](arduino-1.assets/image-20220909174444136.png)
+
+打开Blink示例程序：
+
+点击`文件(File)`->`示例(Examples)`->`01.Basics`->`Blink`，打开新的Blink示例程序。
+
+![arduino0006](arduino-1.assets/arduino0006.PNG)
+
+找到IDE工具栏，从左到右分别是“仅编译”以及“编译+上传”按钮。
+
+![image-20220921163513005](arduino-1.assets/image-20220921163513005.png)
+
+点击第二个按钮，ArduinoIDE会在完成编译工作之后自动将编译之后的二进制文件上传（烧写）到RM扩展模块中。
+
+烧写完成后，RM扩展模块的LED灯会以1s的时间间隔间歇闪烁。
+