Next
ReferenceHardwareICDsCreate

Create ICDs

Create an ICD and its messages in the Console, Python, or TypeScript.

Create an ICD to describe the messages that a device sends. Then a read task can use it to turn each message into samples on channels.

When to create an ICD

When Do this
You add data to an MQTT read task in the Console Nothing. The Console creates an ICD with the name of the task, and a message for each topic.
You have a DBC file, or a spreadsheet of fields Import it into an ICD.
A script configures the task Create the ICD in the script, before it configures the task.

Create an ICD

  1. Open the ICD:

    • Click in the ICDs toolbar.
    • Run the “Create ICD” command from the command palette.

    The Console creates an ICD named “ICD”, with no messages, and opens it in a tab.

  2. Click the name at the top of the tab, and enter a new name.

  3. Click Add message. The new message is named “Message 1”, in the binary format.

  4. In the message details, enter a Name and select the Format: Binary, Text, or JSON.

  5. Click Add field for each value in the message, and fill in its properties.

Each edit saves at once. There is no save button.

Each message and field gets a key when you create it. Tasks refer to messages and fields by key, so you can rename them later. The ICD reference gives the properties of each format.

Check an ICD

A check finds the problems in an ICD, such as two messages with one name. Most problems do not stop a save. A value that breaks a rule of the ICD’s schema, such as a field with no name, does stop the save.

The editor checks the ICD shortly after each edit, and marks each problem on its property.

path is the place of the problem, such as messages.0.name. It is empty for a problem with the whole ICD. The problems in the reference say how to fix each one.

Use the ICD in a task

A task selects the messages that it reads and binds their fields to channels. To bind fields, see the MQTT read task.