hardware.v1

zen_api.hardware.v1

Classes:

• AxisIdentifier –

  Unique identifier for axis.

• StageMotionState –

  Stage motion state for ZenApi.

• StageState –

  Stage state for ZenApi.

• StageAxis –

  Abstract representation of an arbitrary axis.

• SimpleStageServiceGetAccelerationRequest –

  The SimpleStageServiceGetAccelerationRequest class.

• SimpleStageServiceGetAccelerationResponse –

  Acceleration of the stage.

• SimpleStageServiceGetPositionRequest –

  The SimpleStageServiceGetPositionRequest class.

• SimpleStageServiceGetPositionResponse –

  Position of the stage.

• SimpleStageServiceGetSpeedRequest –

  The SimpleStageServiceGetSpeedRequest class.

• SimpleStageServiceGetSpeedResponse –

  Speed of the stage.

• SimpleStageServiceMoveToRequest –

  The SimpleStageServiceMoveToRequest class.

• SimpleStageServiceMoveToResponse –

  Describes the result of a Stage.MoveTo request.

• SimpleStageServiceSetAccelerationRequest –

  The SimpleStageServiceSetAccelerationRequest class.

• SimpleStageServiceSetAccelerationResponse –

  The SimpleStageServiceSetAccelerationResponse class.

• SimpleStageServiceSetSpeedRequest –

  The SimpleStageServiceSetSpeedRequest class.

• SimpleStageServiceSetSpeedResponse –

  The SimpleStageServiceSetSpeedResponse class.

• SimpleStageServiceStopRequest –

  The SimpleStageServiceStopRequest class.

• SimpleStageServiceStopResponse –

  The SimpleStageServiceStopResponse class.

• StageServiceAxisVelocityResponse –

  Abstract representation of an arbitrary axis and it's velocity.

• StageServiceGetAvailableStageAxisRequest –

  The StageServiceGetAvailableStageAxisRequest class.

• StageServiceGetAvailableStageAxisResponse –

  Response object of available stage axis.

• StageServiceGetAxisPositionRequest –

  The StageServiceGetAxisPositionRequest class.

• StageServiceGetAxisPositionResponse –

  Abstract representation of an arbitrary axis.

• StageServiceGetAxisVelocityRequest –

  The StageServiceGetAxisVelocityRequest class.

• StageServiceGetAxisVelocityResponse –

  Abstract representation of an arbitrary axis and it's velocity.

• StageServiceGetStageMotionStateRequest –

  The StageServiceGetStageMotionStateRequest class.

• StageServiceGetStageMotionStateResponse –

  StageMotionState enum response.

• StageServiceGetStagePositionRequest –

  The StageServiceGetStagePositionRequest class.

• StageServiceGetStagePositionResponse –

  Response object of stage axis positions.

• StageServiceGetStageStateRequest –

  The StageServiceGetStageStateRequest class.

• StageServiceGetStageStateResponse –

  StageState enum response.

• StageServiceGetStageVelocityRequest –

  The StageServiceGetStageVelocityRequest class.

• StageServiceGetStageVelocityResponse –

  Response object of stage axis velocities.

• StageServiceInitializeStageRequest –

  The StageServiceInitializeStageRequest class.

• StageServiceInitializeStageResponse –

  Response object of the initialize stage method.

• StageServiceMoveToRequest –

  The StageServiceMoveToRequest class.

• StageServiceMoveToResponse –

  Response object of the MoveStage method.

• StageServiceRegisterOnStageMotionStateChangedRequest –

  The StageServiceRegisterOnStageMotionStateChangedRequest class.

• StageServiceRegisterOnStageMotionStateChangedResponse –

  StageMotionState enum response.

• StageServiceRegisterOnStagePositionChangedRequest –

  The StageServiceRegisterOnStagePositionChangedRequest class.

• StageServiceRegisterOnStagePositionChangedResponse –

  Abstract representation of an arbitrary axis.

• StageServiceRegisterOnStageStateChangedRequest –

  The StageServiceRegisterOnStageStateChangedRequest class.

• StageServiceRegisterOnStageStateChangedResponse –

  StageState enum response.

• StageServiceRegisterOnStageVelocityChangedRequest –

  The StageServiceRegisterOnStageVelocityChangedRequest class.

• StageServiceRegisterOnStageVelocityChangedResponse –

  Abstract representation of an arbitrary axis and it's velocity.

• StageServiceStopRequest –

  The StageServiceStopRequest class.

• StageServiceStopResponse –

  The StageServiceStopResponse class.

AxisIdentifier

Bases: Enum

Unique identifier for axis.

Attributes:

• UNSPECIFIED –

  Default enum value.

• X –

  X axis (translation axis).

• Y –

  Y axis (translation axis).

• Z –

  Z axis (translation axis).

• R –

  R axis (rotation axis).

• T –

  T axis (rotation axis).

• M –

  M axis (translation axis).

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

X class-attribute instance-attribute

X = 1

X axis (translation axis). Controlled by length, default unit is meters.

Y class-attribute instance-attribute

Y = 2

Y axis (translation axis). Controlled by length, default unit is meters.

Z class-attribute instance-attribute

Z = 3

Z axis (translation axis). Controlled by length, default unit is meters.

R class-attribute instance-attribute

R = 4

R axis (rotation axis). Controlled by angle, default unit is radians.

T class-attribute instance-attribute

T = 5

T axis (rotation axis). Controlled by angle, default unit is radians.

M class-attribute instance-attribute

M = 6

M axis (translation axis). Controlled by length, default unit is meters.

StageMotionState

Bases: Enum

Stage motion state for ZenApi.

Attributes:

• UNSPECIFIED –

  Default enum value.

• UNKNOWN –

  Should not occur in a well configured system.

• ERROR –

  The stage cannot perform any task. Software restart and/or physical intervention is required.

• IDLE –

  The stage is not moving.

• MOVING –

  The stage is in motion.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

UNKNOWN class-attribute instance-attribute

UNKNOWN = 1

Should not occur in a well configured system.

ERROR class-attribute instance-attribute

ERROR = 2

The stage cannot perform any task. Software restart and/or physical intervention is required.

IDLE class-attribute instance-attribute

IDLE = 3

The stage is not moving.

MOVING class-attribute instance-attribute

MOVING = 4

The stage is in motion.

StageState

Bases: Enum

Stage state for ZenApi.

Attributes:

• UNSPECIFIED –

  Default enum value.

• UNKNOWN –

  Should not occur in a well configured system.

• ERROR –

  The stage cannot perform any task. Software restart and/or

• NORMAL –

  The state is functioning normally and can be used.

• INITIALIZING –

  The stage is in the process of reinitializing one or more axes, should not be used, and will

• INITIALIZATION_NEEDED –

  The stage will respond to motion commands, but positions may be reported erroneously,

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

UNKNOWN class-attribute instance-attribute

UNKNOWN = 1

Should not occur in a well configured system.

ERROR class-attribute instance-attribute

ERROR = 2

The stage cannot perform any task. Software restart and/or physical intervention is required.

NORMAL class-attribute instance-attribute

NORMAL = 3

The state is functioning normally and can be used.

INITIALIZING class-attribute instance-attribute

INITIALIZING = 4

The stage is in the process of reinitializing one or more axes, should not be used, and will ignore value sets and commands other than stop.

INITIALIZATION_NEEDED class-attribute instance-attribute

INITIALIZATION_NEEDED = 5

The stage will respond to motion commands, but positions may be reported erroneously, and the stage should be initialized before further use.

StageAxis dataclass

StageAxis(axis: AxisIdentifier = betterproto.enum_field(1), position: float = betterproto.double_field(2))

Bases: Message

Abstract representation of an arbitrary axis.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• position (float) –

  The position of the axis in meters or radians.

axis class-attribute instance-attribute

axis: AxisIdentifier = enum_field(1)

The axis identifier.

position class-attribute instance-attribute

position: float = double_field(2)

The position of the axis in meters or radians.

SimpleStageServiceGetAccelerationRequest dataclass

SimpleStageServiceGetAccelerationRequest()

Bases: Message

The SimpleStageServiceGetAccelerationRequest class.

SimpleStageServiceGetAccelerationResponse dataclass

SimpleStageServiceGetAccelerationResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Acceleration of the stage.

Attributes:

• x (float) –

  The X component of the acceleration in %.

• y (float) –

  The Y component of the acceleration in %.

x class-attribute instance-attribute

x: float = double_field(1)

The X component of the acceleration in %.

y class-attribute instance-attribute

y: float = double_field(2)

The Y component of the acceleration in %.

SimpleStageServiceGetPositionRequest dataclass

SimpleStageServiceGetPositionRequest()

Bases: Message

The SimpleStageServiceGetPositionRequest class.

SimpleStageServiceGetPositionResponse dataclass

SimpleStageServiceGetPositionResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Position of the stage.

Attributes:

• x (float) –

  The X component of the position in meters.

• y (float) –

  The Y component of the position in meters.

x class-attribute instance-attribute

x: float = double_field(1)

The X component of the position in meters.

y class-attribute instance-attribute

y: float = double_field(2)

The Y component of the position in meters.

SimpleStageServiceGetSpeedRequest dataclass

SimpleStageServiceGetSpeedRequest()

Bases: Message

The SimpleStageServiceGetSpeedRequest class.

SimpleStageServiceGetSpeedResponse dataclass

SimpleStageServiceGetSpeedResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Speed of the stage.

Attributes:

• x (float) –

  The X component of the speed in %.

• y (float) –

  The Y component of the speed in %.

x class-attribute instance-attribute

x: float = double_field(1)

The X component of the speed in %.

y class-attribute instance-attribute

y: float = double_field(2)

The Y component of the speed in %.

SimpleStageServiceMoveToRequest dataclass

SimpleStageServiceMoveToRequest(x: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), y: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The SimpleStageServiceMoveToRequest class.

Attributes:

• x (Optional[float]) –

  Target position x in meters. Leave out if x position should not be changed.

• y (Optional[float]) –

  Target position y in meters. Leave out if y position should not be changed.

x class-attribute instance-attribute

x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)

Target position x in meters. Leave out if x position should not be changed.

y class-attribute instance-attribute

y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

Target position y in meters. Leave out if y position should not be changed.

SimpleStageServiceMoveToResponse dataclass

SimpleStageServiceMoveToResponse(position_changed: bool = betterproto.bool_field(1))

Bases: Message

Describes the result of a Stage.MoveTo request.

Attributes:

• position_changed (bool) –

  A value indicating whether the position was changed.

position_changed class-attribute instance-attribute

position_changed: bool = bool_field(1)

A value indicating whether the position was changed.

SimpleStageServiceSetAccelerationRequest dataclass

SimpleStageServiceSetAccelerationRequest(acceleration_x: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), acceleration_y: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The SimpleStageServiceSetAccelerationRequest class.

Attributes:

• acceleration_x (Optional[float]) –

  Acceleration in x direction in percent, i.e. values from range [0;100].

• acceleration_y (Optional[float]) –

  Acceleration in y direction in percent, i.e. values from range [0;100].

acceleration_x class-attribute instance-attribute

acceleration_x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)

Acceleration in x direction in percent, i.e. values from range [0;100].

acceleration_y class-attribute instance-attribute

acceleration_y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

Acceleration in y direction in percent, i.e. values from range [0;100].

SimpleStageServiceSetAccelerationResponse dataclass

SimpleStageServiceSetAccelerationResponse()

Bases: Message

The SimpleStageServiceSetAccelerationResponse class.

SimpleStageServiceSetSpeedRequest dataclass

SimpleStageServiceSetSpeedRequest(speed_x: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), speed_y: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The SimpleStageServiceSetSpeedRequest class.

Attributes:

• speed_x (Optional[float]) –

  Speed in x direction in percent, i.e. values from range [0;100].

• speed_y (Optional[float]) –

  Speed in y direction in percent, i.e. values from range [0;100].

speed_x class-attribute instance-attribute

speed_x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)

Speed in x direction in percent, i.e. values from range [0;100].

speed_y class-attribute instance-attribute

speed_y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

Speed in y direction in percent, i.e. values from range [0;100].

SimpleStageServiceSetSpeedResponse dataclass

SimpleStageServiceSetSpeedResponse()

Bases: Message

The SimpleStageServiceSetSpeedResponse class.

SimpleStageServiceStopRequest dataclass

SimpleStageServiceStopRequest()

Bases: Message

The SimpleStageServiceStopRequest class.

SimpleStageServiceStopResponse dataclass

SimpleStageServiceStopResponse()

Bases: Message

The SimpleStageServiceStopResponse class.

StageServiceAxisVelocityResponse dataclass

StageServiceAxisVelocityResponse(axis: AxisIdentifier = betterproto.enum_field(1), velocity: float = betterproto.double_field(2))

Bases: Message

Abstract representation of an arbitrary axis and it's velocity.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• velocity (float) –

  The velocity of the axis in meters per second or radians per second.

axis class-attribute instance-attribute

axis: AxisIdentifier = enum_field(1)

The axis identifier.

velocity class-attribute instance-attribute

velocity: float = double_field(2)

The velocity of the axis in meters per second or radians per second.

StageServiceGetAvailableStageAxisRequest dataclass

StageServiceGetAvailableStageAxisRequest()

Bases: Message

The StageServiceGetAvailableStageAxisRequest class.

StageServiceGetAvailableStageAxisResponse dataclass

StageServiceGetAvailableStageAxisResponse(available_axis: List[AxisIdentifier] = betterproto.enum_field(1))

Bases: Message

Response object of available stage axis.

StageServiceGetAxisPositionRequest dataclass

StageServiceGetAxisPositionRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))

Bases: Message

The StageServiceGetAxisPositionRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The requested axis.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = enum_field(1)

The requested axis.

StageServiceGetAxisPositionResponse dataclass

StageServiceGetAxisPositionResponse(axis: AxisIdentifier = betterproto.enum_field(1), position: float = betterproto.double_field(2))

Bases: Message

Abstract representation of an arbitrary axis.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• position (float) –

  The position of the axis in meters or radians.

axis class-attribute instance-attribute

axis: AxisIdentifier = enum_field(1)

The axis identifier.

position class-attribute instance-attribute

position: float = double_field(2)

The position of the axis in meters or radians.

StageServiceGetAxisVelocityRequest dataclass

StageServiceGetAxisVelocityRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))

Bases: Message

The StageServiceGetAxisVelocityRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The requested axis.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = enum_field(1)

The requested axis.

StageServiceGetAxisVelocityResponse dataclass

StageServiceGetAxisVelocityResponse(axis: AxisIdentifier = betterproto.enum_field(1), velocity: float = betterproto.double_field(2))

Bases: Message

Abstract representation of an arbitrary axis and it's velocity.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• velocity (float) –

  The velocity of the axis in meters per second or radians per second.

axis class-attribute instance-attribute

axis: AxisIdentifier = enum_field(1)

The axis identifier.

velocity class-attribute instance-attribute

velocity: float = double_field(2)

The velocity of the axis in meters per second or radians per second.

StageServiceGetStageMotionStateRequest dataclass

StageServiceGetStageMotionStateRequest()

Bases: Message

The StageServiceGetStageMotionStateRequest class.

StageServiceGetStageMotionStateResponse dataclass

StageServiceGetStageMotionStateResponse(state: StageMotionState = betterproto.enum_field(1))

Bases: Message

StageMotionState enum response.

Attributes:

• state (StageMotionState) –

  The available axis and their positions.

state class-attribute instance-attribute

state: StageMotionState = enum_field(1)

The available axis and their positions.

StageServiceGetStagePositionRequest dataclass

StageServiceGetStagePositionRequest()

Bases: Message

The StageServiceGetStagePositionRequest class.

StageServiceGetStagePositionResponse dataclass

StageServiceGetStagePositionResponse(axis_positions: List[StageAxis] = betterproto.message_field(1))

Bases: Message

Response object of stage axis positions.

Attributes:

• axis_positions (List[StageAxis]) –

  The available axis and their positions.

axis_positions class-attribute instance-attribute

axis_positions: List[StageAxis] = message_field(1)

The available axis and their positions.

StageServiceGetStageStateRequest dataclass

StageServiceGetStageStateRequest()

Bases: Message

The StageServiceGetStageStateRequest class.

StageServiceGetStageStateResponse dataclass

StageServiceGetStageStateResponse(state: StageState = betterproto.enum_field(1))

Bases: Message

StageState enum response.

Attributes:

• state (StageState) –

  The stage state.

state class-attribute instance-attribute

state: StageState = enum_field(1)

The stage state.

StageServiceGetStageVelocityRequest dataclass

StageServiceGetStageVelocityRequest()

Bases: Message

The StageServiceGetStageVelocityRequest class.

StageServiceGetStageVelocityResponse dataclass

StageServiceGetStageVelocityResponse(axis_velocities: List[StageServiceAxisVelocityResponse] = betterproto.message_field(1))

Bases: Message

Response object of stage axis velocities.

Attributes:

• axis_velocities (List[StageServiceAxisVelocityResponse]) –

  The available axis and their velocities.

axis_velocities class-attribute instance-attribute

axis_velocities: List[StageServiceAxisVelocityResponse] = message_field(1)

The available axis and their velocities.

StageServiceInitializeStageRequest dataclass

StageServiceInitializeStageRequest()

Bases: Message

The StageServiceInitializeStageRequest class.

StageServiceInitializeStageResponse dataclass

StageServiceInitializeStageResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of the initialize stage method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to initialize the stage succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to initialize the stage succeeded or not.

StageServiceMoveToRequest dataclass

StageServiceMoveToRequest(axis_to_move: List[StageAxis] = betterproto.message_field(1))

Bases: Message

The StageServiceMoveToRequest class.

Attributes:

• axis_to_move (List[StageAxis]) –

  The stage axis that should move.

axis_to_move class-attribute instance-attribute

axis_to_move: List[StageAxis] = message_field(1)

The stage axis that should move. The position is in meters.

StageServiceMoveToResponse dataclass

StageServiceMoveToResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of the MoveStage method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to move the stage succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to move the stage succeeded or not.

StageServiceRegisterOnStageMotionStateChangedRequest dataclass

StageServiceRegisterOnStageMotionStateChangedRequest()

Bases: Message

The StageServiceRegisterOnStageMotionStateChangedRequest class.

StageServiceRegisterOnStageMotionStateChangedResponse dataclass

StageServiceRegisterOnStageMotionStateChangedResponse(state: StageMotionState = betterproto.enum_field(1))

Bases: Message

StageMotionState enum response.

Attributes:

• state (StageMotionState) –

  The stage motion state.

state class-attribute instance-attribute

state: StageMotionState = enum_field(1)

The stage motion state.

StageServiceRegisterOnStagePositionChangedRequest dataclass

StageServiceRegisterOnStagePositionChangedRequest()

Bases: Message

The StageServiceRegisterOnStagePositionChangedRequest class.

StageServiceRegisterOnStagePositionChangedResponse dataclass

StageServiceRegisterOnStagePositionChangedResponse(axis: AxisIdentifier = betterproto.enum_field(1), position: float = betterproto.double_field(2))

Bases: Message

Abstract representation of an arbitrary axis.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• position (float) –

  The position of the axis in meters or radians.

axis class-attribute instance-attribute

axis: AxisIdentifier = enum_field(1)

The axis identifier.

position class-attribute instance-attribute

position: float = double_field(2)

The position of the axis in meters or radians.

StageServiceRegisterOnStageStateChangedRequest dataclass

StageServiceRegisterOnStageStateChangedRequest()

Bases: Message

The StageServiceRegisterOnStageStateChangedRequest class.

StageServiceRegisterOnStageStateChangedResponse dataclass

StageServiceRegisterOnStageStateChangedResponse(state: StageState = betterproto.enum_field(1))

Bases: Message

StageState enum response.

Attributes:

• state (StageState) –

  The stage state.

state class-attribute instance-attribute

state: StageState = enum_field(1)

The stage state.

StageServiceRegisterOnStageVelocityChangedRequest dataclass

StageServiceRegisterOnStageVelocityChangedRequest()

Bases: Message

The StageServiceRegisterOnStageVelocityChangedRequest class.

StageServiceRegisterOnStageVelocityChangedResponse dataclass

StageServiceRegisterOnStageVelocityChangedResponse(axis: AxisIdentifier = betterproto.enum_field(1), velocity: float = betterproto.double_field(2))

Bases: Message

Abstract representation of an arbitrary axis and it's velocity.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• velocity (float) –

  The velocity of the axis in meters per second or radians per second.

axis class-attribute instance-attribute

axis: AxisIdentifier = enum_field(1)

The axis identifier.

velocity class-attribute instance-attribute

velocity: float = double_field(2)

The velocity of the axis in meters per second or radians per second.

StageServiceStopRequest dataclass

StageServiceStopRequest()

Bases: Message

The StageServiceStopRequest class.

StageServiceStopResponse dataclass

StageServiceStopResponse()

Bases: Message

The StageServiceStopResponse class.