graphyte: Add document for plugin shell

Add some instructions to use the plugin shell.

BUG=none
TEST=none

Change-Id: I67643621df8495a3a08dec80878768c73aa61b94
Reviewed-on: https://chromium-review.googlesource.com/586207
Commit-Ready: Shen-En Shih <petershih@chromium.org>
Tested-by: Shen-En Shih <petershih@chromium.org>
Reviewed-by: Chih-Yu Huang <akahuang@chromium.org>
1 file changed
tree: f2eda6565a783627e8959341cb1855a2ff4e2a16
  1. .gitignore
  2. Graphyte Flow.png
  3. MANIFEST.in
  4. Makefile
  5. README.md
  6. graphyte/
  7. pylintrc
  8. setup.py
  9. unittest_runner.py
README.md

Google Radio Phy Test Framework

Overview

Graphyte (Google RAdio PHY TEst) is a Python based software framework for the calibration and verification of wireless connectivity radios in design and manufacturing. It is designed with an open, extensible architecture enabling wireless silicon and instrumentation vendors to develop their own plugins for PHY calibration and verification. The initial focus is on Wi-Fi and Bluetooth with 802.15.4 on the horizon.

Please refer to the user manual for more details.

Build

No build step is required.

Install

Two options:

$ (sudo) make install

or

$ (sudo) pip install .

Uninstall

$ (sudo) pip uninstall graphyte

Distribution

  1. Create a tarball by: make dist The tarball can be found under the folder ‘dist’

  2. Copy the tarball to target machine

  3. Extract the tarball

  4. Inside the extracted folder, type the command to install:

     $ (sudo) pip install
    

User manual

Please find the user manual here for more details.

Interactive shell

An interactive shell is also implemented to analyze the interactions between a DUT and an instrument step by step.

Follow these steps to start the interactive shell:

  1. Install the graphyte framework and necessary plugins.

  2. Follow the user manual to create a valid config file.

  3. Run the interactive shell by:

    $ python -m graphyte.plugin_shell path/to/config/file