Python API overview

Use this page to find Sardana’s public extension and integration APIs by purpose. For the exhaustive package and module tree, see the Python package reference.

Extension APIs

• Macro API – classes, decorators and parameter types for writing macros.

• Controller API – controller base classes, parameters and data types.

• Recorder API – interfaces for writing scan data recorders.

Element APIs

• Motor

• I/O register

• Counter/timer

• 0D experiment channel

• 1D experiment channel

• 2D experiment channel

• Trigger/gate

• Pseudo motor

• Pseudo counter

• Measurement group

• MacroServer

• Pool

Client integration APIs

• Sardana-Taurus model API

• Sardana-Taurus Qt model API

Testing and implementation details

• Test API – test framework utilities and base classes.

• Python package reference – packages, modules and links to their implementation source.