fastcs.transports.controller_api#

Members

ControllerAPI

Attributes, Methods and sub APIs of a Controller to expose in a transport
class fastcs.transports.controller_api.ControllerAPI(path: list[str] = <factory>, attributes: dict[str, ~fastcs.attributes.attribute.Attribute] = <factory>, command_methods: dict[str, ~fastcs.methods.command.Command] = <factory>, scan_methods: dict[str, ~fastcs.methods.scan.Scan] = <factory>, sub_apis: dict[str, ~fastcs.transports.controller_api.ControllerAPI] = <factory>, description: str | None = None)[source]#

Attributes, Methods and sub APIs of a Controller to expose in a transport

path: list[str]#

Path within controller tree (empty if this is the root)

sub_apis: dict[str, ControllerAPI]#

APIs of the sub controllers of the Controller this API was built from

walk_api() → Iterator[ControllerAPI][source]#

Walk through all the nested ControllerAPI s of this ControllerAPI.

Yields the ControllerAPI s from a depth-first traversal of the tree, including self.