HTC200 Command API

Public serial command reference for HTC200 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 HTC200 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

TEC commands

Command	Description	Type	Unit	Default	Min	Max
`itec`	Set TEC/Heater current	R	A	0.0
`kprop`	Proportional Gain	R/W	A/°C	0.27	0.0	100.0
`ntccal`	NTC Calibration	R/W
`rtact`	Laser Thermistor	R	Ω
`rtmax`	Maximum thermistor resistance. If almode set to TPROT, ALM is raised above this value.	R/W	Ω
`rtmin`	Minimum thermistor resistance. If almode set to TPROT, ALM is raised below this value.	R/W	Ω
`rtset`	Laser Thermistor Setpoint	R/W	Ω
`tact`	Laser Temperature	R	°C
`tder`	Differential Time	R/W	1/s	0.0	0.0	1000.0
`tecfs`	TEC Sampling Rate	R/W	Hz
`tecon`	Disable \| enable TEC/Heater current	R/W			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
`tset`	Temperature Setpoint	R/W	°C	25.0	-40.0	125.0

Product-specific commands

Command	Description	Type	Unit	Default	Min	Max
`ain`	Analog input voltage	R	V
`almode`	Set the ALM mode	R/W
`curron`	Enable current source	R/W		0	0	1
`ibus`	Input supply current	R	A			500.0
`intmode`	Set the INT pin mode	R/W
`irtdon`	Enable RTD current	R/W		0	0	1
`itmax`	Maximum TEC/Heater current	R/W	A	4.1	0.0	4.1
`itmin`	Minimum TEC/Heater current	R/W	A	0.0	0.0	4.1
`itmon`	Monitored TEC/Heater current	R	A
`nvcca`	NVCCA voltage	R	V
`rtdmode`	RTD mode	R/W
`rtec`	TEC/Heater resistance	R	Ω
`sign`	Feedback sign	R/W
`tdithon`	Enable TEC voltage dithering	R/W			0	1
`tjunc`	Driver junction temperature	R	°C			120.0
`ttol`	Temperature-stability tolerance	R/W	°C	0.01	0.0	100.0
`tvlim`	TEC/Heater voltage limit	R/W	V	20.2	1.0	20.2
`vbus`	Input supply voltage	R	V		8.0	34.0
`vdauto`	Automatic voltage drop compensation	R/W		1	0	1
`vdfac`	Voltage drop factor	R/W		1.0	1.0	10.0
`vdrop`	TEC voltage drop	R/W	V	0.2	0.0	1.0
`vstec`	VSTEC voltage	R/W	V	10.0	0.6	22.2
`vston`	Enable VSTEC output	R		0	0	1
`vtec`	Monitored TEC/Heater voltage	R	V