added help

0fcee207 · Alén Arias Vázquez · 4154b0f7 · 0fcee207
Commit 0fcee207 authored Mar 22, 2022 by Alén Arias Vázquez 😎
Hide whitespace changes
Inline Side-by-side

Showing with 21 additions and 2 deletions

README.md cpx400dp/README.md +21 -2

No files found.
--- a/cpx400dp/README.md
+++ b/cpx400dp/README.md
@@ -5,6 +5,25 @@
 python class to control remotely the power supply bia USB

 ## How to use it
-'''console
+```console
 python3 cpx400dp -h
-'''
+```
+the help menu is shown below:
+
+```bash
+usage: cpx400dp.py [-h] [--device DEVICE] [--baudrate BAUDRATE] [--chan CHAN] [--volts VOLTS] [--amps AMPS] [--powerup]
+
+Control CPX400DP from USB
+
+optional arguments:
+  -h, --help            show this help message and exit
+  --device DEVICE, -D DEVICE
+                        Linux device name (default: /dev/tty_CPX)
+  --baudrate BAUDRATE, -b BAUDRATE
+                        Serial baudrate (default: 115200)
+  --chan CHAN, -C CHAN  Channel selector (default: 1)
+  --volts VOLTS, -V VOLTS
+                        Volts (default: 12.0)
+  --amps AMPS, -A AMPS  Amps (default: 0.2)
+  --powerup             Switch On requested channel with requested values (default: False)
+```