SICK TriSpector1000

12.3 Available commands for command channel
12.3.1 Sending a command
■
Add the command delimiter bytes stx (0x02) and etx (0x03) to mark the begin‐
ning and end of a command.
■
Use single spacing between a command and an argument, and between argu‐
ments.
■
Use quoted text for string arguments and unquoted text for all other argument
types.
12.3.2 Command examples
Select a job:
<stx>set job "job0"<etx>
Enable object triggering:
<stx>set imageTriggerMode Object<etx>
Get all settings for a tool named "Fix Plane 1":
<stx>get tool "Fix Plane 1"<etx>
Get the XZ Angle for a fixed plane tool named "Fix Plane 1":
<stx>get tool "Fix Plane 1" XZAngle<etx>
Set the XZAngle for a fixed plane tool to 42.0:
<stx>set tool "Fix Plane 1" XZAngle 42.0<etx>
12.3.3 General commands
Command Arguments Returns Description
set job string: job-name result Select active job, by name.
get job string: job-name Get the name of the active
job.
set exposure int: exposure result Set the sensor exposure
time, in microseconds.
get exposure int: exposure Get the sensor exposure
time, in microseconds.
set gain real: gain result Set the sensor gain factor.
get gain real: gain Get the sensor gain factor.
set imageTrigger‐
Mode
enum: imageTriggerMode
[Input, None, Object, Com‐
mand]
result Set the image trigger
mode.
get imageTrigger‐
Mode
enum: imageTrig‐
gerMode [Input,
None, Object,
Command]
Get the image trigger
mode.
set laser enum: enable [on, off] result Turn the laser on or off.
set laserThresh‐
old
int: threshold result Set the intensity threshold
for detecting the laser.
get laserThresh‐
old
int: threshold Get the intensity threshold
for detecting the laser.
set profileDis‐
tance
real: distance result Set the distance between
profile acquisitions, in mm.
APPENDIX 12
8021808/12ID/2019-01 | SICK O P E R A T I N G I N S T R U C T I O N S | TriSpector1000
67
Subject to change without notice