Configure command | E-Sharp Helpcenter

Configure Channel

Description

The conf command configures channel properties. It allows you to view and modify specific channel settings including Alias, Direction, ChannelType, Description, Unit, GroupName, DeviceName, and Enabled.

Syntax

Bash

conf --channel <channel_name> [options]

Required Options

Option	Short	Description
`--channel`	`-c`	The channel name to configure

Optional Options

Option	Short	Description
`--parameter`	`-p`	The parameter to set (Alias, Direction, ChannelType, Description, Unit, GroupName, DeviceName, Enabled)
`--value`	`-v`	The value to assign to the parameter

Examples

List Channel Properties

Bash

conf --channel "VOLTAGE_SENSOR"

Set Boolean Property

Bash

conf -c "ADC_CH0" -p "Enabled" -v "true"

Set Enumeration

Bash

conf -c "GPIO_PIN" -p "Direction" -v "IN"

Set String Property

Bash

conf -c "VOLTAGE_SENSOR" -p "Alias" -v "MainPowerRail"

Output Format

Property Listing

Available Properties:
Alias                                    = MainPowerRail
NetName                                  = ADC_MODULE.CH0
Enabled                                  = True
Direction                                = IN
ChannelType                              = Analog
Description                              = Voltage measurement channel
Unit                                     = V
GroupName                                = PowerMonitoring
DeviceName                               = ADC_MODULE

Property Update

Setting Enabled to true

Output Colors

Blue: "Available Properties" header
Default: Property names and values
Green: Confirmation messages

Supported Parameters

Parameter	Type	Description
Alias	String	Short display name for the channel
Description	String	Descriptive text about the channel
Unit	String	Measurement unit (e.g., "V", "A", "°C")
GroupName	String	Logical grouping name
DeviceName	String	Associated device name
Enabled	Boolean	Enable/disable state (`true` or `false`)
Direction	Enum	DirectionTypes (e.g., IN, OUT, INOUT)
ChannelType	Enum	ChannelTypes (e.g., Analog, Digital)

Common Properties

The following properties are configurable via the conf command:

Alias - Short display name for the channel
NetName - Full hierarchical name (read-only, displayed but not settable)
Enabled - Enable/disable state
Description - Channel description
Direction - Channel direction (DirectionTypes enum)
ChannelType - Type of channel (ChannelTypes enum)
Unit - Measurement unit
GroupName - Logical group name
DeviceName - Associated device name

Use Cases

Explore Channel Configuration

Bash

# See all available settings
conf -c "VOLTAGE_SENSOR"

Enable/Disable Channel

Bash

# Disable channel
conf -c "UNUSED_ADC" -p "Enabled" -v "false"

# Re-enable
conf -c "UNUSED_ADC" -p "Enabled" -v "true"

Configure Direction

Bash

# Set channel direction
conf -c "GPIO_5" -p "Direction" -v "OUT"

# Set as input
conf -c "GPIO_5" -p "Direction" -v "IN"

Update Descriptions and Units

Bash

# Set description
conf -c "VOLTAGE_SENSOR" -p "Description" -v "Main power rail voltage"

# Set unit
conf -c "VOLTAGE_SENSOR" -p "Unit" -v "V"

Error Handling

Common errors:

Channel not found: Verify channel name with list
Unknown parameter: Valid parameters are Alias, Direction, ChannelType, Description, Unit, GroupName, DeviceName, Enabled
Invalid value: Check parameter type and allowed values (e.g., Direction must be a valid DirectionTypes enum value)
Type mismatch: Value doesn't match parameter type (e.g., Enabled requires "true" or "false")

Type Conversion

The command handles type conversion for supported parameters:

Bash

# String parameter
conf -c "SENSOR" -p "Alias" -v "PowerRail"

# Boolean parameter
conf -c "ENABLE" -p "Enabled" -v "true"

# Enum parameter
conf -c "GPIO" -p "Direction" -v "IN"

Best Practices

List before setting: Always check available properties first with conf -c <channel>
Verify changes: Use get to confirm changes took effect
Use correct parameter names: Valid parameters are: Alias, Direction, ChannelType, Description, Unit, GroupName, DeviceName, Enabled
Test incrementally: Change one parameter at a time
Understand enums: Direction and ChannelType use enumeration values from the API

Notes

Requires an active connection (use init first)
Changes take effect immediately via the API
Parameter names are case-insensitive internally but commonly used in PascalCase
Values are validated by the API layer
Only the parameters listed in the switch statement are supported