COM-Server Command Line Interface
Run com_server -h to get this message:
> com_server -h
COM_Server command line tool
A simple command line tool to start the API server that interacts
with the serial port in an development environment or a
production environment.
The server started by the CLI will contain routes for all supported
versions of the builtin API.
Usage:
com_server run <baud> <serport>... [--env=<env>] [--host=<host>] [--port=<port>] [--s-int=<s-int>] [--to=<to>] [--cors] [--no-rr] [-v | --verbose]
com_server -h | --help
com_server --version
Options:
--env=<env> Development or production environment. Value must be 'dev' or 'prod'. [default: dev].
--host=<host> The name of the host server (optional) [default: 0.0.0.0].
--port=<port> The port of the host server (optional) [default: 8080].
--s-int=<s-int>
How long, in seconds, the program should wait between sending to serial port [default: 1].
--to=<to> How long, in seconds, the program should wait before exiting when performing time-consuming tasks [default: 1].
--q-sz=<q-sz> The maximum size of the receive queue [default: 256].
--cors If set, then the program will add cross origin resource sharing.
--no-rr If set, then turns off /register and /recall endpoints, same as setting has_register_recall=False
-v, --verbose Prints arguments each endpoints receives to stdout. Should not be used in production.
-h, --help Show help.
--version Show version.
>
Notes:
- The CLI now supports adding multiple ports. The program will try the ports in the order they are given and use the first port that works.
> com_server run 115200 /dev/ttyACM0 /dev/ttyUSB0 /dev/ttyUSB1
The program will first try /dev/ttyACM0, then /dev/ttyUSB0, then /dev/ttyUSB1, and it will use the first serial port that works.