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.
-
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.
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).
class-attribute
instance-attribute
#
X = 1
X axis (translation axis). Controlled by length, default unit is meters.
class-attribute
instance-attribute
#
Y = 2
Y axis (translation axis). Controlled by length, default unit is meters.
class-attribute
instance-attribute
#
Z = 3
Z axis (translation axis). Controlled by length, default unit is meters.
class-attribute
instance-attribute
#
R = 4
R axis (rotation axis). Controlled by angle, default unit is radians.
class-attribute
instance-attribute
#
T = 5
T axis (rotation axis). Controlled by angle, default unit is radians.
class-attribute
instance-attribute
#
M = 6
M axis (translation axis). Controlled by length, default unit is meters.
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
-
IDLE–The stage is not moving.
-
MOVING–The stage is in motion.
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,
class-attribute
instance-attribute
#
UNKNOWN = 1
Should not occur in a well configured system.
class-attribute
instance-attribute
#
ERROR = 2
The stage cannot perform any task. Software restart and/or physical intervention is required.
class-attribute
instance-attribute
#
NORMAL = 3
The state is functioning normally and can be used.
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.
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.
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.
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.
dataclass
#
StageServiceGetAvailableStageAxisRequest()
Bases: Message
The StageServiceGetAvailableStageAxisRequest class.
dataclass
#
StageServiceGetAvailableStageAxisResponse(available_axis: List[AxisIdentifier] = betterproto.enum_field(1))
Bases: Message
Response object of available stage axis.
dataclass
#
StageServiceGetAxisPositionRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))
Bases: Message
The StageServiceGetAxisPositionRequest class.
Attributes:
-
axis_id(AxisIdentifier) –The requested axe.
class-attribute
instance-attribute
#
axis_id: AxisIdentifier = enum_field(1)
The requested axe.
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.
dataclass
#
StageServiceGetAxisVelocityRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))
Bases: Message
The StageServiceGetAxisVelocityRequest class.
Attributes:
-
axis_id(AxisIdentifier) –The requested axis.
class-attribute
instance-attribute
#
axis_id: AxisIdentifier = enum_field(1)
The requested axis.
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.
dataclass
#
StageServiceGetStageMotionStateRequest()
Bases: Message
The StageServiceGetStageMotionStateRequest class.
dataclass
#
StageServiceGetStageMotionStateResponse(state: StageMotionState = betterproto.enum_field(1))
Bases: Message
StageMotionState enum response.
Attributes:
-
state(StageMotionState) –The stage motion state.
class-attribute
instance-attribute
#
state: StageMotionState = enum_field(1)
The stage motion state.
dataclass
#
StageServiceGetStagePositionRequest()
Bases: Message
The StageServiceGetStagePositionRequest class.
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.
class-attribute
instance-attribute
#
axis_positions: List[StageAxis] = message_field(1)
The available axis and their positions.
dataclass
#
StageServiceGetStageStateRequest()
Bases: Message
The StageServiceGetStageStateRequest class.
dataclass
#
StageServiceGetStageStateResponse(state: StageState = betterproto.enum_field(1))
dataclass
#
StageServiceGetStageVelocityRequest()
Bases: Message
The StageServiceGetStageVelocityRequest class.
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.
class-attribute
instance-attribute
#
axis_velocities: List[StageServiceAxisVelocityResponse] = message_field(1)
The available axis and their velocities.
dataclass
#
StageServiceInitializeStageRequest()
Bases: Message
The StageServiceInitializeStageRequest class.
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.
class-attribute
instance-attribute
#
task_success: bool = bool_field(1)
A value indicating whether the task to initialize the stage succeeded or not.
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.
class-attribute
instance-attribute
#
axis_to_move: List[StageAxis] = message_field(1)
The stage axis that should move. The position is in meters.
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.
class-attribute
instance-attribute
#
task_success: bool = bool_field(1)
A value indicating whether the task to move the stage succeeded or not.
dataclass
#
StageServiceRegisterOnStageMotionStateChangedRequest()
Bases: Message
The StageServiceRegisterOnStageMotionStateChangedRequest class.
dataclass
#
StageServiceRegisterOnStageMotionStateChangedResponse(state: StageMotionState = betterproto.enum_field(1))
Bases: Message
StageMotionState enum response.
Attributes:
-
state(StageMotionState) –The stage motion state.
class-attribute
instance-attribute
#
state: StageMotionState = enum_field(1)
The stage motion state.
dataclass
#
StageServiceRegisterOnStagePositionChangedRequest()
Bases: Message
The StageServiceRegisterOnStagePositionChangedRequest class.
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.
dataclass
#
StageServiceRegisterOnStageStateChangedRequest()
Bases: Message
The StageServiceRegisterOnStageStateChangedRequest class.
dataclass
#
StageServiceRegisterOnStageStateChangedResponse(state: StageState = betterproto.enum_field(1))
dataclass
#
StageServiceRegisterOnStageVelocityChangedRequest()
Bases: Message
The StageServiceRegisterOnStageVelocityChangedRequest class.
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.
dataclass
#
StageServiceStopRequest()
Bases: Message
The StageServiceStopRequest class.
dataclass
#
StageServiceStopResponse()
Bases: Message
The StageServiceStopResponse class.