Reference

Precise lookup material for Sardana: the command line tools, catalogs of macros and environment variables, the plugin and library APIs, the Tango interface and configuration settings, migration guides and design records. For learning material see the tutorials, for recipes the how-to guides, for background the explanations, and for release notes and built documentation of other versions the news and releases section.

Command line tools

• Command line tools – the executables installed by Sardana and the sardanactl subcommands.

Macros

• Standard macro catalog – catalog of the standard macros shipped with Sardana.

• Macro API reference – the macro API: classes, decorators and parameter types used to write and run macros.

Plugin APIs

• Controller API reference – the controller plugin API: base classes, axis/controller parameters and data types.

• Recorder API – the recorder plugin API: base classes for writing scan data recorders.

Element APIs

Attribute-by-attribute reference of each Sardana element type:

• Motor API reference – motor element (state, position, velocity, limits…).

• I/O register API reference – input/output register element.

• Counter/Timer API reference – counter/timer experiment channel.

• 0D channel API reference – 0D experiment channel.

• 1D channel API reference – 1D experiment channel.

• 2D channel API reference – 2D experiment channel.

• Trigger/Gate API reference – trigger/gate synchronizer element.

• Pseudo motor API reference – pseudo motor element.

• Pseudo counter API reference – pseudo counter element.

• Measurement group API reference – measurement group element.

• MacroServer API reference – MacroServer and Door elements.

• Pool API reference – Device Pool element.

Python library

• Python API overview – curated overview of the public Python APIs.

• Python package reference – exhaustive sardana package and module reference, browsable directly.

• sardana – Sardana-Taurus model API (Taurus extensions for Sardana devices).

• sardana – Sardana-Taurus Qt model API.

• Sardana test API – test framework utilities and base classes.

Tango interface

• Device Pool Tango API – reference of the Sardana Tango device classes: their attributes, commands and properties.

Configuration

• Configuration – configuration reference: Sardana custom settings and pointers to the Tango device properties.

• Environment Variable Catalog – catalog of the environment variables recognized by Sardana macros and scans.

Project records

• Sardana migration guide – how to migrate Sardana systems and plugins between API versions.

• Sardana Enhancement Proposals – Sardana Enhancement Proposals (design documents).