alias – alias files

Manages alias files that map channel names to readable aliases — upload, download and activate a configuration.

View as Markdown (for AI/KB)

Description

The alias command manages alias configuration files that map channel names to more user-friendly aliases. This allows you to upload custom alias files, download existing ones, and activate specific configurations.

Syntax

alias [options]

Options

Option Short Description
--upload -u Path to an alias file to upload (does not activate)
--download -d Name of the alias file to download
--activate -a Name of the alias file to activate

Examples

alias                                        # list available alias files
alias --upload "C:\configs\my_aliases.xml"
alias --download "custom_aliases.xml"
alias --activate "custom_aliases.xml"

File Formats

Alias files use XML (.xml) or config (.config) format and map NetName to Alias:

<Channel NetName="CH_VOLTAGE_01" Alias="MainPower_5V" />
<Channel NetName="CH_GPIO_12" Alias="LED_Status" />

Important Notes

  • Upload does NOT activate. You must explicitly activate after upload.
  • After activating, commands accept the alias names, the original NetNames, or regex against either.
  • Alias files persist across resets and reboots.

Workflow Example

alias --download "current.config"            # 1. back up current config
alias --upload "C:\configs\updated_aliases.xml"  # 2. upload new
alias                                        # 3. verify it appears
alias --activate "updated_aliases.xml"       # 4. activate
list                                         # 5. verify aliases
# alias --activate "current.config"          # 6. revert if needed

Error Handling

  • File does not exist (upload): verify the file path
  • Invalid alias file: a rejected file won’t appear in the available list — validate the XML/config structure
  • The download operation prompts for a destination interactively and cannot be fully automated in script mode.

Book a demo of Probe

Show us your board — we review it and go through the findings together.

Prefer to email? info@esharp.se