V1 Firmware

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.

Koheron V1 firmware is the current serial-command firmware used by Koheron controller boards based on the ADuCM362 firmware code base. This section documents behavior that is common to V1 controllers such as CTL200, CTL300E and TEC200.

Product user guides remain the reference for connectors, electrical limits, laser wiring, TEC wiring, product-specific commands and product-specific safety behavior. This section explains the common communication model and the common firmware features used by terminal users and software integrations.

What is common

The V1 firmware controllers share the same command infrastructure:

  • UART serial command line interface;
  • ASCII commands for configuration, monitoring and diagnostics;
  • read, write and action command patterns;
  • persistent configuration stored in EEPROM;
  • access levels for user and advanced operations;
  • error reporting through an error bit mask;
  • optional binary status blocks for efficient polling;
  • optional user EEPROM pages;
  • optional sequencer execution from EEPROM pages;
  • optional addressed UART operation for multi-controller links.

The exact set of product commands depends on the product firmware. For example, CTL200 and CTL300E enable both laser and TEC command groups, while TEC200 enables the TEC command group only.

  1. Serial interface
  2. Command syntax
  3. Common commands
  4. User configuration
  5. Errors
  6. User modes
  7. Python examples
  8. Binary status
  9. UART multiplexing
  10. Sequencer
  11. Advanced features

Basic workflow

Start by identifying the controller and firmware:

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

List available public commands:

>> help
...

Check errors before changing the configuration:

>> err
0

Read and change product-specific parameters:

>> rtset
10000.000
>> rtset 12000
12000.000

After verifying that the controller behaves as expected, save the configuration:

>> save
config saved

Use the product user guide to know which configuration is loaded at startup and how the CFG switch or CFG pin behaves for that controller.

Firmware version

Use version to check the firmware installed on the controller. Controllers running V0.x firmware should use the existing product documentation unless they have been updated to V1 firmware.

Public and advanced features

Not every command in the firmware is intended for normal use. Some commands are hidden from help and are meant for software integration, production, calibration or diagnostics. This documentation separates common user commands from advanced integration features.

See also

[email protected]