SiPH Application Commands

These commands operate SiPH (silicon photonics) fiber-alignment positioners.

siph:fast_alignment

Sentio Version: 3.3.0

Description: Starts the SiPH positioner's fast alignment routine.

Parameters: None

Response:

Field	Type	Values
Setup	String	OK

Example:

Command:   siph:fast_alignment
Response:  0,0,OK     (runs the fast align routine for SiPH; every search method enabled)

siph:get_alignment

Sentio Version: 3.6.0

Description: Gets which fast-alignment search stages are enabled (Coarse, Fine, Gradient, Rotary/Focal).

Parameters:

Parameter	Type	Values
Positioner ID	Integer / String	1/East/Right, 2/West/Left
Fiber Type (opt.)	String	Single, Array, Lensed

Response:

Field	Type	Values
Setup	String	True/False per search stage

Examples:

Command:   siph:set_alignment East,Array,ON,ON,OFF,OFF
Response:  0,0,OK     (Array fiber type: Coarse and Fine only)

Command:   siph:get_alignment East,Array
Response:  0,0,True,True,False,False    (only Coarse and Fine enabled)

Command:   siph:set_alignment East,Single,ON,OFF,OFF
Response:  0,0,OK     (Single fiber type: Coarse only)

Command:   siph:get_alignment East,Single
Response:  0,0,True,False,False         (only Coarse enabled)

Remarks: If the optional parameter is omitted, the command returns the setting from the user interface.

siph:get_intensity

Sentio Version: 3.3.0

Description: Gets the current intensity value.

Parameters: None

Response:

Field	Type	Notes
Intensity	Integer	Intensity value

Example:

Command:   siph:get_intensity
Response:  0,0,250

siph:get_prop

Sentio Version: 3.7.0

Description: Generic function to retrieve the value of a specific data item from the SiPH module.

Parameters:

Parameter	Type	Values
Property Name	String	intensity, alignment_range (needs additional parameters), alignment_frequency (needs additional parameters), alignment_velocity (needs additional parameters), power_meter_value

Additional parameters (for alignment_* properties): Positioner (East/West), Fiber Type (Single/Array/Lensed), Search Type (Coarse/Fine).

Response:

Field	Type	Notes
Setup	String	Returns the requested data

Examples:

Command:   siph:get_prop intensity
Response:  0,0,50

Command:   siph:get_prop alignment_range,east,single,coarse
Response:  0,0,20,25     (1st range 20 µm, 2nd range 25 µm)

Command:   siph:get_prop power_meter_value
Response:  0,0,0.1       (current power meter reading, 0.1 mW; unit per current setting)

siph:gradient_search

Sentio Version: 3.3.0

Description: Starts the SiPH positioner's gradient search routine.

Parameters: None

Response:

Field	Type	Values
Setup	String	OK

Example:

Command:   siph:gradient_search East
Response:  0,0,OK     (runs the gradient search routine for SiPH)

siph:move_hover

Sentio Version: 3.3.0

Description: Moves the SiPH positioner to the hover height position.

Parameters:

Parameter	Type	Values
Positioner ID	Integer / String	1/East/Right, 2/West/Left, 3/North, 4/South

Response:

Field	Type	Values
Setup	String	OK

Example:

Command:   siph:move_hover east
Response:  0,0,OK

Remarks: Positioners with a NanoCube move to hover height.

siph:move_separation

Sentio Version: 3.3.0

Description: Moves the SiPH positioner to the separation height position.

Parameters:

Parameter	Type	Values
Positioner ID	Integer / String	1/East/Right, 2/West/Left, 3/North, 4/South

Response:

Field	Type	Values
Setup	String	OK

Example:

Command:   siph:move_separation East
Response:  0,0,OK

Remarks: Positioners with a NanoCube move to separation height.

siph:move_origin

Sentio Version: 3.6.0

Description: Moves the positioner to the origin position: NanoCube XY moves to 50 µm, and — on systems with UVW axes — the UVW axes move to the position recorded for the Hover Height.

Parameters:

Parameter	Type	Values
Positioner ID	Integer / String	1/East/Right, 2/West/Left

Response:

Field	Type	Values
Setup	String	OK

Example:

Command:   siph:move_origin
Response:  0,0,OK     (NanoCube XY back to 50 µm, UVW axes back to trained Hover Height position)

Remarks: If the axis is "Manual" type, only the NanoCube moves to 50 µm.

siph:power_calibration

Description: Replaces siph:fiber_power_reading. (Deprecated alias — see siph:fiber_power_reading.)

siph:set_alignment

Sentio Version: 3.6.0

Description: Sets which fast-alignment search stages are enabled (Coarse, Fine, Gradient, Rotary/Focal).

Parameters:

Parameter	Type	Values	Notes
Positioner ID	Integer / String	1/East/Right, 2/West/Left
Fiber Type	String	Single, Array, Lensed
Coarse Search	String	ON/OFF
Fine Search	String	ON/OFF
Gradient Search	String	ON/OFF
Rotary/Focal Search	String	ON/OFF	Not supported for Single fiber type

Response:

Field	Type	Values
Setup	String	OK

Examples:

Command:   siph:set_alignment East, Array, ON, ON, OFF, OFF
Response:  0,0,OK     (Array fiber: Coarse and Fine only)

Command:   siph:set_alignment East,Single,ON,OFF,OFF
Response:  0,0,OK     (Single fiber: Coarse only)

siph:set_cap_sensor_distance_search

Sentio Version: 3.6.2, updated 3.7.0

Description: Replaces siph:set_prop enable_distance_sensor. (Deprecated alias — see siph:set_prop.)

siph:fiber_power_reading

Sentio Version: 3.7.0

Description: Moves the chuck to the probe position of the power calibration site and returns the power value.

Parameters:

Parameter	Type	Values	Notes
Positioner ID (opt.)	Integer / String	1/East/Right, 2/West/Left
Power unit (opt.)	String	mWatt, dBm
Wavelength (opt.)	Integer	—	Range 750–1800

Response:

Field	Type	Example
Power meter value	Integer	1234

Examples:

Command:   siph:fiber_power_reading
Response:  0,0,1234     (reads current power meter data)

Command:   siph:fiber_power_reading East,dBm,1050
Response:  0,0,1234     (moves chuck under East positioner, sets unit dBm and wavelength 1050 nm, returns 1234)

siph:set_prop

Sentio Version: 3.7.0

Description: Generic function to set the value of a specific data item of the SiPH module.

Parameters:

Parameter	Type	Values
Property Name	String	enable_distance_sensor (True/False), alignment_range (needs additional parameters), alignment_frequency (needs additional parameters), alignment_velocity (needs additional parameters)

Additional parameters (for alignment_* properties): Positioner (East/West), Fiber Type (Single/Array/Lensed), Search Type (Coarse/Fine).

Response:

Field	Type	Values
Setup	String	OK

Examples:

Command:   siph:set_prop alignment_range,east,single,coarse,20,25
Response:  0,0,OK     (sets 1st range 20 µm, 2nd range 25 µm; East positioner, single fiber, coarse search)

Command:   siph:set_prop enable_distance_sensor,true
Response:  0,0,OK     (enables the SiPH distance sensor)

Remarks: Functionally the same as siph:set_cap_sensor_distance_search and siph:set_prop enable_distance_sensor.

---