Getting Started

Use this page for a first connection to a Koheron V1 firmware controller. Keep the product user guide available for connector pinout, wiring, safe operating limits, and product-specific setup.

1. Connect over serial

Connect to the UART serial interface with the default settings from Serial Interface: 115200 baud, 8 data bits, no parity, 1 stop bit, and no flow control.

Send one command line at a time. Wait for the response before sending the next command.

2. Identify the device

Read the identification values before changing settings:

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

The IDN?, version, model, and serial responses should match the expected product and serial number.

3. Check and decode errors

Read the current 32-bit error mask with err:

>> err
0

A non-zero response means at least one error bit is active. Hexadecimal responses may omit leading zeros, so 4 means mask 00000004.

Use errlist on the connected device to decode the bit positions. errlist is the authoritative bit-index list for that product firmware: line 0 is bit 0, line 1 is bit 1, and so on. The common error prefix uses bits 0..17, and product-specific errors start at bit 18.

>> errlist
UART_RX_OVERFLOW
CMD_FRAME_TOO_LONG
CMD_UNKNOWN
CMD_INVALID_ARG
CMD_ARG_OUT_OF_RANGE
CMD_ACCESS_DENIED
...

After reviewing and correcting the cause, clear reviewed errors with errclr:

>> errclr
ffffffff
>> err
0

errclr is a write command and requires normal mode or higher.

4. Read or change user mode

Read the current access mode with usrmode:

>> usrmode
2

Mode 1 is normal mode. Mode 2 is advanced mode. Use normal mode for ordinary writable settings and error clearing. Use advanced mode for advanced configuration writes such as save.

>> usrmode 1 11111
1
>> usrmode 2 22222
2

See User Modes before writing scripts that change access mode.

5. Change a simple setting

For a first write test, choose a low-risk setting from the product command reference. The example below reads and changes the binary status mask with stmsk:

>> stmsk
ffffffff
>> stmsk ff
ff
>> fmt%
<field list for the current mask>

After changing stmsk, read fmt% so host software uses the current active field selection.

6. Save settings that should persist

Most changed settings apply immediately but are restored at startup only after save and only when the saved configuration is loaded at boot.

>> save
A1B2
>> ecrc
A1B2

save is a no-argument write command and requires advanced mode. ecrc reports the saved configuration CRC.

Next pages

• Serial Interface for command pacing, prompts, and raw binary responses.
• User Modes for access rules and command validation order.
• User Configuration for defaults, saved EEPROM configuration, CFG switch behavior, and configuration CRC.
• Errors for error masks, common error bits, and clearing errors.
• Binary Status for %, fmt%, fmtlist, and stmsk.
• API command reference for product-specific command pages.