Kachaka API:功能介紹與啟用方式
Kachaka API(Application Programming Interface,應用程式介面)讓你用程式自由控制 Kachaka,或把它串接到自家系統與外部服務。家用版 Kachaka 與商用 Kachaka Pro 都支援。
Kachaka API 能做什麼
透過 API,你可以:
- 用程式下達搬運家具、移動到目的地、回充電座等指令,不必每次手動操作 App
- 讀取機器人即時狀態(位置、電量、任務進度等),整合到自家儀表板或排程系統
- 與外部服務、感測器或按鈕等裝置串接,組成屬於你場域的自動化流程
例如反覆往返、多點連續搬運這類進階流程,除了 App 的佇列與排程,也可以改用 API 自行編排,做法見佇列(Queue)與反覆/多重任務。載運家具同樣可由 API 觸發,見載入與載運家具。
文件、社群與範例程式
原廠把 API 文件、討論社群與範例程式都集中在 GitHub:
- 官方文件與範例程式庫:https://github.com/pf-robotics/kachaka-api API 的執行方式、安裝說明與範例下載都在這裡
- 使用者社群(Discussions):https://github.com/pf-robotics/kachaka-api/discussions 可與其他開發者交流、提問與分享做法
- 範例程式:原廠提供 JupyterLab、Python、ROS2 三種範例程式,方便你快速起步;範例會持續更新,取得方式請參考上方 GitHub 文件
啟用前提:先確認本體版本
Kachaka API 需要本體軟體 Ver 2.0.8 以上才支援。啟用前請先確認版本,必要時更新到最新版——版本查詢與更新方式見本體軟體更新(手動、自動與通知排查)。
在 App 啟用 Kachaka API
確認版本後,依下列步驟在 App 開啟 API(按鈕集線器 Button Hub 的進階用途同樣需要先啟用此設定):
- 開啟 Kachaka App,切到「設定」分頁。
- 在「Kachaka 設定」中,點選要啟用的那台 Kachaka。
- 在畫面中段點選「Kachaka API」。
- 把「啟用 Kachaka API」的開關切到 ON。
- 在跳出的對話框中確認 API 使用條款,勾選「同意 Kachaka API 使用條款」。
- 點「設定」。
- 看到畫面顯示「已啟用 Kachaka API」,即代表啟用完成。
啟用後,就可以依 GitHub 文件連線到機器人開始開發。連線時需要機器人的 IP 位址,查詢與固定方式見查詢與固定 IP/MAC 位址。
API 使用條款的具體內容與適用範圍,以 Sigma 台灣公告為準。
操作畫面