BRICKS Controller 內建了一份參考指南,記錄了建構應用程式時可用的每個實體、屬性和設定選項。可直接在瀏覽器中存取:Documentation Index
Fetch the complete documentation index at: https://docs.bricks.tools/llms.txt
Use this file to discover all available pages before exploring further.
開啟核心參考
在 control.bricks.tools 瀏覽完整參考文件
參考文件的內容
核心參考詳細涵蓋了 BRICKS 平台的每個建構元素。在使用 Config Editor 或 bricks-ctor 時,若需要特定的屬性文件,請搭配使用。Bricks
顯示內容並處理互動的 UI 元件。| Brick | 用途 |
|---|---|
| Text | 帶有樣式的文字顯示 |
| TextInput | 可編輯的文字欄位 |
| RichText | 支援 HTML 內容、多種字型與內嵌圖片的 Rich Text |
| Image | 圖片顯示 |
| Video | 影片播放 |
| VideoStreaming | RTSP / RTMP 即時影像串流 |
| WebrtcStream | WebRTC 影音串流 |
| GenerativeMedia | 由 AI 生成的圖片與影片 |
| WebView | 嵌入式網頁內容 |
| Lottie | .json 與 .dotlottie 動畫,支援速度、循環與影格範圍控制 |
| Rive | .riv 動畫,支援狀態機輸入、文字取代與 artboard 切換 |
| Svg | SVG 向量圖形 |
| Chart | 資料視覺化 |
| Icon | FontAwesome 6 Pro 圖示 |
| QrCode | QR Code 顯示 |
| Camera | 即時相機畫面 |
| Maps | 地圖顯示 |
| Rect | 帶有背景、邊框、陰影的容器 |
| Items | 以陣列資料驅動的列表或網格 |
| Slideshow | 具轉場效果的自動切換幻燈片 |
| Sketch (Preview) | 繪圖畫布,可復原/重做與匯出圖片 |
Generators
將您的應用程式連線至外部服務、硬體和 AI 模型的資料和 I/O 提供者。| 類別 | 範例 |
|---|---|
| AI & LLM | Assistant、LLM(GGML/OpenAI/Anthropic/ONNX)、Vector Store、Reranker |
| 語音 | Text-to-Speech、Speech-to-Text、VAD、Realtime Transcription |
| 網路 | HTTP、WebSocket、GraphQL、MQTT、TCP、UDP、HTTP Server |
| 儲存 | File、SQLite、Data Bank、Media Flow |
| 硬體 | Bluetooth LE、Serial Port、Camera、Keyboard |
| 控制流程 | Tick(計時器)、Alarm Clock、Step、Iterator、Watchdog |
| 其他 | WebRTC、Web Crawler、MCP、Thermal Printer |
資料和狀態
- 資料節點 —具有反應式資料繫結的型別化狀態儲存(字串、數字、布林值、陣列、物件)
- Data Calculation —在沙箱環境中執行的 JavaScript 函式,可轉換資料,內建 25 種以上函式庫
視覺和版面
- Canvas —使用框架座標定位項目的檢視版面,包含生命週期事件和 Canvas 切換
- Subspace —將 Brick、Generator、資料和 Canvas 整合為邏輯單元的功能容器
- Animation —3 種動畫類型(timing、spring、decay)、9 種可動畫屬性、10 種以上的緩動函式,以及組合動畫(parallel/sequence)
- 待機切換 —包含 5 種待機模式和共享元素切換的 Canvas 進入/離開動畫
動作和事件
- Actions —由 Brick 或 Generator 事件觸發的指令(Canvas 切換、資料更新、Generator 觸發、動畫)
- Events —由 Brick(按壓、長按)和 Generator(回應、錯誤、計時器觸發)發出的訊號
進階功能
- 自動化 —包含 3 種自動化類型、模擬動作和視覺回歸的 E2E 測試框架
- Local Sync —包含主/副裝置角色和執行模式的區域網路裝置同步
- Data Bank —帶有遠端更新類型和 REST API 存取的雲端資料同步
- Media Flow —帶有媒體框、影像處理和 CDN 傳遞的資產管理
- Buttress —帶有能力交換和策略選項的遠端 AI 推論卸載
使用參考文件
核心參考文件有兩種形式:| 來源 | 最適合 |
|---|---|
| BRICKS Controller 參考 | 使用 Config Editor 時的互動式瀏覽 |
| bricks-ctor 內建技能 | AI 輔助開發——技能為 AI 程式碼代理提供相同的領域知識 |