Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.coreflux.org/llms.txt

Use this file to discover all available pages before exploring further.

​
After Hello World, What’s Next?

Once you’ve followed Getting Started and have Coreflux, VS Code, and your first Action running, the question becomes how to grow: naming topics, handling JSON, scaling Actions, wiring integrations, and shipping systems that stay maintainable. Experienced teams reuse the same patterns across factories, buildings, energy sites, and fleets—only the topics and payloads change.
Like learning chords before writing songs. Your first Action proves the broker runs your logic; patterns teach you how dozens of Actions, Models, and Routes fit together without turning into spaghetti.

​
How Are Best Practices & Patterns Organized

Chapters below live under Best Practices and Usage Patterns in the sidebar. Pick one based on what you’re building — each page focus on a set of tips for a given topic. Start with Naming conventions and finish with Anti-patterns when reviewing code.

Naming conventions

PascalCase entities, snake_case variables, and topic naming basics.

Designing your data layer (the foundation)

Topic trees (UNS), scalar vs JSON payloads, Models, and inheritance — how data is shaped and addressed.

Working with JSON

GET JSON in Actions, nested payloads, and publishing structured output through Models.

Writing reusable logic (the building blocks)

Callable actions, wildcards, counting over time, and Python — techniques for the Action you are writing now; logic that scales and stays maintainable.

Alarms and monitoring

Threshold crossings and device or route offline detection; optional email routes alongside alarms.

Connecting to the outside world (integrations)

REST server and client, live KPIs from a database, and ENV / Secrets — Routes that bridge to non-MQTT systems.

Production architecture

End-to-end device-to-database ingestion and edge–cloud bridges — synthesis patterns that build on everything before.

Project organization

Keeping notebooks clean and readable — single-file vs multi-file layouts and shared discipline at every stage.

Anti-patterns

Common LoT mistakes and what to do instead.

​
Next Steps

Introduction to LoT

Building blocks and how Actions, Models, Routes, and Rules fit together.

Model Inheritance

Deep dive on FROM and base models.
New to the language? Introduction to LoT links Actions, Models, Routes, and Rules from one page.
Last modified on May 20, 2026