laborchestrator.sila_server.generated.simulationcontroller package

Submodules

Module contents

class laborchestrator.sila_server.generated.simulationcontroller.SimulationControllerBase(parent_server: Server)[source]

Bases: FeatureImplementationBase, ABC

abstractmethod StartRealMode(*, metadata: MetadataDict) → StartRealMode_Responses[source]

Sets the SiLA Server to run in real mode, i.e. all following commands are executed with real-world

interactions, like serial port/CAN communication, motor actions etc.

If the server is in Simulation Mode it can be interrupted at any time. A re-initialization of the hardware might be required. The Real Mode can be stopped by issuing the ‘Start Simulation Mode’ command.

param metadata:

The SiLA Client Metadata attached to the call

abstractmethod StartSimulationMode(*, metadata: MetadataDict) → StartSimulationMode_Responses[source]

Sets the SiLA Server to run in Simulation Mode, i.e. all following commands are executed in simulation mode.

The Simulation Mode can only be entered, if all hardware operations have been safely terminated or are in a controlled, safe state.

The simulation mode can be stopped by issuing the ‘Start Real Mode’ command.

param metadata:

The SiLA Client Metadata attached to the call

_abc_impl = <_abc._abc_data object>
abstractmethod get_SimulationMode(*, metadata: MetadataDict) → bool[source]

Indication whether SiLA Server is in Simulation Mode or not.

Parameters:

metadata – The SiLA Client Metadata attached to the call

Returns:

Indication whether SiLA Server is in Simulation Mode or not.

parent_server: Server

SiLA Server serving this feature implementation

class laborchestrator.sila_server.generated.simulationcontroller.SimulationControllerClient[source]

Bases: object

This Feature provides control over the simulation behaviour of a SiLA Server.

A SiLA Server can run in two modes: (a) Real Mode - with real activities, e.g. addressing or controlling real hardware, e.g. through serial/CANBus commands,

writing to real databases, moving real objects etc.

  1. Simulation Mode - where every command is only simulated and responses are just example returns.

Note that certain commands and properties might not be affected by this feature if they do not interact with the real world.

SimulationMode: ClientUnobservableProperty[bool]

Indication whether SiLA Server is in Simulation Mode or not.

StartRealMode(*, metadata: Iterable[ClientMetadataInstance] | None = None) → StartRealMode_Responses[source]

Sets the SiLA Server to run in real mode, i.e. all following commands are executed with real-world

interactions, like serial port/CAN communication, motor actions etc.

If the server is in Simulation Mode it can be interrupted at any time. A re-initialization of the hardware might be required. The Real Mode can be stopped by issuing the ‘Start Simulation Mode’ command.

StartSimulationMode(*, metadata: Iterable[ClientMetadataInstance] | None = None) → StartSimulationMode_Responses[source]

Sets the SiLA Server to run in Simulation Mode, i.e. all following commands are executed in simulation mode.

The Simulation Mode can only be entered, if all hardware operations have been safely terminated or are in a controlled, safe state.

The simulation mode can be stopped by issuing the ‘Start Real Mode’ command.

exception laborchestrator.sila_server.generated.simulationcontroller.StartRealModeFailed(message: str | None = None)[source]

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>
class laborchestrator.sila_server.generated.simulationcontroller.StartRealMode_Responses[source]

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}
_fields = ()
classmethod _make(iterable)

Make a new StartRealMode_Responses object from a sequence or iterable

_replace(**kwds)

Return a new StartRealMode_Responses object replacing specified fields with new values

exception laborchestrator.sila_server.generated.simulationcontroller.StartSimulationModeFailed(message: str | None = None)[source]

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>
class laborchestrator.sila_server.generated.simulationcontroller.StartSimulationMode_Responses[source]

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}
_fields = ()
classmethod _make(iterable)

Make a new StartSimulationMode_Responses object from a sequence or iterable

_replace(**kwds)

Return a new StartSimulationMode_Responses object replacing specified fields with new values