Common Commands

Experimental V1 firmware documentation. Koheron products currently ship with V0.x firmware by default. V1 firmware executables are not publicly available yet. Please contact us if you are interested in early access or would like to evaluate V1 on your device.

This page describes commands provided by the common V1 firmware command layer. Product firmware may add laser, TEC, monitoring or calibration commands. Product-specific commands are listed in the product user guide.

Discovery

Use help to list public commands supported by the current firmware:

>> help
...

Use help command to print the help text for one public command:

>> help rtset
rtset ...

Hidden commands are not listed by help.

Identification

  • version: returns the firmware version string.
  • IDN?: returns a comma-separated identification string: manufacturer, model, serial number and firmware version.
  • model: returns the model string stored in device data.
  • serial: returns the serial number stored in device data.
  • bdid: returns or sets the decimal UART board ID used by addressed UART mode. Writing requires advanced access.

Example:

>> IDN?
Koheron,CTL200-X-X-XXX,12345,V1.x

Configuration and access

  • save: saves the current product configuration to EEPROM.
  • usrmode: reads or changes the current access mode.
  • userdata: reads or writes the user data string.
  • brate: reads or changes the UART baud rate. Writing requires advanced access.
  • muxon: reads or changes addressed UART mode. Writing requires advanced access.

save stores product operating parameters such as setpoints and limits. brate, muxon, bdid, errmsk, usrmode and sequ are stored by the UART configuration path when their corresponding command writes the setting.

See User Configuration, User Modes and UART Multiplexing.

Errors

  • err: returns the current error mask in hexadecimal.
  • errlist: lists the error names supported by the current product firmware.
  • errclr: clears errors. Without an argument it clears all errors. With a hexadecimal mask it clears only the selected bits.
  • errmsk: reads or writes the error mask. Writing requires normal access.

Example:

>> err
0
>> errclr
ffffffff

See Errors for details.

Monitoring

  • tboard: returns the board temperature in degrees Celsius.

Example:

>> tboard
25.45

Other monitoring commands are product-specific.

User memory and sequencer

  • memr: reads a 32-byte user EEPROM page.
  • memw: writes a 32-byte user EEPROM page. Writing requires advanced access.
  • sequ: reads or writes the sequencer run state. Writing requires advanced access.
  • regs: reads or writes sequencer registers. Register writes require advanced access.

See Sequencer and Advanced Features.

Binary and diagnostic commands

  • $: binary status block. Hidden.
  • fmt$: binary status field format. Hidden.
  • stscfg: product-specific text status/configuration line. Hidden.
  • logerr: last-error binary status block. Hidden.

See Binary Status.

Laser command group

Products that enable the laser command group provide common laser commands such as lason, vlaser, lckon, lcksts, ldelay and ilmax. CTL200 and CTL300E enable the laser command group.

TEC command group

Products that enable the TEC command group provide common temperature-control commands such as tecon, rtset, rtact, ntccal, tset, tact, itec, pgain, igain, dgain, rtmin, rtmax, tmin, tmax, vtmin and vtmax. CTL200, CTL300E and TEC200 enable the TEC command group, but command descriptions and units may differ by product.

[email protected]