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.
-
SimpleStageServiceStub– -
StageServiceStub– -
SimpleStageServiceBase– -
StageServiceBase–
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 physical intervention is required.
-
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
#
SimpleStageServiceGetAccelerationRequest()
Bases: Message
The SimpleStageServiceGetAccelerationRequest class.
dataclass
#
SimpleStageServiceGetAccelerationResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))
Bases: Message
Acceleration of the stage.
Attributes:
dataclass
#
SimpleStageServiceGetPositionRequest()
Bases: Message
The SimpleStageServiceGetPositionRequest class.
dataclass
#
SimpleStageServiceGetPositionResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))
Bases: Message
Position of the stage.
Attributes:
dataclass
#
SimpleStageServiceGetSpeedRequest()
Bases: Message
The SimpleStageServiceGetSpeedRequest class.
dataclass
#
SimpleStageServiceGetSpeedResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))
Bases: Message
Speed of the stage.
Attributes:
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.
class-attribute
instance-attribute
#
x: Optional[float] = betterproto.message_field(1, wraps=betterproto.TYPE_DOUBLE)
Target position x in meters. Leave out if x position should not be changed.
class-attribute
instance-attribute
#
y: Optional[float] = betterproto.message_field(2, wraps=betterproto.TYPE_DOUBLE)
Target position y in meters. Leave out if y position should not be changed.
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.
class-attribute
instance-attribute
#
position_changed: bool = betterproto.bool_field(1)
A value indicating whether the position was changed.
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].
class-attribute
instance-attribute
#
acceleration_x: Optional[float] = betterproto.message_field(1, wraps=betterproto.TYPE_DOUBLE)
Acceleration in x direction in percent, i.e. values from range [0;100].
class-attribute
instance-attribute
#
acceleration_y: Optional[float] = betterproto.message_field(2, wraps=betterproto.TYPE_DOUBLE)
Acceleration in y direction in percent, i.e. values from range [0;100].
dataclass
#
SimpleStageServiceSetAccelerationResponse()
Bases: Message
The SimpleStageServiceSetAccelerationResponse class.
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].
class-attribute
instance-attribute
#
speed_x: Optional[float] = betterproto.message_field(1, wraps=betterproto.TYPE_DOUBLE)
Speed in x direction in percent, i.e. values from range [0;100].
class-attribute
instance-attribute
#
speed_y: Optional[float] = betterproto.message_field(2, wraps=betterproto.TYPE_DOUBLE)
Speed in y direction in percent, i.e. values from range [0;100].
dataclass
#
SimpleStageServiceSetSpeedResponse()
Bases: Message
The SimpleStageServiceSetSpeedResponse class.
dataclass
#
SimpleStageServiceStopRequest()
Bases: Message
The SimpleStageServiceStopRequest class.
dataclass
#
SimpleStageServiceStopResponse()
Bases: Message
The SimpleStageServiceStopResponse class.
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 axis.
class-attribute
instance-attribute
#
axis_id: AxisIdentifier = betterproto.enum_field(1)
The requested axis.
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 = betterproto.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 available axis and their positions.
class-attribute
instance-attribute
#
state: StageMotionState = betterproto.enum_field(1)
The available axis and their positions.
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] = betterproto.message_field(1)
The available axis and their positions.
dataclass
#
StageServiceGetStageStateRequest()
Bases: Message
The StageServiceGetStageStateRequest class.
dataclass
#
StageServiceGetStageStateResponse(state: StageState = betterproto.enum_field(1))
Bases: Message
StageState enum response.
Attributes:
-
state(StageState) –The stage state.
class-attribute
instance-attribute
#
state: StageState = betterproto.enum_field(1)
The stage state.
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] = betterproto.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 = betterproto.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] = betterproto.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 = betterproto.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 = betterproto.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))
Bases: Message
StageState enum response.
Attributes:
-
state(StageState) –The stage state.
class-attribute
instance-attribute
#
state: StageState = betterproto.enum_field(1)
The stage state.
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.
Bases: ServiceStub
Methods:
-
get_acceleration–Gets the acceleration of the stage.
-
get_position–Gets the current stage position.
-
get_speed–Gets the speed of the stage.
-
move_to–Moves the stage to the given position. Is a value for a dimension is no supplied, the position in that dimension it is kept as is.
-
set_acceleration–Sets the acceleration of the stage in percent.
-
set_speed–Sets the speed of the stage in percent.
-
stop–Stops the stage if it is moving.
async
#
get_acceleration(simple_stage_service_get_acceleration_request: SimpleStageServiceGetAccelerationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleStageServiceGetAccelerationResponse
Gets the acceleration of the stage.
async
#
get_position(simple_stage_service_get_position_request: SimpleStageServiceGetPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleStageServiceGetPositionResponse
Gets the current stage position.
async
#
get_speed(simple_stage_service_get_speed_request: SimpleStageServiceGetSpeedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleStageServiceGetSpeedResponse
Gets the speed of the stage.
async
#
move_to(simple_stage_service_move_to_request: SimpleStageServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleStageServiceMoveToResponse
Moves the stage to the given position. Is a value for a dimension is no supplied, the position in that dimension it is kept as is.
async
#
set_acceleration(simple_stage_service_set_acceleration_request: SimpleStageServiceSetAccelerationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleStageServiceSetAccelerationResponse
Sets the acceleration of the stage in percent.
async
#
set_speed(simple_stage_service_set_speed_request: SimpleStageServiceSetSpeedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleStageServiceSetSpeedResponse
Sets the speed of the stage in percent.
async
#
stop(simple_stage_service_stop_request: SimpleStageServiceStopRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleStageServiceStopResponse
Stops the stage if it is moving.
Bases: ServiceStub
Methods:
-
get_available_stage_axis–Retrieves all available stage axis on this system.
-
get_axis_position–Gets the current position of an axis of the stage.
-
get_axis_velocity–Gets the current velocity of an axis of the stage.
-
get_stage_motion_state–Retrieves the current stage motion state.
-
get_stage_position–Retrieves the current stage position.
-
get_stage_state–Retrieves the current stage state.
-
get_stage_velocity–Retrieves the current stage velocity.
-
initialize_stage–Starts an initialization routine for the stage to initialize all stage axis.
-
move_to–Moves the stage.
-
register_on_stage_motion_state_changed–Notification about changes of the stage motion state.
-
register_on_stage_position_changed–Notification about changes of all stage axis positions.
-
register_on_stage_state_changed–Notification about changes of the stage state.
-
register_on_stage_velocity_changed–Notification about changes of all stage axis velocities.
-
stop–Immediately stops the stage.
async
#
get_available_stage_axis(stage_service_get_available_stage_axis_request: StageServiceGetAvailableStageAxisRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetAvailableStageAxisResponse
Retrieves all available stage axis on this system.
async
#
get_axis_position(stage_service_get_axis_position_request: StageServiceGetAxisPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetAxisPositionResponse
Gets the current position of an axis of the stage.
async
#
get_axis_velocity(stage_service_get_axis_velocity_request: StageServiceGetAxisVelocityRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetAxisVelocityResponse
Gets the current velocity of an axis of the stage.
async
#
get_stage_motion_state(stage_service_get_stage_motion_state_request: StageServiceGetStageMotionStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageMotionStateResponse
Retrieves the current stage motion state.
async
#
get_stage_position(stage_service_get_stage_position_request: StageServiceGetStagePositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStagePositionResponse
Retrieves the current stage position. This will return the positions of all available axis..
async
#
get_stage_state(stage_service_get_stage_state_request: StageServiceGetStageStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageStateResponse
Retrieves the current stage state.
async
#
get_stage_velocity(stage_service_get_stage_velocity_request: StageServiceGetStageVelocityRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageVelocityResponse
Retrieves the current stage velocity. This will return the velocity of all available axis.
async
#
initialize_stage(stage_service_initialize_stage_request: StageServiceInitializeStageRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceInitializeStageResponse
Starts an initialization routine for the stage to initialize all stage axis. This may take a while and the stage is moving in this time.
async
#
move_to(stage_service_move_to_request: StageServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceMoveToResponse
Moves the stage.
async
#
register_on_stage_motion_state_changed(stage_service_register_on_stage_motion_state_changed_request: StageServiceRegisterOnStageMotionStateChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[StageServiceRegisterOnStageMotionStateChangedResponse]
Notification about changes of the stage motion state.
async
#
register_on_stage_position_changed(stage_service_register_on_stage_position_changed_request: StageServiceRegisterOnStagePositionChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[StageServiceRegisterOnStagePositionChangedResponse]
Notification about changes of all stage axis positions.
async
#
register_on_stage_state_changed(stage_service_register_on_stage_state_changed_request: StageServiceRegisterOnStageStateChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[StageServiceRegisterOnStageStateChangedResponse]
Notification about changes of the stage state.
async
#
register_on_stage_velocity_changed(stage_service_register_on_stage_velocity_changed_request: StageServiceRegisterOnStageVelocityChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[StageServiceRegisterOnStageVelocityChangedResponse]
Notification about changes of all stage axis velocities.
async
#
stop(stage_service_stop_request: StageServiceStopRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceStopResponse
Immediately stops the stage.
Bases: ServiceBase
Methods:
-
get_acceleration–Gets the acceleration of the stage.
-
get_position–Gets the current stage position.
-
get_speed–Gets the speed of the stage.
-
move_to–Moves the stage to the given position. Is a value for a dimension is no supplied, the position in that dimension it is kept as is.
-
set_acceleration–Sets the acceleration of the stage in percent.
-
set_speed–Sets the speed of the stage in percent.
-
stop–Stops the stage if it is moving.
async
#
get_acceleration(simple_stage_service_get_acceleration_request: SimpleStageServiceGetAccelerationRequest) -> SimpleStageServiceGetAccelerationResponse
Gets the acceleration of the stage.
async
#
get_position(simple_stage_service_get_position_request: SimpleStageServiceGetPositionRequest) -> SimpleStageServiceGetPositionResponse
Gets the current stage position.
async
#
get_speed(simple_stage_service_get_speed_request: SimpleStageServiceGetSpeedRequest) -> SimpleStageServiceGetSpeedResponse
Gets the speed of the stage.
async
#
move_to(simple_stage_service_move_to_request: SimpleStageServiceMoveToRequest) -> SimpleStageServiceMoveToResponse
Moves the stage to the given position. Is a value for a dimension is no supplied, the position in that dimension it is kept as is.
async
#
set_acceleration(simple_stage_service_set_acceleration_request: SimpleStageServiceSetAccelerationRequest) -> SimpleStageServiceSetAccelerationResponse
Sets the acceleration of the stage in percent.
async
#
set_speed(simple_stage_service_set_speed_request: SimpleStageServiceSetSpeedRequest) -> SimpleStageServiceSetSpeedResponse
Sets the speed of the stage in percent.
async
#
stop(simple_stage_service_stop_request: SimpleStageServiceStopRequest) -> SimpleStageServiceStopResponse
Stops the stage if it is moving.
Bases: ServiceBase
Methods:
-
get_available_stage_axis–Retrieves all available stage axis on this system.
-
get_axis_position–Gets the current position of an axis of the stage.
-
get_axis_velocity–Gets the current velocity of an axis of the stage.
-
get_stage_motion_state–Retrieves the current stage motion state.
-
get_stage_position–Retrieves the current stage position.
-
get_stage_state–Retrieves the current stage state.
-
get_stage_velocity–Retrieves the current stage velocity.
-
initialize_stage–Starts an initialization routine for the stage to initialize all stage axis.
-
move_to–Moves the stage.
-
register_on_stage_motion_state_changed–Notification about changes of the stage motion state.
-
register_on_stage_position_changed–Notification about changes of all stage axis positions.
-
register_on_stage_state_changed–Notification about changes of the stage state.
-
register_on_stage_velocity_changed–Notification about changes of all stage axis velocities.
-
stop–Immediately stops the stage.
async
#
get_available_stage_axis(stage_service_get_available_stage_axis_request: StageServiceGetAvailableStageAxisRequest) -> StageServiceGetAvailableStageAxisResponse
Retrieves all available stage axis on this system.
async
#
get_axis_position(stage_service_get_axis_position_request: StageServiceGetAxisPositionRequest) -> StageServiceGetAxisPositionResponse
Gets the current position of an axis of the stage.
async
#
get_axis_velocity(stage_service_get_axis_velocity_request: StageServiceGetAxisVelocityRequest) -> StageServiceGetAxisVelocityResponse
Gets the current velocity of an axis of the stage.
async
#
get_stage_motion_state(stage_service_get_stage_motion_state_request: StageServiceGetStageMotionStateRequest) -> StageServiceGetStageMotionStateResponse
Retrieves the current stage motion state.
async
#
get_stage_position(stage_service_get_stage_position_request: StageServiceGetStagePositionRequest) -> StageServiceGetStagePositionResponse
Retrieves the current stage position. This will return the positions of all available axis..
async
#
get_stage_state(stage_service_get_stage_state_request: StageServiceGetStageStateRequest) -> StageServiceGetStageStateResponse
Retrieves the current stage state.
async
#
get_stage_velocity(stage_service_get_stage_velocity_request: StageServiceGetStageVelocityRequest) -> StageServiceGetStageVelocityResponse
Retrieves the current stage velocity. This will return the velocity of all available axis.
async
#
initialize_stage(stage_service_initialize_stage_request: StageServiceInitializeStageRequest) -> StageServiceInitializeStageResponse
Starts an initialization routine for the stage to initialize all stage axis. This may take a while and the stage is moving in this time.
async
#
move_to(stage_service_move_to_request: StageServiceMoveToRequest) -> StageServiceMoveToResponse
Moves the stage.
async
#
register_on_stage_motion_state_changed(stage_service_register_on_stage_motion_state_changed_request: StageServiceRegisterOnStageMotionStateChangedRequest) -> AsyncIterator[StageServiceRegisterOnStageMotionStateChangedResponse]
Notification about changes of the stage motion state.
async
#
register_on_stage_position_changed(stage_service_register_on_stage_position_changed_request: StageServiceRegisterOnStagePositionChangedRequest) -> AsyncIterator[StageServiceRegisterOnStagePositionChangedResponse]
Notification about changes of all stage axis positions.
async
#
register_on_stage_state_changed(stage_service_register_on_stage_state_changed_request: StageServiceRegisterOnStageStateChangedRequest) -> AsyncIterator[StageServiceRegisterOnStageStateChangedResponse]
Notification about changes of the stage state.
async
#
register_on_stage_velocity_changed(stage_service_register_on_stage_velocity_changed_request: StageServiceRegisterOnStageVelocityChangedRequest) -> AsyncIterator[StageServiceRegisterOnStageVelocityChangedResponse]
Notification about changes of all stage axis velocities.
async
#
stop(stage_service_stop_request: StageServiceStopRequest) -> StageServiceStopResponse
Immediately stops the stage.