head.jpg
Mpfshell 使用手冊
由于本章涉及的內容不適合圖示說明，所以均已表格或文字說明。
在 python3.5 以上使用命令 pip install mpfshell-lite 即可安裝，接著輸入 mpfshell-lite 即可打開運行。
mpfshell_install.png
0. 了解不同的支持版本
| 系統類型 | 系統版本 | 運行情況 | 注意事項 |
|---|---|---|---|
| Windows | WIN7 - WIN10 | 正常 | 原生 CMD 不支持 TAB |
| Linux | Lubuntu - Ubuntu | 正常 | 原生 Shell 支持 TAB |
| Mac | Darwin | 正常 | 與 Unix 均一致 |
1. 了解重要的功能操作
| 操作方法 | 不同系統工具支持情況 | 運行效果 | 注意事項 |
|---|---|---|---|
| 輸入一些內容后通過 TAB 鍵補全 | 僅 shell、repl、powershell 支持。 | 如果想要打 import 只需要 輸入 i 后在按下 TAB 鍵就可以自動補全了，比如 linux 下，輸入 ttyUSB0，只需要 i + TAB 鍵就可以了。 | 前提是，該命令被系統提前輸入過，否則它沒辦法補全，它只能補全歷史輸入的信息。 |
| 左鍵復制選取，右鍵粘貼選取 | 僅 Windows的系統支持。 | 開啟 CMD控制臺 程序的屬性里的 快速編輯 功能，可以讓程序支持鼠標 點擊暫停程序后點左鍵拖動復制文本內容。 | 如果選取的是多行代碼或命令，不代表可以直接使用，所以一般都是選取一行的。 |
| 上下左右按鍵及退格 | 均支持 | 上下按鍵可以切換讀取歷史輸入過的命令，左右方向鍵以及程序退格操作可以對自己輸入過的內容進行修改。 | 僅針對windows做了修復。 |
2. 了解所有功能的命令
| 命令類型 | 使用方法 | 運行結果 | 注意事項 |
|---|---|---|---|
| open(o) | 打開當前設備。格式有：有線串口 open com3，無線有 ws:192.168.10.114,1234
|
連接成功后返回 Connected to esp32
|
控制板子前，需要先打開連接。括號為簡寫。 |
| close | 關閉當前設備。 | ||
| quit | 輸入 | 退出程序 | |
| EOF | 輸入 | 退出程序 | 無 |
| cat | 輸入 文件名，例如 cat boot.py
|
將板子的指定文件打印出來快速查看。 | 無 |
| put | 把當前目錄下的文件推送到板子，例如put boot.py
|
無 | 失敗會返回錯誤信息 |
| get | 獲取板子當前目錄下的文件，例如get boot.py
|
在程序運行的目錄下多了一個 boot.py 文件 | |
| mput | 與 put 相對，以板子為主，對程序的目錄操作。 | ||
| mget | 與 get 相對，以板子為主，對程序的目錄操作。 | ||
| repl(e) | 進入 python 的 repl 控制接口 | 可以直接執行python代碼。 | |
| exec (e) | 輸入 Python 代碼，例如exec print('hello')
|
返回print('hello')的運行結果 hello | 只能執行一行 python 代碼。括號為簡寫。 |
| execfile(ef) | 執行板子中存在的python文件，例如execfile main.py
|
執行 main.py 的效果 | 括號為簡寫。 |
| lexecfile(ef) | 執行程序下存在的python文件，例如lexecfile main.py
|
執行 main.py 的效果 | 括號為簡寫，與 runfile 不同的是會進入repl模式，所以支持input操作。 |
| runfile(rf) | 結合了 put 和 execfile 命令 | 括號為簡寫。 | |
| cd | 輸入 指定板子里的目錄，例如 cd /
|
修改程序訪問板子的所處目錄 | 以 / 開頭的linux路徑，盡量不要改變路徑，除非你十分清楚自己在做什么。 |
| md | 輸入 目錄名稱 | 在板子上新建一個目錄 | 無 |
| lcd | 輸入 指定現在程序里的目錄，例如 cd /
|
修改程序訪問板子的所處目錄 | 以 / 開頭的linux路徑，盡量不要改變路徑，除非你十分清楚自己在做什么。 |
| pwd | 輸入pwd
|
返回當前板子所處的目錄 | 無 |
| lpwd | 輸入 lpwd
|
返回當前程序所處的目錄 | 無 |
| mpyc | 輸入 當前目錄下的 python 文件，例如 mpyc main.py
|
把 python 代碼 pyc 化靜態編譯代碼處理，生成 main.pyc | |
| mrm | 輸入程序當前的 rm 目錄或文件名
|
移除該目錄或文件名 | |
| rm | 輸入板子當前的 rm 目錄或文件名
|
移除該目錄或文件名 | |
| ls | 輸入ls /
|
查看 板子 當前目錄下的所有文件 | |
| lls | 輸入 lls /
|
查看 程序 當前目錄下的所有文件 | |
| view | 輸入 view
|
查看 本機 可能的串口，和當前的 open 配置 | |
| help | 查看命令的幫助，詳細看本節結尾。 |
在程序中，你也可以通過 help + 命令 的方式獲取對應的命令說明或參數等細節。
例如：help cd， 返回的是 cd <TARGET DIR> ? Change current remote directory to given target.。
可以得知 它是用來改變 目標板子里的當前文件目錄起點，相當于設置板子的文件夾默認路徑在什么位置。
提示：連接板子的時候，要特別注意死循環，如果在連接過程中板子存在沒有任何延時的死循環，則會影響軟件連接板子的成功率，尤其是沒有延時的 mian.py 死循環，這會導致上電后將無法連接無線模式，這點需要注意，不過，有線串口的連接不成功則會進行板子的復位。
