CTL300E Command API

Public serial command reference for CTL300E V1 firmware.

Firmware V1 documentation · V1.0-rc54-2d701ce

Koheron products currently ship with firmware V0.x by default. Firmware V1 is under active development and is not publicly available yet.

This page lists product-specific and feature-specific public serial commands for CTL300E firmware. Universal commands are listed in the common command API.

Common commands

Command	Description	Type	Unit
`IDN?`	Identify device	R
`bdid`	Board ID	R/W
`brate`	UART Baud rate	R/W	baud
`ecrc`	EEPROM configuration CRC	R
`err`	Error code	R
`errclr`	Clear errors	W
`errlist`	List supported error codes	R
`errmsk`	Error mask	R/W
`fmt%`	Active binary status fields	R
`fmtlist`	Supported binary status fields	R
`fmtseq`	Sequencer-writable command schema	R
`logerr`	Binary status snapshot on last error	R
`memr`	Read framed binary user memory page	R
`model`	Board model	R/W
`muxon`	UART multiplexing	R/W
`profiler`	MCU load profile	R
`regs`	Sequencer registers	R/W
`save`	Save configuration in EEPROM	R/W
`seqerr`	Sequencer error diagnostics	R
`seqstat`	Sequencer execution status	R
`sequ`	Sequenced memw execution	R/W
`serial`	Serial number	R
`stmsk`	Active binary status mask	R/W
`tboard`	Board temperature	R	°C
`tms`	Time since startup	R	ms
`userdata`	Read/Write user data	R/W
`usrmode`	User mode	R/W
`version`	Firmware version	R

Laser commands

Command	Description	Type	Unit	Default	Min	Max
`ilmax`	Software Current Limit	R/W	mA		0.0	2000.0
`iphd`	Photodiode Current	R	mA
`lason`	Disable \| Enable Laser Current	R/W		0	0	1
`lckon`	Disable \| Enable Interlock	R/W		0	0	1
`lcksts`	Lock Status	R
`ldelay`	Delay Boot to Laser ON	R/W	ms	1000	10	100000
`vlaser`	Laser Voltage	R	V

TEC commands

Command	Description	Type	Unit	Default	Min	Max
`itec`	TEC Current	R	A
`kprop`	Proportional Gain	R/W	V/°C	0.27	0.0	100.0
`ntccal`	NTC Calibration	R/W
`rtact`	Laser Thermistor	R	Ω
`rtmax`	Maximum Thermistor Resistance	R/W	Ω	15000.0	500.0	200000.0
`rtmin`	Minimum Thermistor Resistance	R/W	Ω	5000.0	500.0	200000.0
`rtset`	Laser Thermistor Setpoint	R/W	Ω	10000.0	`rtmin`	`rtmax`
`tact`	Laser Temperature	R	°C
`tder`	Differential Time	R/W	1/s	0.0	0.0	1000.0
`tdithon`	Enable TEC voltage dithering	R/W			0	1
`tecfs`	TEC Sampling Rate	R/W	Hz
`tecon`	Disable \| Enable TEC Current	R/W		0	0	1
`tint`	Integral Time	R/W	s	1.21	0.0	10000.0
`tmax`	Maximum Temperature Setpoint	R/W	°C
`tmin`	Minimum Temperature Setpoint	R/W	°C
`tmodgain`	TEC Modulation Gain	R/W		0.0	-100000.0	100000.0
`tprot`	Disable \| Enable Temperature Protection	R/W		0	0	1
`tset`	Temperature Setpoint	R/W	°C	25.0	-40.0	125.0
`vtmax`	Maximum TEC voltage	R/W	V	3.0	0.0	4.5
`vtmin`	Minimum TEC Voltage	R/W	V	-2.0	-4.5	0.0

Product-specific commands

Command	Description	Type	Unit	Default	Min	Max
`ain`	Analog input voltage	R	V
`bsel`	Status of the laser bias selection pin	R			0	1
`ibus`	Input supply current	R	A
`ila0`	Laser current channel 0	R/W	mA
`ila1`	Laser current channel 1	R/W	mA
`ilaser`	Laser current	R/W	mA	0.0	0.0	`ilmax`
`ilmon`	Monitored laser current	R	mA
`ipmin`	Min photodiode current	R/W	mA	0.01	0.0	10.0
`tilim`	TEC current limit	R/W	A	1.5	0.25	2.5
`tjunc`	Driver junction temperature	R	°C			113.0
`vbus`	Input supply voltage	R	V
`vldauto`	Disable \| enable automatic adjustment of vslaser	R/W		0	0	1
`vldrop`	Laser driver transistor drop	R/W	V	0.2	0.0	2.0
`vlmax`	Max laser voltage	R/W	V	2.5	0.0	4.0
`vlmin`	Min laser voltage	R/W	V	0.0	0.0	10.0
`vrsense`	Sense voltage	R	V
`vslaser`	Laser driver supply voltage	R/W	V	4.5	1.14	5.173
`vslmon`	Monitored laser supply voltage	R	V
`vstec`	VSTEC voltage	R/W	V	3.5	1.14	5.173
`vtec`	TEC voltage	R/W	V	0.0