準備 Python 範例
Python Module 使用與 C++ 相同的服務和 Shell 指令。先建置原生 Python SDK,之後就能在 .py 檔中撰寫模組邏輯。
這篇使用 Windows、PowerShell,以及啟用 GIL 的 64 位元 CPython 3.13。仍需先準備建置指南中的 C++ 工具,並在載入 MSVC x64 開發環境的終端機操作,確認能使用 cl、nmake、cmake 和 ninja。
1. 取得範例專案
Section titled “1. 取得範例專案”在想放專案的位置執行。若已有 open-vinc-examples,進入該目錄並跳過 clone 即可。
git clone --branch main https://github.com/JayTDawgzone1994/open-vinc-examples.gitcd open-vinc-examplesgit submodule update --init framework/open-vincgit -C framework/open-vinc submodule update --init --recursivenpm ci --prefix framework/open-vinc/src/vinc/ui/web後續命令都在這個 repository 根目錄執行。這個版本的 Windows Tcl 建置路徑請避免空白。
2. 建立 Python 環境
Section titled “2. 建立 Python 環境”安裝 64 位元 CPython 3.13 後執行:
py -3.13 -m venv .venv這會在專案內建立 .venv/。直接使用裡面的 Python 執行檔即可,不需要先啟用環境。請使用能搭配 MSVC 的 CPython;MinGW 版 Python 無法建置這個擴充。
3. 建置 SDK
Section titled “3. 建置 SDK”cmake -S python -B build/python -G Ninja -DCMAKE_BUILD_TYPE=Releasecmake --build build/python第一次會編譯框架和 Python 擴充,不需要另外執行 pip install vinc。
範例會使用 python/vinc.conf.in 選擇專案的 .venv,並把十個 Module 複製到執行檔旁:
build/python/├── Vinc.exe├── python/vinc/ # 產生的 SDK└── data/module/ ├── helloModule/helloModule.py ├── counterPublisher/counterPublisher.py ├── counterSubscriber/counterSubscriber.py ├── parameterPublisher/parameterPublisher.py ├── rpcPublisher/rpcPublisher.py ├── rpcSubscriber/rpcSubscriber.py ├── logPublisher/logPublisher.py ├── logSubscriber/logSubscriber.py ├── sensorPublisher/sensorPublisher.py └── sensorSubscriber/sensorSubscriber.py4. 開啟 Vinc Shell
Section titled “4. 開啟 Vinc Shell”.\build\python\Vinc.exe --python .\.venv\Scripts\python.exe--python 指定建置時使用的同一個環境。Python 範例保留這個選項,避免 Vinc 從 PATH 選到另一套 Python。
看到 VINC ready 後,可以先輸入 exit 關閉。下一篇再啟動 Module。
使用其他 Python 環境
範例預設使用專案的 .venv。若環境放在其他位置,配置時以 -DTUTORIAL_PYTHON_EXECUTABLE=完整路徑 指定,執行時的 --python 也要指向相容的同一環境。
Python minor 版本、64 位元與 GIL 組態需符合綁定建置資訊。完整要求見 Python SDK。
前往第一個運行模組,選擇 Python 分頁。接下來的教學會沿用這個語言選擇。
修改 python/modules/ 裡的程式後,執行 cmake --build build/python 複製更新,再重新啟動 Vinc。只改 Python 程式不必重新編譯 SDK;修改 .msg 定義則需要。