User Configuration

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.

Most operating parameters can be changed through the serial interface. A changed value is applied immediately. It is not necessarily loaded again at the next startup unless it is saved and the product startup configuration selects the saved configuration.

Save product configuration

Use save to store the current product configuration:

>> save
config saved

The exact list of saved product parameters is product-specific. Typical saved parameters include setpoints, current limits, voltage limits, protection settings and controller gains.

  1. Start from a known safe configuration.
  2. Change one parameter at a time.
  3. Verify the measured behavior with monitoring commands.
  4. Check err before saving.
  5. Send save only after the configuration is known to be safe for the connected load.
  6. Configure the product-specific CFG switch or CFG pin so the saved configuration is loaded at startup.

UART configuration

Some common settings are saved immediately by their own command rather than by the product save command:

  • brate: UART baud rate.
  • bdid: UART board ID.
  • muxon: addressed UART mode.
  • errmsk: error mask.
  • usrmode: user access mode.
  • sequ: sequencer enable state.

The firmware sanitizes saved values on readback. For example, invalid muxon values are treated as disabled, invalid sequ values are treated as stopped, and invalid user-mode values are restored as the default mode 2.

User data string

userdata reads a small user string stored in EEPROM:

>> userdata
my_label

To write it:

>> userdata write my_label
my_label

The string length is limited by the product firmware. Controllers using the common layout typically reserve 32 bytes including the terminating zero, so use short identifiers.

Device identity

serial and model are readable by users:

>> serial
12345
>> model
CTL200-X-X-XXX

Writing production identity fields is not part of the public user workflow.

User EEPROM pages

Advanced users can store binary data in EEPROM user pages with memw and read it back with memr. See Advanced Features before using these commands.

User modes

The current access mode controls which commands may write values. The default user mode is 2. See User Modes for details.

[email protected]