Metadata-Version: 2.4
Name: protocol-validation-suite-framework-apis
Version: 26.7.1
Summary: A robust Protocol Validation Suite for generating, parsing, and validating protocol messages and conformance tests across protocol implementations.
License: Proprietary
License-File: LICENSE
Author: Soliton Technologies
Requires-Python: >=3.12
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: grpcio (>=1.81.1)
Requires-Dist: protobuf (>=6.33.5)
Description-Content-Type: text/markdown

# Soliton Protocol Validation Suite Framework APIs

A Python SDK for automating the Soliton Protocol Validation Suite (PVS).

This package provides a high-level Python interface for interacting with the "Soliton Protocol Validation Suite" application. It enables Integration of PVS workflows such as profile configuration, sequence compilation, and test execution workflows into custom Python-based automation frameworks.

## Features

* Launch and manage the PVS server
* Load and configure PVS projects
* Apply protocol validation profiles
* Configure and reset interposer boards (if supported by the active protocol plugin)
* Manage test condition files
* Compile validation sequences
* Execute validation sequences and retrieve reports

## Pre-requisite

* Protocol Validation Suite (PVS) application Installed. (If not please reach out to `pvs.support@solitontech.com`)
* Python 3.12 or later

## Python Dependencies Requirement

* grpcio
* protobuf

## Installation

```bash
pip install protocol-validation-suite-framework-apis
```
## Package Contents

The package includes:

* High-level PVS API wrappers
* gRPC client implementation
* Generated Protocol Buffer stubs
* Request and response models
* Example automation scripts

## Notes

* This package acts as a Python client SDK for the Protocol Validation Suite application. The actual Validation logic is executed by the PVS server.
* This package communicates with the server using gRPC and Protocol Buffers.

## Main API Operations

| Method                     | Description                          |
| -------------------------- | ------------------------------------ |
| `launch_server()`          | Start and connect to the PVS server  |
| `close_server()`           | Close the server connection          |
| `load_project()`           | Load a PVS project                   |
| `set_profile()`            | Apply a protocol validation profile  |
| `setup_interposer_board()` | Configure interposer board settings (Can only be used if the protocol plugin supports it)  |
| `reset_interposer_board()` | Reset interposer board configuration (Can only be used if the protocol plugin supports it) |
| `set_test_condition()`     | Configure test condition files       |
| `compile_sequence()`       | Compile a validation sequence        |
| `run_sequence()`           | Execute a validation sequence        |
| `mass_compile_sequence()`  | Compile multiple sequences           |

## Quick Start

```python
from Protocol_Validation_Suite_APIs.protocol_validation_suite_apis import (
    ProtocolValidationSuiteAPIs
)

api = ProtocolValidationSuiteAPIs()

if api.launch_server():
    api.load_project(
        r"C:\Path\To\Project\Sample_Project.pvsproj"
    )

    # Perform required operations

    api.close_server()
```

## Typical Workflow

1. Launch the PVS server
2. Load a PVS project
3. Apply a validation profile
4. Configure hardware and test conditions
5. Compile a validation sequence
6. Execute the sequence
7. Retrieve reports and results
8. Close the server connection

## License

**Proprietary**

Copyright © Soliton Technologies.

Redistribution, modification, or distribution of this package without prior authorization is prohibited.

