Update pyAlpha from ssh://git@bitbucket.itg.ti.com/pasdk/tools.git, branch=master...
[processor-sdk/performance-audio-sr.git] / tools / 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.
5 ---
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)
11 ---
13 ## Usage
14 **All commands run from the /tools/ directory**
16 `$ python pyalpha <options> [alphas]`
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.
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.
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
41 More options are listed in `--help`
44 #### Example
45 `$ python pyalpha -h pa_i13_evmda830_io_a -p COM1 <alphas>`