pyalpha/README.md

   1 # PyAlpha
   2 PyAlpha sends alpha commands over a UART connection (via RS-232), useful for
   3 configuring an audio device under test.
   4
   5 ---
   6
   7 ## Dependencies
   8 - Windows 7
   9 - [Python 2.7 for Windows](https://www.python.org/ftp/python/2.7.12/python-2.7.12.msi)
  10
  11 ---
  12
  13 ## Usage
  14 **All commands run from the /tools/ directory**
  15
  16 `$ python pyalpha <options> [alphas]`
  17
  18 #### Configuration
  19 By default, configuration options are set in `tools/config.ini`. Setting a
  20 CLI flag will override the INI configuration for that specific option.
  21 The INI file can configure port, header file, baud rate, alpha directory,
  22 binary directory, and temporary storage location.
  23
  24 #### Alphas
  25 PyAlpha requires a list of one or more alpha commands separated by spaces or
  26 commas in their alphanumeric and/or hex representations.
  27
  28 #### Options
  29 - `-?`, `--help` display help dialogue
  30 - `-h <file>` uses this header for symbol definitions, as well as using a
  31   corresponding .hdM file for decomposition of received alpha commands. Similar
  32   to calfa, these header files are located in an `alpha/` directory which by
  33   default is expected to be found at `./alpha`, but this location can be
  34   changed with the `-I` flag.
  35 - `-p <port>` use this active serial communication port (default: COM1)
  36 - `-I <dir>` use this directory in the search path for alpha headers
  37 - `--repeat <num> <time>` repeat sending an alpha command <num> times with a delay
  38 of <time> seconds (floating point) between each send
  39 - `--fast` Don't perform any post-processing
  40 - `-r` Retain temporary files
  41 - `-s` Start a session using provided settings
  42   - type `exit` or `quit` to exit the session
  43   - type `cls` or `clear` to clear the session screen
  44   - From within a session, you can start typing and press `tab` to get a list of alpha commands
  45 (note: you must type 3 or more letters before `tab`-completion will work, and completion will
  46 not be effective if attempting to complete on 'write')
  47
  48 More options are listed in `--help`
  49
  50 #### Example
  51 All examples are run from the `tools/` directory
  52 -`$ python pyalpha readDECSourceProgram readPCMMode`
  53         - sends alpha commands `readDECSourceProgram` and `readPCMMode` using settings
  54 specified in the INI configuration
  55 -`$ python pyalpha -s`
  56         - starts a pyalpha session using settings specified in the INI configuration
  57 -`$ python pyalpha -p COM5 -h pa_other_hdr_a readDECSourceProgram`
  58         - sends `readDECSourceProgram` with `COM5` and `pa_other_hdr_a` overriding
  59 port and header settings in the INI configuration