# Coreflux Documentation

## Docs

- [AI-Assisted Development Best Practices](https://docs.coreflux.org/ai/best-practices.md): Set up your AI coding assistant to generate correct, consistent LoT code using AGENTS.md templates and project rules
- [Developing with LoT Using AI](https://docs.coreflux.org/ai/developing-with-lot.md): A beginner's guide to building IIoT solutions with LoT — let your AI assistant handle the syntax while you focus on what to build
- [Model Context Protocol (MCP)](https://docs.coreflux.org/ai/mcp.md): Connect AI assistants to the Coreflux knowledge base using the Model Context Protocol
- [AI Assistant](https://docs.coreflux.org/coreflux-hub/ai-assistant.md): Chat with the built-in Coreflux HUB assistant to get insights from live data, build dashboards, and develop LoT Actions using plain language
- [Dashboards in the HUB](https://docs.coreflux.org/coreflux-hub/dashboards.md): Build live dashboards for your broker data — gauges, charts, SCADA symbols, and controls, bound to MQTT topics, with no code
- [Editing LoT in the HUB](https://docs.coreflux.org/coreflux-hub/lot.md): Create and edit Actions, Models, and Rules in the Coreflux HUB without VS Code or external tools
- [Connected Clients](https://docs.coreflux.org/coreflux-hub/mqtt/connected-clients.md): View active MQTT client connections and their status in the Coreflux HUB
- [Data Viewer](https://docs.coreflux.org/coreflux-hub/mqtt/data-viewer.md): Subscribe to topics, view the topic tree, and publish messages from the Coreflux HUB
- [MQTT Overview](https://docs.coreflux.org/coreflux-hub/mqtt/overview.md): Browse topics, publish messages, and see who's connected — all from your Coreflux HUB
- [Coreflux HUB Overview](https://docs.coreflux.org/coreflux-hub/overview.md): Manage your Coreflux broker from the browser—explore MQTT topics, edit LoT code, configure routes, and monitor system health
- [Route Configuration](https://docs.coreflux.org/coreflux-hub/routes/configuration.md): Edit route configuration, events, mappings, and tags in Visual or LoT mode
- [Routes Monitoring](https://docs.coreflux.org/coreflux-hub/routes/monitoring.md): View real-time route status and logs — monitor connection health, message counts, and export logs
- [Routes Overview](https://docs.coreflux.org/coreflux-hub/routes/overview.md): Add, configure, and monitor Routes in the Coreflux HUB—view status, edit configuration, and inspect route logs
- [Broker Logs](https://docs.coreflux.org/coreflux-hub/system/broker-logs.md): View broker logs, filter by level and date, search, and export as JSON or LOG
- [Command Console](https://docs.coreflux.org/coreflux-hub/system/command-console.md): Execute broker commands directly from the Coreflux HUB
- [System Configuration](https://docs.coreflux.org/coreflux-hub/system/configuration.md): Edit broker settings, connection parameters, and configuration options in the Coreflux HUB
- [System Overview](https://docs.coreflux.org/coreflux-hub/system/overview.md): Broker administration, user management, command console, and broker logs
- [User Management](https://docs.coreflux.org/coreflux-hub/system/user-management.md): Create, edit, and delete broker users; manage credentials and access control
- [Welcome](https://docs.coreflux.org/index.md): Get, centralize, process, and send IoT data - all from one MQTT Broker with built-in LoT (Language of Things)
- [Action Triggers](https://docs.coreflux.org/lot-language/actions/events.md): Define when actions execute using time-based schedules (ON EVERY, ON TIMESTAMP), topic-based events, or manual invocation
- [Operations Reference](https://docs.coreflux.org/lot-language/actions/operations.md): Complete reference for LoT operations: variables, arithmetic, strings, RANDOM, transformations, and control flow
- [Actions Overview](https://docs.coreflux.org/lot-language/actions/overview.md): Learn how LoT Actions automate MQTT data processing with event-driven logic that runs inside the broker
- [Python Integration](https://docs.coreflux.org/lot-language/actions/python-integration.md): Extend LoT actions with Python functions for complex calculations and data processing
- [Actions Syntax Reference](https://docs.coreflux.org/lot-language/actions/syntax.md): Complete syntax reference for defining LoT actions - event-driven logic executed by the Coreflux MQTT broker
- [LoT Concepts](https://docs.coreflux.org/lot-language/concepts.md): Building blocks, naming conventions, topic architecture, and proven patterns for building maintainable LoT systems
- [Introduction to LoT](https://docs.coreflux.org/lot-language/introduction.md): Learn what LoT (Language of Things) is and see it in action with simple examples
- [Model Examples](https://docs.coreflux.org/lot-language/models/examples.md): Practical examples of LoT models for common IoT data structuring scenarios.
- [Model Inheritance](https://docs.coreflux.org/lot-language/models/model-inheritance.md): Create model families with shared fields using the FROM keyword for code reuse and consistency
- [Models Overview](https://docs.coreflux.org/lot-language/models/overview.md): Learn how LoT models transform, structure, and format MQTT data into consistent JSON schemas
- [Publishing Models](https://docs.coreflux.org/lot-language/models/publish-model.md): Create structured data dynamically from actions using COLLAPSED models and PUBLISH MODEL
- [Model Syntax and Components](https://docs.coreflux.org/lot-language/models/schema-definition.md): Complete reference for defining model schemas, field types, data sources, and triggers
- [AI Routes](https://docs.coreflux.org/lot-language/routes/ai-routes.md): Give your broker a built-in AI assistant that can read MQTT topics, call external tools, and run tasks — all defined in LoT
- [Data Pipeline Routes](https://docs.coreflux.org/lot-language/routes/data-pipeline-routes.md): Configure MQTT bridges for broker-to-broker communication and email notifications
- [CrateDB Route](https://docs.coreflux.org/lot-language/routes/data-storage/cratedb.md): Store MQTT data in CrateDB for distributed time-series analytics and SQL queries
- [File Storage Route](https://docs.coreflux.org/lot-language/routes/data-storage/file-storage.md): Store MQTT data to local CSV and JSON files for simple persistence and backups
- [MariaDB Route](https://docs.coreflux.org/lot-language/routes/data-storage/mariadb.md): Store MQTT data in MariaDB with automatic query execution and MySQL compatibility
- [MongoDB Route](https://docs.coreflux.org/lot-language/routes/data-storage/mongodb.md): Store MQTT data in MongoDB with flexible document schemas and CLEAN query format
- [MySQL Route](https://docs.coreflux.org/lot-language/routes/data-storage/mysql.md): Store MQTT data in MySQL with automatic query execution and SSL support
- [OpenSearch Route](https://docs.coreflux.org/lot-language/routes/data-storage/opensearch.md): Index MQTT data in OpenSearch for real-time search, analytics, and visualization
- [Data Storage Routes Overview](https://docs.coreflux.org/lot-language/routes/data-storage/overview.md): Store MQTT data in databases including PostgreSQL, MySQL, MongoDB, OpenSearch, Snowflake, and file storage
- [PostgreSQL Route](https://docs.coreflux.org/lot-language/routes/data-storage/postgresql.md): Store MQTT data in PostgreSQL with automatic query execution and SSL support
- [Snowflake Route](https://docs.coreflux.org/lot-language/routes/data-storage/snowflake.md): Store MQTT data in Snowflake cloud data warehouse for large-scale analytics
- [SQL Server Route](https://docs.coreflux.org/lot-language/routes/data-storage/sqlserver.md): Store MQTT data in Microsoft SQL Server with automatic query execution and enterprise features
- [Route Examples](https://docs.coreflux.org/lot-language/routes/examples.md): Complete examples of LoT route configurations for common integration scenarios
- [ADS Route (Beckhoff)](https://docs.coreflux.org/lot-language/routes/industrial/ads.md): Connect to Beckhoff TwinCAT PLCs using ADS protocol with AutoDiscovery and comprehensive data type support
- [Allen-Bradley Route](https://docs.coreflux.org/lot-language/routes/industrial/allen-bradley.md): Connect to Rockwell Automation Allen-Bradley PLCs including ControlLogix, CompactLogix, and MicroLogix
- [EtherNet/IP Route](https://docs.coreflux.org/lot-language/routes/industrial/ethernetip.md): Connect to Allen-Bradley PLCs and CIP-compatible devices using EtherNet/IP explicit messaging
- [FINS Route (Omron)](https://docs.coreflux.org/lot-language/routes/industrial/fins.md): Connect to Omron PLCs using FINS protocol with support for multiple memory areas and TCP/UDP transport
- [Modbus Serial Route](https://docs.coreflux.org/lot-language/routes/industrial/modbus-serial.md): Connect to PLCs and industrial devices using Modbus RTU over RS-232/RS-485 serial connections
- [Modbus TCP Route](https://docs.coreflux.org/lot-language/routes/industrial/modbus-tcp.md): Connect to PLCs and industrial devices using Modbus TCP protocol with TAG-based polling and automatic batch optimization
- [OPC UA Route](https://docs.coreflux.org/lot-language/routes/industrial/opcua.md): Connect to OPC UA servers for cross-platform industrial communication with comprehensive security options
- [Industrial Routes Overview](https://docs.coreflux.org/lot-language/routes/industrial/overview.md): Connect your Coreflux broker to PLCs, industrial controllers, and automation systems using industrial protocol routes
- [Siemens S7 Route](https://docs.coreflux.org/lot-language/routes/industrial/siemens-s7.md): Connect to Siemens S7-200, S7-300, S7-400, S7-1200, and S7-1500 PLCs using native S7 protocol
- [MCP Routes](https://docs.coreflux.org/lot-language/routes/mcp-routes.md): Connect your Coreflux broker to external tools and services through the Model Context Protocol (MCP)
- [Media Routes](https://docs.coreflux.org/lot-language/routes/media-routes.md): Process barcodes and video streams with encoding, decoding, and streaming capabilities
- [Routes Overview](https://docs.coreflux.org/lot-language/routes/overview.md): Connect your Coreflux broker to external systems, databases, industrial equipment, and other brokers using LoT routes
- [REST API Routes](https://docs.coreflux.org/lot-language/routes/rest-api-routes.md): Connect to external REST APIs or expose HTTP endpoints from your broker with client/server modes
- [System Routes](https://docs.coreflux.org/lot-language/routes/system-routes.md): Configure broker clustering and high-availability setups with MQTT_CLUSTER routes
- [Rules Overview](https://docs.coreflux.org/lot-language/rules/overview.md): Define access control, permissions, and governance rules for your MQTT infrastructure
- [Rules Syntax](https://docs.coreflux.org/lot-language/rules/syntax.md): Complete reference for LoT rule syntax, conditions, operation scopes, and access control patterns
- [How to Debug in LoT Notebooks](https://docs.coreflux.org/lot-notebooks/debug.md): Debug LoT and MQTT data with a Data Viewer and an Execution _Trace.
- [Tutorials](https://docs.coreflux.org/lot-notebooks/tutorials.md): Hands-on LoT Notebook tutorials covering Actions, Models, Routes, and Python integration.
- [How to Use a LoT Notebook](https://docs.coreflux.org/lot-notebooks/usage.md): Learn how to use LoT Notebooks to run, document and debug your LoT code.
- [Broker Commands](https://docs.coreflux.org/mqtt-broker/commands.md): Complete reference for Coreflux MQTT Broker commands
- [Broker Configuration](https://docs.coreflux.org/mqtt-broker/configuration.md): Complete guide to configuring the Coreflux MQTT Broker - ports, security, TLS, and deployment options
- [Coreflux MQTT Broker](https://docs.coreflux.org/mqtt-broker/overview.md): Introduction to the Coreflux MQTT Broker - the core component of your IoT platform.
- [MQTT Protocol](https://docs.coreflux.org/mqtt-broker/protocol.md): Understanding the MQTT protocol - the foundation of IoT communication.
- [Environment Variables & Secrets](https://docs.coreflux.org/mqtt-broker/secrets-and-env.md): Manage configuration, credentials, and sensitive data securely with environment variables and encrypted secrets
- [Startup Options & Deployment](https://docs.coreflux.org/mqtt-broker/startup-options.md): Configure broker startup with command-line options, deploy to containers, and install as a system service
- [System ($SYS) Topics](https://docs.coreflux.org/mqtt-broker/sys-topics.md): Complete reference for system topics - monitoring, configuration, and controlling the Coreflux MQTT Broker
- [Release Notes](https://docs.coreflux.org/product-updates/release-notes.md): Product releases for the Coreflux platform — LoT, HUB, VS Code extension, AI and others
- [Getting Started](https://docs.coreflux.org/quick-start/getting-started.md): Go from zero to your first working LoT Action in under 5 minutes.
- [Installation](https://docs.coreflux.org/quick-start/installation.md): Install Coreflux on your preferred platform - Docker, Windows, Linux, or Raspberry Pi.
- [Using AI with Coreflux](https://docs.coreflux.org/quick-start/using-ai.md): Go from installation to AI-generated LoT code in minutes — build Actions, Routes, and documentation with natural language prompts.
- [Using Coreflux HUB](https://docs.coreflux.org/quick-start/using-hub.md): Access the Coreflux HUB in your browser and manage your broker — MQTT topics, LoT code, routes, and system settings in one place.
- [Using LoT Notebooks](https://docs.coreflux.org/quick-start/vscode.md): Use LoT Notebooks as living documentation—run LoT code, document your project, and see MQTT data all in one place.

## OpenAPI Specs

- [openapi](https://docs.coreflux.org/api-reference/openapi.json)