Smart Assistant
Build and diagnose configuration with a single natural-language prompt.
Prefer a guided tutorial?
Follow the Configure with the Smart Assistant hands-on tutorial, then return here for the full reference.
The Smart Assistant is a natural-language assistant that turns a single prompt into a complete, working ControlBird configuration. Instead of clicking through builders by hand, you describe what you want, "Create a status card for my pump", "Provision a Modbus thermostat", "Why is this entity in an error state?", and the assistant generates the configuration, installs extensions, or walks the entity tree to diagnose the problem. It can author rule chains, configure dashboards, provision devices, and run troubleshooting diagnostics.
Sessions are durable
The assistant streams its reply back to the UI as it is generated, and every message and tool call is saved as part of the conversation, so sessions survive reconnects like any other ControlBird data.
What the Assistant Can Do
The assistant converts intent into action through a set of built-in tools. Its core capabilities fall into a few groups:
- Configuration generation, single-prompt recipes that assemble complete configurations from a plain-language description.
- Rule chain authoring, accepts a graph definition, validates it, and feeds validation errors back to itself to fix.
- Dashboard cards, creates button, toggle, slider, gauge, entity-state, and chart cards interactively.
- Device provisioning, builds controller → endpoint → mapper → value chains through the device-manager.
- Visual builders, configures faceplates, schematics, and models, including attaching interaction handlers.
- Extension lifecycle, browses the catalog and installs extensions behind an approval gate.
- Diagnostics, walks entity health chains, resolves error fields, queries service status and logs, and analyzes historian data.
- Image-to-configuration, accepts an uploaded drawing or sketch and converts it into configuration.
Configuring a Provider
Before sending prompts, configure at least one model provider through the provider settings dialog. ControlBird supports multiple model backends, each with its own credentials, model, and generation parameters.
| Provider | Notes |
|---|---|
| Anthropic | e.g. model claude-sonnet-4-20250514 |
| OpenAI | Standard OpenAI chat models |
| Ollama | Self-hosted local models via a base URL |
| GLM | GLM-family models |
| Custom | Any compatible HTTP endpoint, set the base URL |
Provider settings
| Setting | Default | Description |
|---|---|---|
| Provider | required | Anthropic, OpenAI, Ollama, GLM, or Custom |
| API key | required | Provider API credential |
| Model | required | Model identifier |
| Base URL | optional | Override endpoint (required for Ollama and Custom) |
| Max tokens | 2048 | Maximum tokens per response |
| Temperature | 0.3 | Sampling temperature |
| System prompt | optional | Custom instruction override |
| Role | optional | Role context for the assistant |
A Refresh models action re-fetches the list of models available from the selected provider.
Custom instruction safety
Custom system instructions are length-limited. Keep them focused: the assistant already carries extensive built-in ControlBird domain knowledge.
The Conversation Workflow
A typical session follows the same lifecycle from open to completion:
- Open the Smart Assistant app. It loads the provider list and your existing sessions.
- Configure a provider (provider, API key, model, optional system prompt).
- Create or select a session.
- Type a prompt (optionally with attached images) and press Enter.
- The assistant interprets your request and carries out the necessary actions in sequence, collecting results along the way.
- If an action needs approval, the assistant raises an approval request and the session enters a waiting-for-approval state.
- The response streams in live as the UI updates, and the final message is added to the session history.
- On completion the session returns to idle, or to an error state with the message surfaced as an error banner.
The Assistant's Tools
The assistant draws on a range of tools covering configuration generation, rule-chain authoring, dashboard cards, device provisioning, visual builders, extension lifecycle, and diagnostics. The most relevant tools for a given conversation are made available as it progresses, so the assistant always has the capabilities it needs for the task at hand.
Rule chain authoring
The assistant can author rule chains from a description, validate them, and correct any validation errors it finds. Rule chains authored by the assistant are runnable immediately, the same as those you build by hand in the Rule Chain Editor.
Approval Workflow
Operations that change your configuration are approval-gated. When one is requested, the assistant pauses and raises an approval request with a risk explanation. The session waits until you approve or reject the request before the operation runs.
| Operation | Gated? | Why |
|---|---|---|
| Browse the extension catalog | No | Read-only catalog and README fetch |
| Install an extension | Yes | Installs an extension and runs its provisioning steps |
| Provision devices, endpoints, or points | Yes | Provisions hardware-facing configuration |
| Patch existing configuration | Yes | Mutates existing configuration |
Always review the risk explanation
Approving an extension install applies changes to your configuration and runs the extension's provisioning steps. Read the risk explanation before approving, with the same caution you apply when installing from the Extension Marketplace by hand.
Working With Images
You can attach a PNG or JPG to a prompt by pasting or dragging it into the input, and the assistant uses it along with your text. This powers the From Drawing workflow: sketch a layout and let the assistant convert it into a configuration.
Sessions
Sessions are durable, so you can create multiple sessions, rename them, and delete old ones. Selecting a session reloads its message history and resumes live streaming. Each session retains a recent window of messages, and inactive sessions are cleaned up automatically after a period of inactivity.
The Smart Assistant App
The interface opens to an empty state with suggested prompts that steer you toward common tasks, including Status Card, Gauge Display, Faceplate, Schematic, and From Drawing. The sidebar collapses on small screens with a tappable backdrop and touch-optimized targets.
Keyboard shortcuts
| Shortcut | Action |
|---|---|
| Ctrl+N | New session |
| Ctrl+, | Toggle sidebar |
| ? | Show help |
| Esc | Clear input |
Start with a suggested prompt
If you are new to the Smart Assistant, pick a suggested prompt from the empty state. It demonstrates a complete build, card, gauge, faceplate, or schematic, that you can then adapt with a follow-up message in the same session.