Koheron Firmware Manual

This manual documents Koheron firmware V1.

For users upgrading from firmware V0.x, see the migration guide.

Koheron V1 firmware is the serial-command firmware used by Koheron controller boards. This section documents behavior shared by the supported products: CTL20, CTL200, CTL300A, CTL300E, CTL300P, DRV700, HTC200, and TEC200. The command set and protection behavior remain product-specific; use the generated API for the connected product.

Product user guides remain the reference for connectors, electrical limits, laser wiring, TEC wiring, product-specific commands, and product-specific safety behavior.

What is common

• UART serial command line interface.
• ASCII commands for configuration, monitoring, diagnostics, and optional output control.
• Persistent configuration stored in EEPROM.
• User access modes for everyday and advanced operation.
• Error reporting through an error bitmask.
• Optional binary status blocks, user EEPROM pages, native sequencer execution, addressed UART operation, flash-integrity diagnostics, and the profiler.

Manual map

• Getting Started for first serial connection, identification, error checks, user mode, a simple write, and saving settings.
• Serial Interface for UART settings, command pacing, prompts, addressed operation, and raw binary responses.
• User Modes for read/write access rules and validation order.
• User Configuration for defaults, saved EEPROM configuration, CFG switch behavior, and configuration CRC.
• Errors for the 32-bit error mask, common error bits, errlist, errclr, and errmsk.
• Binary Status for %, fmt%, fmtlist, stmsk, and logerr.
• API command reference for generated product command pages.
• What's new in firmware V1 for the main new capabilities and user-visible changes.
• V0.x to V1 Migration Guide for upgrade and host-software migration notes.
• Main differences between V0.x and V1 for a concise compatibility overview.

Start with Getting Started for a practical first-use flow. If you are upgrading from V0.x firmware, follow the V0.x to V1 Migration Guide before operating the device.

Generated command pages and runtime discovery commands expose product-specific behavior. Use errlist for the connected device error layout, fmt% for the current active binary status fields, and fmtlist for the full supported binary status field list.

The common error prefix occupies bits 0 through 17; product-specific errors, when present, start at bit 18. Always use errlist rather than assuming a product-specific layout.

Command API

The generated command API lists public serial commands for each supported firmware product.

Open the command API

Safety and protection

Common firmware exposes error reporting, access modes, interlock-related command names when a product enables laser support, and product-specific protection settings. The actual protection thresholds, safe operating limits, and output shutdown behavior are product-specific. Do not infer a laser or TEC limit from this common manual unless the range is explicitly documented in the product user guide.