ControlBird Documentation
Everything you need to deploy, configure, and integrate ControlBird.
Getting Started
Deploy your first ControlBird node and connect a device step by step.
How-To Walkthroughs
Short, task-focused tutorials for getting things done with each tool.
- Build a ModelDesign a reusable, data-bound model from scratch
- Query Live Data with SQLRun your first SQL query over the built-in SQL endpoint
- Install an ExtensionAdd a prebuilt integration from the marketplace
- Configure with the Smart AssistantBuild config from a natural-language prompt
- Secure a Connection with TLSCreate and apply a certificate to a connection
- Define a Custom Entity TypeAdd new entity types and fields to the data model
- Inspect the Store from the ShellUse cb-cli, cb-tree, and cb-select in the browser Shell
Extension Catalog
Browse every protocol, integration, and service you can install.
Concepts
Understand the architecture and mental models behind ControlBird.
- Architecture OverviewThe Store, entities, field types, and how they fit together
- Data ModelHierarchical entity tree, schemas, and field inheritance
- Notifications & ReactivityHow changes propagate through the system in real time
- Security & Access ControlRoles, permissions, sessions, and authentication
- Editions: Cloud vs CECompare managed Cloud and self-hosted Community Edition
Platform Guides
In-depth references for the built-in apps and tools.
- Device ManagerIntegrate devices and generate protocol config from a guided UI
- Secure Remote Access (VPN)Reach a node and remote devices over your own Tailscale network
- Model BuilderDesign reusable data models and structure the entity tree
- Database Browser & SQLQuery live entity data with PostgreSQL-compatible SQL
- Extension MarketplaceInstall, version, and manage integration extensions
- Smart AssistantBuild and diagnose configuration from natural language
- Schema EditorInspect and customize entity schemas and fields
- Certificate ManagerManage TLS certificates for secure connections
- Shell & CLI ToolsInspect the Store with cb-cli, cb-tree, and cb-select
- Automation RulesReact to data changes with visual rule chains
- HistorianStore and query time-series history for any field
- AlarmsDetect, annunciate, and acknowledge alarm conditions
- DashboardsCompose operator interfaces with live widgets
- Logs & DiagnosticsMonitor service health and troubleshoot communications
- Configuration ManagementVersion-control schemas and the entity tree
- Kiosk & Location DisplaysDeploy dedicated displays with auto-login
- Themes & White-LabelingPersonalize the interface and apply your branding
- Audio OutputPlay browser or server audio for annunciation
- SMTP & Email AlertsSend email notifications when values change
- Scaling & Multi-NodeDeploy additional nodes and keep data in sync
- Fault ToleranceAutomatic failover via leader election and standby nodes
- Cloud ManagementOrganize environments and provision cloud nodes
Protocol Guides
Integration guides for connecting industrial and IoT devices.
- Modbus TCP/RTUConnect PLCs, drives, and sensors over Modbus
- MQTTSubscribe to topics and map payloads to entities
- OPC UABrowse and subscribe to OPC UA servers
- BACnetIntegrate building automation over BACnet/IP and MS/TP
- DNP3Connect SCADA RTUs and outstations over DNP3
- EtherNet/IPRead and write tags on Allen-Bradley and CIP devices
- More Protocols & DiscoveryHTTP, CoAP, NATS, BLE, and network discovery
API Reference
Access the ControlBird Store and Historian from Script Engine JavaScript.