E-Sharp Helpcenter
E-Sharp Helpcenter
Breadcrumbs

List command

List Channels

Description

The list command displays all available channels and their current values. It provides a quick overview of the hardware state and can be filtered to show specific channels.

Syntax

Bash
list [options]

Optional Options

Option

Short

Description

Default

--filter

-f

Apply a regular expression filter to channel names

(none)

--disabled

-d

Show disabled channels in addition to enabled ones

false

Examples

List All Enabled Channels

Bash
list

List All Channels (Including Disabled)

Bash
list --disabled

Filter by Pattern

Bash
list --filter "VOLTAGE.*"
Bash
list -f "GPIO_[0-9]+"

Combine Filter and Disabled

Bash
list --filter "TEMP.*" --disabled

Output Format

Channels are displayed in the format:

<channel_alias>                                              <value>

For example:

VOLTAGE_SENSOR_1                                             3.3
GPIO_PIN_5                                                   1
I2C_BUS_MAIN                                                 (<data>)
TEMPERATURE_AMBIENT                                          25.4
DISABLED_CHANNEL                                             (disabled)

Output Colors

  • Green: Enabled channels with values

  • Cyan: Special data channels (ByteStream, I2C, UART, etc.)

  • Gray: Disabled channels

Special Channel Types

Some channel types display (<data>) instead of actual values:

  • ByteStream channels

  • I2C channels

  • UART channels

  • SPI channels

  • Socket channels

  • Waveform channels

  • NumericResult channels

Performance Information

At the end of the output, query execution time is displayed:

Query took 45.23 ms

Behavior

  1. Retrieves all channels from the hardware

  2. Orders channels alphabetically by alias

  3. Filters by disabled state if requested

  4. Applies regex filter if provided

  5. Queries values for all enabled channels

  6. Displays results with color coding

Filter Patterns

The filter option supports standard .NET regular expressions:

Pattern

Matches

VOLTAGE.*

All channels starting with "VOLTAGE"

.*_SENSOR

All channels ending with "_SENSOR"

GPIO_[0-9]+

GPIO channels with numeric suffixes

(TEMP\\|VOLT).*

Channels starting with TEMP or VOLT

^ADC_CH[0-7]$

Exactly ADC_CH0 through ADC_CH7

Notes

  • Requires an active connection (use init first)

  • Large channel lists may take time to query

  • Values are fetched in a single bulk operation for efficiency

  • Disabled channels don't have values queried

Error Handling

Common errors:

  • Not connected: Run init command first

  • Invalid regex: Check filter pattern syntax

Performance Tips

  • Use filters to reduce output and query time

  • Disabled channels are skipped by default for faster results

  • Query time scales with number of enabled channels