說說 MicroPython 的項目整體架構


今天來說說 MicroPython 的架構情況,如果有必要我會做一些源碼分析的文章供大家參考。

先來認識一下 MicroPython 整體情況,可以從軟件的角度上去看待,首先我們拿到 MicroPython 的主倉庫。

直接 git clone https://github.com/micropython/micropython ,在 Windows 下進行操作了解一下。

之后需要交叉編譯代碼的時候,必然會回到 Linux ,Windows 10 的發展 Linux 內核還需要一些時間,但應該也快了,屆時巨硬霸主將會攜帶跨平台系統和雲端開發服務重新降臨到開發者陣營中,拭目以待。

目錄情況

一般來說,我們先看一下 readme.md 這里大多時候都會存放這個項目的整體情況或 build 情況。

This is the MicroPython project, which aims to put an implementation
of Python 3.x on microcontrollers and small embedded systems.
You can find the official website at micropython.org.

可知 micropython 是實現了 Python3.x 以上的 Python 語法解釋器,接着看到。

MicroPython implements the entire Python 3.4 syntax (including exceptions,
with, yield from, etc., and additionally async/await keywords from
Python 3.5). The following core datatypes are provided: str (including
basic Unicode support), bytes, bytearray, tuple, list, dict, set,
frozenset, array.array, collections.namedtuple, classes and instances.
Builtin modules include sys, time, and struct, etc. Select ports have
support for _thread module (multithreading). Note that only a subset of
Python 3 functionality is implemented for the data types and modules.

可以看到實現了不少關鍵詞(keywords ),注意 Python3 最大的變化在於 str 和 byte 徹底分離,而 MicroPython 也為此做了很多修改,符合預期。

然后協程相關的語法糖(yield、async、await)都支持了,with 和 in 也有,再來基本的標准庫 sys 與 time、struct 、math 等。

最最重要的是,大量現成的基礎容器(str、bytes、bytearray、tuple、list、dict、set、btree),編寫軟件的福利鴨!

最后就是根據芯片的 RTOS 情況提供的 _thread 多線程庫,功能上略有缺失,因為多線程的設計和 X86 的有些區別。

but,這些特性並非所有芯片都支持,有時候,要依據不同的芯片情況,對此做裁剪處理,類似制作 linux kernel 一樣,選擇性的放入一些硬件相關的關鍵 C 驅動代碼。

現在我們接着看很關鍵的倉庫目錄說明,可能有些過時,但這並不影響我們對它的認識。

Major components in this repository:
- py/ -- the core Python implementation, including compiler, runtime, and core library.
- mpy-cross/ -- the MicroPython cross-compiler which is used to turn scripts into precompiled bytecode.
- ports/unix/ -- a version of MicroPython that runs on Unix.
- ports/stm32/ -- a version of MicroPython that runs on the PyBoard and similar STM32 boards (using ST's Cube HAL drivers).
- ports/minimal/ -- a minimal MicroPython port. Start with this if you want to port MicroPython to another microcontroller.
- tests/ -- test framework and test scripts.
- docs/ -- user documentation in Sphinx reStructuredText format. Rendered HTML documentation is available at http://docs.micropython.org.

Additional components:
- ports/bare-arm/ -- a bare minimum version of MicroPython for ARM MCUs. Used mostly to control code size.
- ports/teensy/ -- a version of MicroPython that runs on the Teensy 3.1 (preliminary but functional).
- ports/pic16bit/ -- a version of MicroPython for 16-bit PIC microcontrollers.
- ports/cc3200/ -- a version of MicroPython that runs on the CC3200 from TI.
- ports/esp8266/ -- a version of MicroPython that runs on Espressif's ESP8266 SoC.
- ports/esp32/ -- a version of MicroPython that runs on Espressif's ESP32 SoC.
- ports/nrf/ -- a version of MicroPython that runs on Nordic's nRF51 and nRF52 MCUs.
- extmod/ -- additional (non-core) modules implemented in C.
- tools/ -- various tools, including the pyboard.py module.
- examples/ -- a few example Python scripts.

可以看到這些是官方做了一些架構上的說明,雖然有點亂,但也是可以窺探一二的。

只是為了編譯使用 MicroPython 的同學,可以直接看到 ports 文件夾,這里存放着官方移植的一些對應硬件的編譯固件配置,進入到其中選擇你想要編譯的平台,即可得到一個 MicroPython 解釋器,開始你的 Python 編程。

如果想知道更多,我繼續往下講。

想知道更多?

文件夾列表大致內容如下

  • py Python 解釋器相關的抽象實現的代碼,包含運行時等等。
  • mpy-cross MicroPython 編譯器,處理 Python 代碼回 ByteCode 機器碼。
  • ports 對應平台移植配置文件
  • tests 框架測試腳本
  • docs 配置到 Sphinx 的文檔網站
  • extmod 一些不需要在 Core 中的抽象 C 接口代碼。
  • tools 各類腳本輔助工具,例如 Pyboard.py 可以通信控制 MicroPython 。
  • examples Python 示例代碼。
  • lib 給 port 用的各自平台的 SDK 依賴庫,可能在里面,也可能在外面,並不重要。
  • drivers 通過軟實現的硬件驅動,基於 py 的架構使用標准 C 實現的 Python 模塊(C + Python),和芯片自己提供的 SDK 略微不同,有較大的兼容性。

對於我們做移植或做深層次的開發有兩個方向,假設不破壞官方的架構的基礎上,如何結合到現在自己手頭的硬件或者軟件。

MicroPython 解釋器核心的基本認識

我們需要對 MicroPython 的解釋器有一個大概的認識,這就需要初略閱讀一下 py 的結構了,關鍵的文件在 compile(python) 、 obj(alloc) 、 nlr (non-local return) 、vm(execute) 等地,總之全都很重要吧。

因此一個解釋器的構成情況常有有代碼執行環境(堆棧)、代碼交互接口(REPL)、變量存取接口(allocator)、代碼編譯接口(compile)等。

就我們通常的使用方法來講解吧。

一段 Python 代碼,通過 REPL 進入解釋器的緩存中,解釋器程序將會對這段代碼進行解釋(編譯成 ByteCode),接着通過解釋后的 code 進行執行,執行時送到解釋器的函數棧上,該執行的就執行,該報異常的報異常。

要做到這樣的效果,我們必須深入往下看才能得知具體的細節,關於 py 的部分我就暫且講到這里,之后也會單獨解釋一些 py 的源碼解釋,專門講解它的構成和 debug 或是修改源碼(bug)。

MicroPython 的測試 & 示例

如果我們沒有能力去修改 MicroPython ,那就要了解它的外圍代碼和測試,分別在 example 和 tests,這里有許多測試示例代碼供你應用和查閱。

如看 run-tests-exp.sh 和 run-tests-exp.py 文件,又或是 run-tests ,這些都是自動化的測試接口腳本,通過這樣的方式可以讓 micropython 解釋器進行接口覆蓋性測試。

自動化生成的示例如下:(均可在 Windows 或 Unix 下運行喔)

如圖所見,將在 repl 執行的 Python code 結果返回存到 .exp (example)下進行測試核對。

了解到它的測試框架后,現在是不是對 MicroPython 稍微有了一些信心呢?接着我們還要看到真正開始使用的部分了。

MicroPython 中各芯片標准移植接口

這里就存放着 MicroPython 應用領域中最有價值的代碼,也就是官方提出的專用的移植接口示范,對於一般的開發者來說,足夠使用了,但對於專業的來說,不僅是使用它,包括如何移植它,改造它,修復它等等都是要了解的。

先看一點簡單的移植示例吧 windows 、unix 、還有 minimal 文件夾。

比如我現在在 Windows 上,使用 VS2019 直接打開 windows 的 micropython.vcxproj 文件即可編譯生成一個 micropython.exe 解釋器了,如下圖。

而 unix 則對應着 linux 或 macOS 環境下直接運行即可,我這里不想多示范了,沒有什么區別。

但 minimal 很重要,這個是以 STM32F405 的芯片啟動流程做了一個硬件移植示范,關於如何從 main 函數初始化 py 相關資源然后鏈接 nlr 函數等等示例,這將指導你如進行 MicroPython 的移植。

事實上,無論是 STM 還是 TI 又或是 nRF 家的芯片,都可以依次為依據進行主體的移植,然后根據周邊情況提供標准庫函數的接口,就可以完成 MicroPython 的移植,如果是嵌入式 C 類型的芯片,注意一下替代函數的對接就好了,因為 MicroPython 設計之初就足夠的抽象了,不信看看 bare-arm 的三個關鍵文件 mpconfigport.h 、 mphalport.h 、 qstrdefsport.h ,接着再看看 JavaScript 的接口,就知道我在說什么了,你完全可以把 MicroPython 當作一個解釋器接口模塊導入你的環境,其他動態語言也是如此,例如 lua 和 JerryScript 也是如此,只是 micropython 提供了太多穩定可用的模塊代碼,讓我沒得選擇了(真香。

結語

之后我將會以我在做的樂鑫 ESP 系列的芯片 esp8266 和 esp32 來做移植和修改的源碼解析說明,畢竟官方已經移植完了大多數主流的芯片配置項目,所以我只能做一些源碼升級和修改的說明了,那些移植直接抄過來都不是太大的問題。

寫到這里,仔細一看 micropython 和我當年做的 ZwLib 是同樣的架構鴨,可惜我的太菜了就放棄繼續維護了,大佬不僅強,寫代碼的速度也很快,真令人頭大。

  • 撰寫時間:2019年9月2日
  • 作者名稱:junhuanchen
  • 聯系方式:
  • WeChat & Github: 作者名稱
  • QQ & E-mail: 作者名稱@qq.com


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM