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
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
conf --channel "VOLTAGE_SENSOR"
conf -c "ADC_CH0" -p "Enabled" -v "true"
conf -c "GPIO_PIN" -p "Direction" -v "IN"
conf -c "VOLTAGE_SENSOR" -p "Alias" -v "MainPowerRail"
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
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) |
NetName is the full hierarchical name — displayed but read-only.
Best Practices
- List before setting: check available properties first with
conf -c <channel>
- Verify changes: use
get to confirm changes took effect
- Test incrementally: change one parameter at a time
Notes
- Requires an active connection (use
init first)
- Changes take effect immediately via the API
- Values are validated by the API layer
Error Handling
- Channel not found: Verify channel name with
list
- Unknown parameter: Valid parameters are Alias, Direction, ChannelType, Description, Unit, GroupName, DeviceName, Enabled
- Type mismatch: Value doesn’t match parameter type (e.g., Enabled requires “true” or “false”)