API Reference

Formal reference for the surfaces external authors use when extending Lightfall: plugin base classes, the panel framework, plan authoring, and the visualization contract.

Pages combine hand-written reference tables (verified against the source in src/lightfall/) with autodoc listings generated from docstrings.

API Reference

Map of the reference

Page

Covers

Key classes

Plugin Types

The plugin system: base class, all plugin-type contracts, manifest registration

PluginType, AgentPlugin, PanelPlugin, PlanPlugin, SettingsPlugin, ControllerPlugin, EnginePlugin, StatusBarPlugin, ThemePlugin, PluginManifest, PluginEntry

Panels

The panel framework: metadata, lifecycle, title-bar injection, introspection

BasePanel, PanelMetadata, PanelStatus, PanelRegistry

Plans

Plan authoring: registry, parameter introspection, UI annotations, user plans, embedded plan UIs

PlanRegistry, PlanInfo, ParameterInfo, Unit/Range/DeviceFilter, plan_with_ui

Visualization

The visualization widget contract and selection flow

BaseVisualization, VisualizationRegistry

For tutorials and step-by-step guides, see the plugin developer guide. This section is the reference companion: exact members, signatures, and contracts.

Stability

Lightfall is pre-1.0. No formal API stability guarantee exists yet, but the classes documented here are the de-facto stable authoring surface: they are what the built-in plugins, panels, and plans are written against, and what external packages (beamline plugin distributions) import. Changes to these classes are deliberate and recorded in the changelog. Internal modules not listed here may change without notice.