diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7b7224a --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2022 BOZET Herwin + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/NibblePoker.Application.ListComPort/Program.cs b/NibblePoker.Application.ListComPort/Program.cs index bf524bc..f2f377e 100644 --- a/NibblePoker.Application.ListComPort/Program.cs +++ b/NibblePoker.Application.ListComPort/Program.cs @@ -78,8 +78,8 @@ internal static class Program { Console.WriteLine(""); Console.WriteLine("GitHub repositories:"); Console.WriteLine("├─> https://github.com/aziascreations/DotNet-Arguments"); + Console.WriteLine("├─> https://github.com/aziascreations/DotNet-ListComPort"); Console.WriteLine("└─> https://github.com/aziascreations/DotNet-RegistryHelpers"); - // TODO: Add final repo link here ! Console.WriteLine(""); Console.WriteLine("This software and all its libraries are licensed under the MIT license."); return ErrorCodes.NoError; diff --git a/build.bat b/build.bat index d5e3ef0..ca6073b 100644 --- a/build.bat +++ b/build.bat @@ -21,16 +21,6 @@ dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.Li dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-arm -c Release -o "./Builds/arm_single" --no-self-contained -p:PublishSingleFile=true -p:PublishReadyToRun=true dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-arm64 -c Release -o "./Builds/arm64_single" --no-self-contained -p:PublishSingleFile=true -p:PublishReadyToRun=true -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-x86 -c Release -o "./Builds/x86_sc" --self-contained true -p:PublishReadyToRun=true -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-x64 -c Release -o "./Builds/x64_sc" --self-contained true -p:PublishReadyToRun=true -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-arm -c Release -o "./Builds/arm_sc" --self-contained true -p:PublishReadyToRun=true -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-arm64 -c Release -o "./Builds/arm64_sc" --self-contained true -p:PublishReadyToRun=true - -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-x86 -c Release -o "./Builds/x86_sc_trim" --self-contained true -p:PublishReadyToRun=true -p:PublishTrimmed=true -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-x64 -c Release -o "./Builds/x64_sc_trim" --self-contained true -p:PublishReadyToRun=true -p:PublishTrimmed=true -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-arm -c Release -o "./Builds/arm_sc_trim" --self-contained true -p:PublishReadyToRun=true -p:PublishTrimmed=true -::dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-arm64 -c Release -o "./Builds/arm64_sc_trim" --self-contained true -p:PublishReadyToRun=true -p:PublishTrimmed=true - dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-x86 -c Release -o "./Builds/x86_single_sc_trim_comp" --self-contained true -p:PublishReadyToRun=true -p:PublishTrimmed=true -p:PublishSingleFile=true -p:EnableCompressionInSingleFile=true dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-x64 -c Release -o "./Builds/x64_single_sc_trim_comp" --self-contained true -p:PublishReadyToRun=true -p:PublishTrimmed=true -p:PublishSingleFile=true -p:EnableCompressionInSingleFile=true dotnet publish "./NibblePoker.Application.ListComPort/NibblePoker.Application.ListComPort.csproj" --nologo -r win-arm -c Release -o "./Builds/arm_single_sc_trim_comp" --self-contained true -p:PublishReadyToRun=true -p:PublishTrimmed=true -p:PublishSingleFile=true -p:EnableCompressionInSingleFile=true diff --git a/readme.md b/readme.md index e69de29..de8b6a4 100644 --- a/readme.md +++ b/readme.md @@ -0,0 +1,103 @@ +# DotNet-ListComPort + +A simple cli tool that can list COM ports with their full name easily and cleanly. + +This tool is intended to replace the tedious task of having to use the `mode` command, and the *Device Manager* to find +a newly plugged-in device that provides a COM port. + +This version of the program is a complete refactoring of my old [PB-ListComPort](https://github.com/aziascreations/PB-ListComPort) +project that also changes from the proprietary and paid *PureBasic* language and compiler to *.NET 6.0*. + +The latest releases can be found here: "*[Release page](https://github.com/aziascreations/DotNet-ListComPort/releases)*" + +## Requirements +* Windows + * Any CPU architecture +* .NET 6.0 + * Can be optional if using the larger "self-contained" builds. + +## Improvements over [PB-ListComPort](https://github.com/aziascreations/PB-ListComPort) +* Switched from *PureBasic* to *.NET 6.0*. +* Improved **a lot** of the program's logic. +* Added the `-h`/`--short-help`. +* Added support for Windows ARM & ARM64 + +## Usage +``` +lscom.exe [-a|--show-all] [-d|--show-device] [-D |--divider ] [-f|--show-friendly] + [-h|--help] [-H|--short-help][-n|--show-name-raw] [-P|--no-pretty] [-s|--sort] + [-S|--sort-reverse] [-t|--tab-padding] [-v|--version] [-V|--version-only] + +Launch arguments: + -a, --show-all Display the complete port's name (Equal to '-dfn') + -d, --show-device Displays the port's device name + -D , --divider Uses the given string or char as a separator (Can be empty string !) + -f, --show-friendly Displays the port's friendly name + -h, --help Display the help text + -H, --short-help Display the short help text + -n, --show-name-raw Displays the port's raw name (See remarks section) + -P, --no-pretty Disables the pretty printing format (Equal to -D " ") + -s, --sort Sorts the port based on their raw names in an ascending order + -S, --sort-reverse Sorts the port based on their raw names in a descending order + -t, --tab-padding Use tabs for padding between the types of names (Overrides '-D') + -v, --version Shows the utility's version number and other info + -V, --version-only Shows the utility's version number only (Overrides '-v') +``` + +## Remarks +* If '-d' or '-f' is used, the raw name will not be shown unless '-n' is used. +* If '-D', '-t' or '-p' are used, the special separator between the raw and friendly name and the square brackets are not shown. +* By default, the ports are sorted in the order they are provided by the registry, which is often chronological. +* The 'raw name' refers to a port name. (e.g.: COM1, COM2, ...) +* The 'device name' refers to a port device path. (e.g.: \Device\Serial1, ...) +* The 'friendly name' refers to a port name as seen in the device manager. (e.g.: Communications Port, USB-SERIAL CH340, ...) +* Any result returned with an error code between 1-9 and 30-39 should be considered as invalid. +* Any result returned with another error code is valid but probably not formatted properly. + +## Output formatting +``` + *┬> No launch arguments: + └──> ${Raw name} => COM1 + *┬> '-d' or '-f' + ├──> ${Device name} => \Device\Serial1 + └──> ${Friendly name} => Communications Port + *┬> '-d' and '-f' + └──> ${Friendly name} [${Device name}] => Communications Port [\Device\Serial1] + *┬> '-n' and '-d' + └──> ${Raw name} [$DeviceName] => COM1 [\Device\Serial1] + *┬> '-n' and '-f' + └──> ${Raw name} - ${Friendly name} => COM1 - Communications Port + *┬> '-ndf' or '-a' + └──> ${Raw name} - ${Friendly name} [${Device name}] => COM1 - Communications Port [\Device\Serial1] + *┬> '-ndfp' or '-ap' + └──> ${Raw name} ${Friendly name} ${Device name} => COM1 Communications Port \Device\Serial1 + *┬> '-ndfD ";"' or '-aD ";"' + └──> ${Raw name};${Friendly name};${Device name} => COM1;Communications Port;\Device\Serial1 +``` + +## Error codes +Here is a subset of the [old error codes](https://github.com/aziascreations/PB-ListComPort#error-codes) that applies to this rewritten version of the program. + +* Internal argument parser errors (10-19): + * 10 - Failed to parse the launch arguments, default options will be used. +* External argument errors (20-29): + * 20 - No value can be found for the '-D' argument, it will be ignored. +* Application and system errors (30-39): + * 31 - No COM port could be found. + +## Cloning & Building +You can simply clone the repository with the following command: +```bash +git clone https://github.com/aziascreations/DotNet-ListComPort.git +``` + +Once this is done, you can compile it with the following script files: + +| Linux | Windows | +|----------------------|------------------------| +| [build.sh](build.sh) | [build.bat](build.bat) | + +Finally, you should be able to find the executables in the "[Builds](Builds/)" folder. + +## License +This project and all the libraries it uses are licensed under the [MIT](LICENSE) license.