Femtum SDK

Service LaserExecutionService

Service LaserEnergyCalibrationService

Service LaserHeadCameraService

Service GalvoDistortionCalibrationService

Service HealthService

Service MotionService

Service LaserPowerMeterCharacterizationService

Service FemtosecondLaserService

Service LaserPowerMeterService

Service LaserHeadCameraAutofocusService

Message LaserExecutionFeatures

Message LaserExecutionOptions

Message ExecuteLaserExecutionRecipeRequest

Message ExecuteLaserExecutionRecipeResponse

Message ReadDefaultExecutionParametersRequest

Message ReadDefaultExecutionParametersResponse

Message LaserEnergyCalibrationRequest

Message ReadCameraInfoRequest

Message CaptureImageRequest

Message UpdateROIResponse

Message ResetROIRequest

Message ResetROIResponse

Message UpdateImageParametersResponse

Message ResetImageParametersRequest

Message ResetImageParametersResponse

Message ReadImageParametersRequest

Message ReadIlluminationRequest

Message UpdateIlluminationRequest

Message PerformFullCalibrationRequest

Message PerformFullCalibrationResponse

Message PerformOffsetCalibrationRequest

Message PerformOffsetCalibrationResponse

Message HealthRequest

Message HealthResponse

Message Stage

Message OrderedMove

Message AllAtOnceMove

Message MoveOrder

Message ReadAvailableAxesRequest

Message ReadAvailableAxesResponse

Message ReadCurrentPositionRequest

Message ReadCurrentPositionResponse

Message MoveToAbsolutePositionRequest

Message MoveToAbsolutePositionResponse

Message MoveToRelativePositionRequest

Message MoveToRelativePositionResponse

Message ReadAvailableStagesRequest

Message ReadAvailableStagesResponse

Message LaserPowerMeterCharacterizationOptions

Message LaserPowerMeterCharacterizationLaserOptions

Message ExecuteZeroingResponseRequest

Message ExecuteLaserResponseRequest

Message PowerMeasurements

Message GetLaserParametersRequest

Message GetAvailableFeaturesRequest

Message GetAvailableFeaturesResponse

Message GetLaserParametersResponse

Message ApplyLaserParametersRequest

Message ApplyLaserParametersResponse

Message ReadPowerRequest

Message ReadPowerResponse

Message ApplyLaserPowerMeterWavelengthRequest

Message ApplyLaserPowerMeterWavelengthResponse

Message ReadLaserPowerMeterWavelengthRequest

Message ExecuteAutofocusRequest

Message ExecuteAutofocusForRecipeRequest

Enum MotionStage

Services

service LaserExecutionService v1/hardware/laser_execution.proto

rpc `ExecuteRecipe`

Request:

v1.hardware.ExecuteLaserExecutionRecipeRequest

Response:

v1.hardware.ExecuteLaserExecutionRecipeResponse

rpc `ReadDefaultExecutionParameters`

Request:

v1.hardware.ReadDefaultExecutionParametersRequest

Response:

v1.hardware.ReadDefaultExecutionParametersResponse

service LaserEnergyCalibrationService v1/hardware/laser_energy_calibration.proto

rpc `Run`

Request:

v1.hardware.LaserEnergyCalibrationRequest

Response:

v1.dto.LaserEnergyCalibration

rpc `RunStream`

Request:

v1.hardware.LaserEnergyCalibrationRequest

Response:

v1.dto.LaserEnergyCalibrationEvent

service LaserHeadCameraService v1/hardware/camera.proto

rpc `ReadCameraInfo`

Request:

v1.hardware.ReadCameraInfoRequest

Response:

v1.dto.CameraInfo

rpc `CaptureImage`

Request:

v1.hardware.CaptureImageRequest

Response:

v1.dto.Image

rpc `UpdateROI`

Request:

v1.dto.CenteredRegionOfInterest

Response:

v1.hardware.UpdateROIResponse

rpc `ResetROI`

Request:

v1.hardware.ResetROIRequest

Response:

v1.hardware.ResetROIResponse

rpc `UpdateImageParameters`

Request:

v1.dto.CameraImageInputParameters

Response:

v1.hardware.UpdateImageParametersResponse

rpc `ResetImageParameters`

Request:

v1.hardware.ResetImageParametersRequest

Response:

v1.hardware.ResetImageParametersResponse

rpc `ReadImageParameters`

Request:

v1.hardware.ReadImageParametersRequest

Response:

v1.dto.CameraImageParameters

rpc `ReadIllumination`

Request:

v1.hardware.ReadIlluminationRequest

Response:

v1.dto.CameraIllumination

rpc `UpdateIllumination`

Request:

v1.hardware.UpdateIlluminationRequest

Response:

v1.dto.CameraIllumination

service GalvoDistortionCalibrationService v1/hardware/galvo_distortion_calibration.proto

rpc `PerformFullCalibration`

Request:

v1.hardware.PerformFullCalibrationRequest

Response:

v1.hardware.PerformFullCalibrationResponse

rpc `PerformOffsetCalibration`

Request:

v1.hardware.PerformOffsetCalibrationRequest

Response:

v1.hardware.PerformOffsetCalibrationResponse

service HealthService v1/hardware/health.proto

rpc `GetHealth`

Request:

v1.hardware.HealthRequest

Response:

v1.hardware.HealthResponse

service MotionService v1/hardware/motion.proto

rpc `ReadAvailableAxes`

Request:

v1.hardware.ReadAvailableAxesRequest

Response:

v1.hardware.ReadAvailableAxesResponse

rpc `ReadCurrentPosition`

Request:

v1.hardware.ReadCurrentPositionRequest

Response:

v1.hardware.ReadCurrentPositionResponse

rpc `MoveToAbsolutePosition`

Request:

v1.hardware.MoveToAbsolutePositionRequest

Response:

v1.hardware.MoveToAbsolutePositionResponse

rpc `MoveToRelativePosition`

Request:

v1.hardware.MoveToRelativePositionRequest

Response:

v1.hardware.MoveToRelativePositionResponse

rpc `ReadAvailableStages`

Request:

v1.hardware.ReadAvailableStagesRequest

Response:

v1.hardware.ReadAvailableStagesResponse

service LaserPowerMeterCharacterizationService v1/hardware/laser_power_meter_characterization.proto

rpc `ExecuteZeroingResponse`

Request:

v1.hardware.ExecuteZeroingResponseRequest

Response:

v1.hardware.PowerMeasurements

rpc `ExecuteLaserResponse`

Request:

v1.hardware.ExecuteLaserResponseRequest

Response:

v1.hardware.PowerMeasurements

service FemtosecondLaserService v1/hardware/femtosecond_laser.proto

rpc `GetParameters`

Request:

v1.hardware.GetLaserParametersRequest

Response:

v1.hardware.GetLaserParametersResponse

rpc `ApplyParameters`

Request:

v1.hardware.ApplyLaserParametersRequest

Response:

v1.hardware.ApplyLaserParametersResponse

rpc `GetAvailableFeatures`

Request:

v1.hardware.GetAvailableFeaturesRequest

Response:

v1.hardware.GetAvailableFeaturesResponse

service LaserPowerMeterService v1/hardware/laser_power_meter.proto

rpc `ReadPower`

Request:

v1.hardware.ReadPowerRequest

Response:

v1.hardware.ReadPowerResponse

rpc `ApplyWavelength`

Request:

v1.hardware.ApplyLaserPowerMeterWavelengthRequest

Response:

v1.hardware.ApplyLaserPowerMeterWavelengthResponse

rpc `ReadWavelength`

Request:

v1.hardware.ReadLaserPowerMeterWavelengthRequest

Response:

v1.dto.DistanceMeasure

service LaserHeadCameraAutofocusService v1/hardware/camera_autofocus.proto

rpc `ExecuteAutofocus`

Request:

v1.hardware.ExecuteAutofocusRequest

Response:

v1.dto.AutofocusResult

rpc `ExecuteAutofocusIgnoreFailure`

Request:

v1.hardware.ExecuteAutofocusRequest

Response:

v1.dto.AutofocusResult

rpc `ExecuteAutofocusForRecipe`

Request:

v1.hardware.ExecuteAutofocusForRecipeRequest

Response:

v1.dto.AutofocusResult

rpc `ExecuteAutofocusForRecipeIgnoreFailure`

Request:

v1.hardware.ExecuteAutofocusForRecipeRequest

Response:

v1.dto.AutofocusResult

message LaserExecutionFeatures v1/hardware/laser_execution.proto

	Field	Type	Description
1	take_pictures	`optional bool`

message LaserExecutionOptions v1/hardware/laser_execution.proto

	Field	Type
1	laser_energy_calibration_id	`optional string`
2	energy_per_pulse	`optional v1.dto.EnergyMeasure`
3	galvo_calibration_selector	`optional v1.dto.GalvoCalibrationSelector`

message ExecuteLaserExecutionRecipeRequest v1/hardware/laser_execution.proto

	Field	Type
1	recipe	`v1.dto.Recipe`
2	options	`v1.hardware.LaserExecutionOptions`
3	component_id	`optional string`
4	dry_run	`optional bool`
5	features	`v1.hardware.LaserExecutionFeatures`
6	component_path	`optional string`

message ExecuteLaserExecutionRecipeResponse v1/hardware/laser_execution.proto

	Field	Type	Description
1	execution	`v1.dto.LaserExecution`

message ReadDefaultExecutionParametersRequest v1/hardware/laser_execution.proto

	Field	Type	Description

message ReadDefaultExecutionParametersResponse v1/hardware/laser_execution.proto

	Field	Type
1	scaling_factor	`v1.dto.DistanceMeasure`
2	galvo_marking_parameters	`v1.dto.GalvoMarkingParameters`
3	maximum_camera_frame_size_pixels	`v1.dto.FrameSize`
4	galvo_marking_bounding_box	`optional v1.dto.BoundingBox2D`

message LaserEnergyCalibrationRequest v1/hardware/laser_energy_calibration.proto

	Field	Type
1	name	`optional string`
2	laser_repetition_rate_khz	`optional uint32`
3	iteration_delay_ms	`optional uint32`
4	wavelength_nm	`float`

message ReadCameraInfoRequest v1/hardware/camera.proto

	Field	Type	Description

message CaptureImageRequest v1/hardware/camera.proto

	Field	Type	Description
1	format	`v1.dto.ImageFormat`
2	size	`optional v1.dto.ImageSize`

message UpdateROIResponse v1/hardware/camera.proto

	Field	Type	Description

message ResetROIRequest v1/hardware/camera.proto

	Field	Type	Description

message ResetROIResponse v1/hardware/camera.proto

	Field	Type	Description

message UpdateImageParametersResponse v1/hardware/camera.proto

	Field	Type	Description

message ResetImageParametersRequest v1/hardware/camera.proto

	Field	Type	Description

message ResetImageParametersResponse v1/hardware/camera.proto

	Field	Type	Description

message ReadImageParametersRequest v1/hardware/camera.proto

	Field	Type	Description

message ReadIlluminationRequest v1/hardware/camera.proto

	Field	Type	Description

message UpdateIlluminationRequest v1/hardware/camera.proto

	Field	Type	Description
1	illumination	`v1.dto.CameraIllumination`

message PerformFullCalibrationRequest v1/hardware/galvo_distortion_calibration.proto

	Field	Type
1	options	`v1.hardware.LaserExecutionOptions`
2	grid_spacing	`optional v1.dto.DistanceMeasure`
3	grid_size	`optional int32`

message PerformFullCalibrationResponse v1/hardware/galvo_distortion_calibration.proto

	Field	Type	Description
1	analysis	`v1.dto.GalvoDistortionCalibrationAnalysis`

message PerformOffsetCalibrationRequest v1/hardware/galvo_distortion_calibration.proto

	Field	Type
1	options	`v1.hardware.LaserExecutionOptions`
2	parent_full_calibration_id	`optional string`
3	grid_spacing	`optional v1.dto.DistanceMeasure`
4	grid_size	`optional int32`

message PerformOffsetCalibrationResponse v1/hardware/galvo_distortion_calibration.proto

	Field	Type	Description
1	analysis	`v1.dto.GalvoDistortionCalibrationAnalysis`

message HealthRequest v1/hardware/health.proto

	Field	Type	Description

message HealthResponse v1/hardware/health.proto

	Field	Type	Description
1	status	`string`
2	version	`string`

message Stage v1/hardware/motion.proto

	Field	Type	Description

oneof stage
1	motion	`v1.hardware.MotionStage`	Oneof to support custom stages without breaking the API

message OrderedMove v1/hardware/motion.proto

	Field	Type	Description
1	axis	`repeated v1.dto.Axis`

message AllAtOnceMove v1/hardware/motion.proto

	Field	Type	Description

message MoveOrder v1/hardware/motion.proto

	Field	Type

oneof move_order
1	ordered	`v1.hardware.OrderedMove`
2	all_at_once	`v1.hardware.AllAtOnceMove`

message ReadAvailableAxesRequest v1/hardware/motion.proto

	Field	Type	Description
1	stage	`v1.hardware.Stage`

message ReadAvailableAxesResponse v1/hardware/motion.proto

	Field	Type	Description
1	available_axes	`repeated v1.dto.Axis`

message ReadCurrentPositionRequest v1/hardware/motion.proto

	Field	Type	Description
1	stage	`v1.hardware.Stage`

message ReadCurrentPositionResponse v1/hardware/motion.proto

	Field	Type	Description
1	position	`v1.dto.SixDofMotionPosition`

message MoveToAbsolutePositionRequest v1/hardware/motion.proto

	Field	Type
1	stage	`v1.hardware.Stage`
2	target	`v1.dto.SixDofMotionPosition`
3	order	`v1.hardware.MoveOrder`

message MoveToAbsolutePositionResponse v1/hardware/motion.proto

	Field	Type	Description
1	position	`v1.dto.SixDofMotionPosition`

message MoveToRelativePositionRequest v1/hardware/motion.proto

	Field	Type
1	stage	`v1.hardware.Stage`
2	delta	`v1.dto.SixDofMotionPosition`
3	order	`v1.hardware.MoveOrder`

message MoveToRelativePositionResponse v1/hardware/motion.proto

	Field	Type	Description
1	position	`v1.dto.SixDofMotionPosition`

message ReadAvailableStagesRequest v1/hardware/motion.proto

	Field	Type	Description

message ReadAvailableStagesResponse v1/hardware/motion.proto

	Field	Type	Description
1	available_stages	`repeated v1.hardware.Stage`

message LaserPowerMeterCharacterizationOptions v1/hardware/laser_power_meter_characterization.proto

	Field	Type
1	target_acquisition_period	`optional v1.dto.TimeMeasure`
2	pre_acquisition_delay	`optional v1.dto.TimeMeasure`
3	pre_stimulus_delay	`optional v1.dto.TimeMeasure`
4	post_stimulus_delay	`optional v1.dto.TimeMeasure`

message LaserPowerMeterCharacterizationLaserOptions v1/hardware/laser_power_meter_characterization.proto

	Field	Type	Description
1	laser_power_level_percent	`float`
2	laser_on_duration	`v1.dto.TimeMeasure`

message ExecuteZeroingResponseRequest v1/hardware/laser_power_meter_characterization.proto

	Field	Type	Description
1	characterization_options	`optional v1.hardware.LaserPowerMeterCharacterizationOptions`

message ExecuteLaserResponseRequest v1/hardware/laser_power_meter_characterization.proto

	Field	Type	Description
1	characterization_options	`optional v1.hardware.LaserPowerMeterCharacterizationOptions`
2	laser_options	`v1.hardware.LaserPowerMeterCharacterizationLaserOptions`

message PowerMeasurements v1/hardware/laser_power_meter_characterization.proto

	Field	Type	Description
1	time	`repeated v1.dto.TimeMeasure`
2	power	`repeated v1.dto.PowerMeasure`

message GetLaserParametersRequest v1/hardware/femtosecond_laser.proto

	Field	Type	Description

message GetAvailableFeaturesRequest v1/hardware/femtosecond_laser.proto

	Field	Type	Description

message GetAvailableFeaturesResponse v1/hardware/femtosecond_laser.proto

	Field	Type	Description
1	features	`repeated v1.dto.FemtosecondLaserFeature`

message GetLaserParametersResponse v1/hardware/femtosecond_laser.proto

	Field	Type	Description
1	parameters	`v1.dto.FemtosecondLaserParameters`

message ApplyLaserParametersRequest v1/hardware/femtosecond_laser.proto

	Field	Type	Description
1	parameters	`v1.dto.FemtosecondLaserInputParameters`

message ApplyLaserParametersResponse v1/hardware/femtosecond_laser.proto

	Field	Type	Description
1	parameters	`v1.dto.FemtosecondLaserParameters`

message ReadPowerRequest v1/hardware/laser_power_meter.proto

	Field	Type	Description

message ReadPowerResponse v1/hardware/laser_power_meter.proto

	Field	Type	Description
1	power	`v1.dto.PowerMeasure`

message ApplyLaserPowerMeterWavelengthRequest v1/hardware/laser_power_meter.proto

	Field	Type	Description
1	wavelength	`v1.dto.DistanceMeasure`

message ApplyLaserPowerMeterWavelengthResponse v1/hardware/laser_power_meter.proto

	Field	Type	Description

message ReadLaserPowerMeterWavelengthRequest v1/hardware/laser_power_meter.proto

	Field	Type	Description

message ExecuteAutofocusRequest v1/hardware/camera_autofocus.proto

	Field	Type	Description
1	roi	`v1.dto.BoundingBox2D`
2	options	`v1.dto.AutofocusOptions`

message ExecuteAutofocusForRecipeRequest v1/hardware/camera_autofocus.proto

	Field	Type	Description
1	recipe_id	`string`
2	options	`v1.dto.AutofocusOptions`

enum MotionStage v1/hardware/motion.proto

Name	Number	Description
`MOTION_STAGE_UNSPECIFIED`	0
`MOTION_STAGE_NORTH`	1
`MOTION_STAGE_SOUTH`	2
`MOTION_STAGE_EAST`	3
`MOTION_STAGE_WEST`	4
`MOTION_STAGE_TOP`	5
`MOTION_STAGE_BOTTOM`	6
`MOTION_STAGE_BASE`	7

Package v1.hardware

Services

Messages

Enums

Package `v1.hardware`