Skip to content

Commit 1c09d2c

Browse files
committed
[optimize] firmware-develop.md micropython-ide.md
1 parent 1e4ca70 commit 1c09d2c

File tree

3 files changed

+25
-29
lines changed

3 files changed

+25
-29
lines changed

docs/assets/en_connect_board.gif

233 KB
Loading

docs/firmware-develop.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## MicroPython 固件开发指南
22

3-
如果手上没有官方支持固件的开发板,就需要自己来动手制作 MicroPython 固件了。由于 RT-Thread 官方提供了 MicroPython 软件包,并且 MicroPython 底层和硬件绑定时对接了 RT-Thread 驱动框架,所以我们可以很方便地在运行了 RT-Thread 的板卡上将 MicroPython 跑起来。
3+
如果手上没有官方支持固件的开发板,就需要自己来动手制作 MicroPython 固件了。由于 RT-Thread 官方提供了 [MicroPython 软件包](https://github.com/RT-Thread-packages/micropython),并且 MicroPython 底层和硬件绑定时对接了 RT-Thread 驱动框架,因此可以很方便地在运行了 RT-Thread 的板卡上将 MicroPython 跑起来。
44

55
**注意**:RT-Thread MicroPython 需要运行在 **RT-Thread 3.0** 版本以上。
66

@@ -53,12 +53,7 @@ RT-Thread MicroPython mini 版本占用资源最大不超过:
5353

5454
### 在 main 线程中启动 MicroPython
5555

56-
最后要在 main 线程中启动 MicroPython,需要完成的功能如下:
57-
58-
1. 挂载文件系统到 `/` 目录
59-
2. 启动 MicroPython
60-
61-
上述功能可以通过修改 main 函数来实现,修改 main 代码如下所示:
56+
最后要在 main 线程中启动 MicroPython,代码修改如下所示:
6257

6358
```c
6459
#include <rtthread.h>
@@ -67,42 +62,43 @@ RT-Thread MicroPython mini 版本占用资源最大不超过:
6762
#include <dfs_fs.h>
6863
#include <rtdevice.h>
6964

65+
/* 文件系统所在分区名称,根据实际情况填写 */
7066
#define FS_PARTITION_NAME "W25Q128"
7167

72-
/* defined the LED0 pin: PF9 */
73-
#define LED0_PIN GET_PIN(F, 9)
74-
7568
int main(void)
7669
{
77-
/* 挂载 elm 文件系统到 / 目录 */
78-
if (dfs_mount(FS_PARTITION_NAME, "/", "elm", 0, 0) == 0)
70+
/* 挂载 elm 文件系统到 / 目录,如果你所使用的开发板没有文件系统也可以跳过这一步 */
71+
if (dfs_mount(FS_PARTITION_NAME, "/", "elm", 0, 0) == 0)
7972
{
8073
rt_kprintf("Filesystem initialized!");
8174
}
8275
else
8376
{
84-
rt_kprintf("Filesystem initialization failed!");
77+
/* 如果挂载失败,则尝试在文件系统分区重新创建文件系统 */
78+
dfs_mkfs("elm", FS_PARTITION_NAME);
79+
/* 尝试重新挂载文件系统 */
80+
if (dfs_mount(FS_PARTITION_NAME, "/", "elm", 0, 0) == 0)
81+
{
82+
/* 仍然挂载文件系统失败,请自行检查失败原因 */
83+
rt_kprintf("Failed to initialize filesystem!");
84+
}
8585
}
8686

8787
rt_thread_mdelay(100);
8888

89-
/* 运行 MicroPython 启动函数 */
90-
extern void mpy_main(const char *filename);
91-
mpy_main(NULL);
92-
93-
rt_kprintf("You can enter repl mode by typing python commands.");
89+
while(1)
90+
{
91+
/* 在这里让程序进入循环,通过这种方式实现 MicroPython 的软复位*/
92+
extern void mpy_main(const char *filename);
93+
/* 启动 MicroPython */
94+
mpy_main(NULL);
95+
}
9496

95-
/* 如果想要在 REPL 环境按下 CTRL+D 重启系统可以加上下面这一句 */
96-
/* rt_hw_cpu_reset(); */
97+
return RT_EOK;
9798
}
9899
```
99100
100-
重新编译工程下载到板卡中,就会在 main 线程中自动进入 MicroPython 的交互环境 REPL。此时如果先前没有在存储器上创建相应的文件系统,可能会导致文件系统挂载失败。此时可以使用如下两种方法在存储设备上创建文件系统:
101-
102-
- 按下 `CTRL + D` 进入 msh 使用 `mkfs -t elm W25Q128` 命令创建文件系统
103-
- 在 REPL 交互环境中输入 `import os`,`os.mkfs("elm", "W25Q128")` 命令来创建文件系统
104-
105-
注意: **W25Q128** 是本次示例中将要创建文件系统的块设备名称,并不是固定填写该名称。因此在使用上述命令创建文件系统前,需要确定当前系统中块设备的实际名称。
101+
重新编译工程并下载程序到板卡中,就会在 main 线程中自动启动 MicroPython,接下来就可以使用 [**RT-Thread MicroPython 开发环境**](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 来进行应用开发了。 通过开发环境连接到开发板,即可看到 MicroPython 的交互环境 REPL,如下图所示:
106102
107-
成功创建文件系统后,就可以使用 [ **MicroPython 开发环境**](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 来进行应用开发了。
103+
![en_connect_board](assets/en_connect_board.gif)
108104

docs/micropython-ide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ RT-Thread 为广大开发者提供了 VSCode 最好用的 MicroPython 插件 来
1111
- 支持在内存中快速运行代码文件功能
1212
- 支持运行代码片段功能
1313
- 支持多款主流 MicroPython 开发板
14-
- 支持 windows 及 ubuntu 操作系统
14+
- 支持 Windows、Ubuntu、Mac 操作系统
1515

1616
### 安装 IDE 开发环境
1717

@@ -21,4 +21,4 @@ RT-Thread 为广大开发者提供了 VSCode 最好用的 MicroPython 插件 来
2121

2222
可通过查看如下文档进一步了解并使用 RT-Thread MicroPython IDE:
2323

24-
- [RT-Thread MicroPython develop environment](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython)
24+
- [RT-Thread MicroPython Develop Environment](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython)

0 commit comments

Comments
 (0)