Skip to content

schiltz3/ComInfo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

73 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ComInfo

  • Run from the command line to display all Com Ports.
  • Nicknames: Devices can be given nicknames in a settings.json file.
  • Continuous mode: Updates display when USB serial devices are added or removed.
  • Command Line Substitution: Use the com port's alias with existing command line programs

Instalation

  • Download ComiSetup.exe from Releases and run the installer. Administrator is required as the installer adds Comi.exe to the system PATH

Running

  • Run comi from the command line
  • Alternatively, run ComiRun from the Windows Start Menu
  • Run comi -h to see all available options

Giving Ports Aliases

  • Run comi --save to save all current com ports to the settings.json found inside the Comi folder in your documents folder
    • Run comi -v to see where the settings.json file is saved
  1. Replace the "alias" field with what you want the COM port to be named

Using comi to substitute names for com ports

Running comi -a com_alias will return the com port related to that alias. ex: Windows Powershell

plink -serial -sercfg 115200,8,n,1,N $(comi -a "Tool UART 5")

Continuous update mode

comi -c opens in continuous mode to update as you plug in or remove com port devices CommInfo

Example settings.json

  • Only alias, product_id, and serial_number are required fields.
  • An empty alias fields prevent the port from being displayed
{
  "com_ports": [
    {
      "alias": "WLED",
      "product_id": 60000,
      "serial_number": "0001",
      "manufacturer": "Silicon Labs",
      "product_name": "Silicon Labs CP210x USB to UART Bridge"
    },
    {
      "alias": "",
      "product_id": 61254,
      "serial_number": "0002"
    }
  ]
}

Building

Debug

cargo build

Release

https://jrsoftware.org/isdl.php is required to build the installer

winget install "inno setup"
pip install -r requirements.txt
python .\build.py release --installer

About

Utility that displays COM port info

Resources

License

Stars

Watchers

Forks

Packages

No packages published