Configurator

Table of Contents

• Overview
• System Requirements
• Installing the .NET 10.0 Desktop Runtime
• Connecting to the Target
• Creating and Configuring a Workspace
  • Selecting the Protocol Description Files
  • Configuring EtherCAT Enum Indexes
• Generating the Host Configuration
  • Protocol Consistency
  • FastBoot
• Flashing the Firmware (Target View)
• Finalizing

Overview

This guide explains how to create an ICS Configurator workspace, generate the host configuration files, and program the target firmware.

The workflow assumes that the target bootloader is already installed and that you completed the Quick Start (board setup, Config Mode, UART connection). It covers PC runtime installation, workspace configuration, code generation, and direct target programming with ICS Configurator.

System Requirements

• A Windows version supported by the Microsoft .NET 10.0 Desktop Runtime.
• Microsoft .NET 10.0 Desktop Runtime (Windows).
• ICS Configurator, the protocol description files (ESI, GSDML, or EDS and JSON) for the target application, and the SDK firmware files.

Installing the .NET 10.0 Desktop Runtime

The Configurator requires the Microsoft .NET 10.0 Desktop Runtime. If the runtime is missing, launching the Configurator displays an error dialog with a link to the Microsoft download page.

.NET Desktop Runtime installation error

1. Launch the Configurator. If the runtime is missing, click the download link in the error dialog.
2. Download the .NET 10.0 Desktop Runtime installer for your operating system and run it.
3. Follow the on-screen instructions and accept the license terms.
4. Launch the Configurator again and confirm that it starts without the missing-runtime error.

The runtime only needs to be installed once per computer.

Connecting to the Target

Select Config Mode and connect the board before opening the Configurator connection.

1. With the boards unpowered, fit the CN11 jumper on the ICS Development Board (between GPIO58 and GPIO59) to select Config Mode. Removing the jumper selects Run Mode.
2. Connect the 5 V supply, then connect the micro-USB cable from the Carrier Board to the PC.
3. Close any serial terminal or other application using the device COM port.
4. Launch ICS Configurator, then create or open a workspace (.ics).
5. Open the Target tab and select the device COM port. The port is listed in the Windows Device Manager under Ports (COM & LPT). ICS Configurator uses 115200 baud.
   

   Windows Device Manager
6. Click Connect.
   

   ICS Configurator COM port selection
7. Press the RESET button on the ICS Development Board. Look for the decoded startup message Enter config mode. in the Target output area. It confirms that the bootloader is in Config Mode and ready for programming.
   

   Expected decoded Config Mode startup message

If the message is absent, check the selected COM port, close other serial sessions, confirm that the CN11 jumper is fitted, and press RESET again.

Creating and Configuring a Workspace

When the Configurator starts without a loaded workspace, it shows an empty workspace screen.

ICS Configurator home view

Button	Action
New Workspace	Choose a save location, enter a workspace file name, and click Open. A workspace with default settings is created.
Open Workspace	Select an existing .ics file and click Open.
Save	Save the current configuration.
About	Show information about the application.

Note

Save the workspace after making configuration changes, either with Save or by closing the workspace. Changes are saved automatically on exit.

Once a workspace is open, the Overview tab shows the configuration fields.

ICS Configurator workspace view

Field	Description
Protocol Selection	Select EtherCAT for the example in this guide. Select PROFINET or EtherNet/IP for the corresponding application.
Fast Boot Enabled	Set to False for the EtherCAT workflow shown here. See the FastBoot note below.
Output Folder	Directory in which the generated files are stored.
Generate Firmware	Leave False for direct flashing from the Target view. Set True to also generate target_firmware.c for firmware provisioning from the host.
Firmware Download Retries	Number of retries for the firmware download. Default: 5.
Wait to write memory response	True or False. Default: False.

ICS Configurator output folder selection

Selecting the Protocol Description Files

The catalog fields contain the protocol descriptions used for code generation. Use the files supplied for the target application. These files are separate from the firmware selected in the Target view.

Protocol	Catalog file
EtherCAT	ESI XML file
PROFINET	GSDML XML file
EtherNet/IP	EDS file in Catalog and its matching JSON description in JsonCatalog

For EtherCAT:

1. In the EtherCAT section, click Browse in the Catalog field.
2. Select the ESI XML file supplied for the EtherCAT application. The illustrated example uses TICS100MOD Simple.xml.

ICS Configurator EtherCAT ESI selection

Configuring EtherCAT Enum Indexes

The EtherCAT tab lets you assign an index to each enum defined in the ESI file. The Enums list is populated automatically once an XML file is selected in the Overview tab.

ICS Configurator EtherCAT enum index configuration

1. Open the Overview tab and select the XML file, if not already done.
2. Open the EtherCAT tab. The enums found in the XML file are listed in Enums.
3. Select an enum and enter the required value in the Index field of the property grid.
4. Repeat for each enum, then click Save.

Note

If the Enums list is empty, check that a valid XML file is selected in the Overview tab, and reopen the workspace.

Generating the Host Configuration

Once the configuration is complete, click Generate to create the source code.

ICS Configurator code generation

A Generator Result dialog shows the generation output, including any warnings or errors. On success, the files are created in the Output Folder.

Generated file	Content
repository.c, repository.h	Repository of the selected protocol
device_settings.c	Device configuration, including the protocol selection (ProtocolIndex)
channel_settings.c	Channel settings of the selected protocol
target_firmware.c	Firmware data for provisioning from the host. Generated only when Generate Firmware is True

Generated output

Add the generated files to your host application project. Build the host application with the files generated for the protocol that is flashed on the module. The examples describe where to copy them, see Examples.

Protocol Consistency

The Protocol Selection of the workspace sets ProtocolIndex in the generated device_settings.c. The Linux host application user.c copies the corresponding deviceConfigObjects entry into its device configuration.

ProtocolIndex	Protocol
0	EtherCAT
1	PROFINET
2	EtherNet/IP

Select the intended protocol, regenerate the files, and use them in the matching host build. Keep the protocol selection in the workspace so that regenerated settings remain consistent.

Generated protocol setting in device_settings.c

FastBoot

FastBoot is set to False in this guide and in the provided example configuration. For PROFINET, FastBoot is typically set to True. Enabling FastBoot locks the selected protocol: it cannot be changed afterwards.

Flashing the Firmware (Target View)

The Quick Start describes the same procedure in short form, see Quick Start. Use this section for the details of the Target view.

1. Click the Target button in the navigation bar at the bottom of the Configurator to open the Firmware Update view.
2. Close any other serial session using the device COM port, then select that COM port.
   

   ICS Configurator device COM connection
3. Click Connect. The button changes to Disconnect when the port is open. Connection errors appear in red.
4. With the CN11 jumper fitted, press RESET on the ICS Development Board and verify Enter config mode. in the decoded output before flashing.

The decoded target log at the bottom of the Target view shows the startup mode and, during flashing, the programming activity.

ICS Configurator decoded programming log

Two controls manage the log:

• Clear Output clears all log messages.
• Autoscroll turns automatic scrolling on or off.

The Firmware Update section lists each protocol and its firmware folder. Default folder paths are resolved relative to the saved .ics workspace location.

1. For each protocol to be programmed, click the ellipsis (**...**) button of its folder field and select firmware/Ethercat, firmware/EthernetIp, or firmware/Profinet in the SDK. Confirm that the MCELF and XIP fields show the corresponding file names.
   

   ICS Configurator: firmware folders and connected target

2. With the target connected in Config Mode and the firmware folders checked, click Flash. Progress is shown in the application.

   

   ICS Configurator firmware flashing progress

   Note

   There can be a short delay before the progress bar starts moving. This is expected. Wait until the operation completes.

3. When programming completes, ICS Configurator displays Flashing completed successfully. Acknowledge the dialog.
   

   ICS Configurator firmware flashing completion

Finalizing

After a successful firmware update:

1. Switch off target power and remove the CN11 jumper. Keep the CN5 OSPI boot selection unchanged.
2. Power on the target again.

The target boots in Run Mode and starts the programmed application.