Python Library Installation

Note

Prerequisites for Using the library:

  • A Python 3.x interpreter must be installed.

The installation of the Python library for the Capture Client involves the following simple steps :

  1. Open a terminal in the directory where the Python package was extracted. The default directory name is PyExoClient.

  2. Create a virtual environment by running:

    • python -m venv venv

  3. Activate the virtual environment:

    • On Linux: source venv/bin/activate

    • On Windows: venv\\Scripts\\activate

  4. Update pip to the latest version by running:

    • pip install --upgrade pip

  5. Install the PyExoClient library wheel by executing:

    • pip install *.whl

IMPORTANT NOTE

Before using the library, please customize the example/test_config.py file (details below).

Example usage can be found in the ‘examples’ folder. All files (except test_config.py) demonstrate various features of the library.

The test_config.py file contains global constants that are used across the example scripts. The following constants need to be modified according to your specific configuration:

  • BLADE_1_IP: The IP address assigned to the Blade.

  • SESSION_1_UUID: The session ID number.

    This can be found in the Blade Client’s GUI. Open the Blade connection dialog by clicking the ‘Connect Probe’ button and connecting to the Blade. The session number will be displayed in the ‘Blade Sessions’ table.

  • LOGICAL_UNIT_1_UUID: The logical unit ID.

    This can be located in the ‘Session Logical Units’ table in the Blade Client’s GUI.

  • USER_PASSWORD: The user password defined on the Blade (default is ‘admin’).

  • DATA_PATH: Do not modify.

  • DUMP_PATH: The local directory where downloaded files will be saved.

  • FILE_1: The path to a project file.

  • CU_NAME_x: The capture unit names defined in the project file.

Exostiv Probe only requires DUMP_PATH, FILE_1, and CU_NAME_x to be updated.

Once the global constants are configured, you can begin using the example scripts.