> ## 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.

# Core reference

> Detailed reference for bricks, generators, data, animations, and all BRICKS platform entities

BRICKS Controller includes a built-in reference guide that documents every entity, property, and configuration option available when building applications. Access it directly in your browser:

<Card title="Open core reference" icon="book" href="https://control.bricks.tools/#/help?key=ROOT">
  Browse the full reference at control.bricks.tools
</Card>

## What's in the reference

The core reference covers every building block of the BRICKS platform in detail. Use it alongside the [Config Editor](/controller/config-editor) or [bricks-ctor](/ctor-pkg) when you need specific property documentation.

### Bricks

UI components that display content and handle interaction.

| Brick                | Purpose                                                                        |
| -------------------- | ------------------------------------------------------------------------------ |
| **Text**             | Display text with styling                                                      |
| **TextInput**        | Editable text field                                                            |
| **RichText**         | Rich text with HTML content, multiple fonts, and inline images                 |
| **Image**            | Display images                                                                 |
| **Video**            | Video playback                                                                 |
| **VideoStreaming**   | RTSP / RTMP live video streams                                                 |
| **WebrtcStream**     | WebRTC video and audio stream                                                  |
| **GenerativeMedia**  | AI-generated images and videos                                                 |
| **WebView**          | Embedded web content                                                           |
| **Lottie**           | `.json` and `.dotlottie` animations with speed, loop, and frame range control  |
| **Rive**             | `.riv` animations with state machine inputs, text runs, and artboard selection |
| **Svg**              | SVG vector graphics                                                            |
| **Chart**            | Data visualizations                                                            |
| **Icon**             | FontAwesome 6 Pro icons                                                        |
| **QrCode**           | QR code display                                                                |
| **Camera**           | Live camera feed                                                               |
| **Maps**             | Map display                                                                    |
| **Rect**             | Container with background, border, shadow                                      |
| **Items**            | Data-driven list or grid from an array                                         |
| **Slideshow**        | Auto-advancing slides with transition effects                                  |
| **Sketch** (Preview) | Drawing canvas with undo/redo and image export                                 |

Each brick has properties for styling, positioning, data binding, press events, and animations. See the [core reference](https://control.bricks.tools/#/help?key=ROOT) for full property documentation.

### Generators

Data and I/O providers that connect your app to external services, hardware, and AI models.

| Category         | Examples                                                            |
| ---------------- | ------------------------------------------------------------------- |
| **AI & LLM**     | Assistant, LLM (GGML/OpenAI/Anthropic/ONNX), Vector Store, Reranker |
| **Speech**       | Text-to-Speech, Speech-to-Text, VAD, Realtime Transcription         |
| **Network**      | HTTP, WebSocket, GraphQL, MQTT, TCP, UDP, HTTP Server               |
| **Storage**      | File, SQLite, Data Bank, Media Flow                                 |
| **Hardware**     | Bluetooth LE, Serial Port, Camera, Keyboard                         |
| **Control flow** | Tick (timer), Alarm Clock, Step, Iterator, Watchdog                 |
| **Other**        | WebRTC, Web Crawler, MCP, Thermal Printer                           |

Each generator has configurable properties, outlets (output channels), and events. See the [core reference](https://control.bricks.tools/#/help?key=ROOT) for full configuration options.

### Data and state

* **Data nodes** — Typed state storage (string, number, boolean, array, object) with reactive data binding
* **Data calculations** — JavaScript functions that transform data, running in a sandboxed environment with 25+ built-in libraries

### Visual and layout

* **Canvases** — View layouts that position items using frame coordinates, with lifecycle events and canvas switching
* **Subspaces** — Feature containers that group bricks, generators, data, and canvases into logical units
* **Animations** — 3 animation types (timing, spring, decay), 9 animatable properties, 10+ easing functions, and composed animations (parallel/sequence)
* **Standby transitions** — Canvas enter/exit animations with 5 standby modes and shared element transitions

### Actions and events

* **Actions** — Commands triggered by brick or generator events (canvas switching, data updates, generator triggers, animations)
* **Events** — Signals emitted by bricks (press, long press) and generators (response, error, timer tick)

### Advanced features

* **[Automations](/foundation/automations)** — E2E testing framework with 3 automation types, simulation actions, and visual regression
* **[Local sync](/foundation/local-sync)** — LAN device synchronization with main/minor device roles and run modes
* **[Data Bank](/controller/data-bank)** — Cloud data sync with remote update types and REST API access
* **[Media Flow](/controller/media)** — Asset management with media boxes, image processing, and CDN delivery
* **Buttress** — Remote AI inference offloading with capability exchange and strategy options

## Using the reference

The core reference is available in two forms:

| Source                                                                      | Best for                                                                                   |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| [BRICKS Controller reference](https://control.bricks.tools/#/help?key=ROOT) | Interactive browsing while using the Config Editor                                         |
| [bricks-ctor built-in skill](/ctor-pkg/skills)                              | AI-assisted development — the skill provides the same domain knowledge to AI coding agents |