fastcs.cs_methods

Members

Command	A Controller Method that performs a single action when called.
CommandCallback	A Command callback that is bound and can be called without self
Controller_T	Generic Controller class that an unbound method must be called with as self
Method	Generic base class for all FastCS Controller methods.
MethodCallback	Generic base class for all Controller methods
PutCallback	A Put callback that is bound and can be called without self
Scan	A Controller Method that will be called periodically in the background.
ScanCallback	A Scan callback that is bound and can be called without self
UnboundCommand	A wrapper of an unbound Controller method to be bound into a Command.
UnboundCommandCallback	A Command callback that is unbound and must be called with a Controller instance
UnboundPutCallback	A Put callback that is unbound and must be called with a Controller instance
UnboundScan	A wrapper of an unbound Controller method to be bound into a Scan.
UnboundScanCallback	A Scan callback that is unbound and must be called with a Controller instance

fastcs.cs_methods.MethodCallback

Generic base class for all Controller methods

alias of Callable[[…], Coroutine[None, None, None]]

class fastcs.cs_methods.Controller_T

Generic Controller class that an unbound method must be called with as self

alias of TypeVar(‘Controller_T’, bound=BaseController)

fastcs.cs_methods.UnboundCommandCallback

A Command callback that is unbound and must be called with a Controller instance

alias of Callable[[Controller_T], Coroutine[None, None, None]]

fastcs.cs_methods.UnboundScanCallback

A Scan callback that is unbound and must be called with a Controller instance

alias of Callable[[Controller_T], Coroutine[None, None, None]]

fastcs.cs_methods.UnboundPutCallback

A Put callback that is unbound and must be called with a Controller instance

alias of Callable[[Controller_T, Any], Coroutine[None, None, None]]

fastcs.cs_methods.CommandCallback

A Command callback that is bound and can be called without self

alias of Callable[[], Coroutine[None, None, None]]

fastcs.cs_methods.ScanCallback

A Scan callback that is bound and can be called without self

alias of Callable[[], Coroutine[None, None, None]]

fastcs.cs_methods.PutCallback

A Put callback that is bound and can be called without self

alias of Callable[[Any], Coroutine[None, None, None]]

class fastcs.cs_methods.Method(fn: Callable[[...], Coroutine[None, None, None]], *, group: str | None = None)

Generic base class for all FastCS Controller methods.

class fastcs.cs_methods.Command(fn: Callable[[], Coroutine[None, None, None]], *, group: str | None = None)

A Controller Method that performs a single action when called.

This class contains a function that is bound to a specific Controller instance and is callable outside of the class context, without an explicit self parameter. Calling an instance of this class will call the bound Controller method.

class fastcs.cs_methods.Scan(fn: Callable[[], Coroutine[None, None, None]], period: float)

A Controller Method that will be called periodically in the background.

This class contains a function that is bound to a specific Controller instance and is callable outside of the class context, without an explicit self parameter. Calling an instance of this class will call the bound Controller method.

class fastcs.cs_methods.UnboundCommand(fn: Callable[[Controller_T], Coroutine[None, None, None]], *, group: str | None = None)

A wrapper of an unbound Controller method to be bound into a Command.

This generic class stores an unbound Controller method - effectively a function that takes an instance of a specific Controller type (Controller_T). Instances of this class can be added at Controller definition, either manually or with use of the command wrapper, to register the method to be included in the API of the Controller. When the Controller is instantiated, these instances will be bound to the instance, creating a Command instance.

class fastcs.cs_methods.UnboundScan(fn: Callable[[Controller_T], Coroutine[None, None, None]], period: float)

A wrapper of an unbound Controller method to be bound into a Scan.

This generic class stores an unbound Controller method - effectively a function that takes an instance of a specific Controller type (Controller_T). Instances of this class can be added at Controller definition, either manually or with use of the scan wrapper, to register the method to be included in the API of the Controller. When the Controller is instantiated, these instances will be bound to the instance, creating a Scan instance.