Soliton Protocol Validation Suite - SWI3S Peripheral Validation APIs
A Python SDK for automating the Soliton Protocol Validation Suite - "SWI3S Peripheral Validation Plugin".
This package provides a high-level Python interface for interacting with the Soliton "SWI3S Peripheral Validation Plugin" application for configuring, controlling, and automating SWI3S Peripheral Validation workflows through the Protocol Validation Suite (PVS). The package exposes high-level Python APIs that communicate with the underlying SWI3S Peripheral Validation service using gRPC, enabling automated validation, protocol configuration, monitoring, and test execution.
Features
- Python interface for SWI3S Peripheral Validation automation and validation
- gRPC-based communication with backend services
- High-level APIs for protocol configuration and execution
- Typed request and response models
- Integrated monitoring and acquisition support
- Example applications for quick integration
Pre-requisite
- Protocol Validation Suite (PVS) application and SWI3S Peripheral Validation Plugin Installed. (If not please reach out to
pvs.support@solitontech.com) - Python 3.12 or later
Python Dependencies Requirement
- grpcio
- protobuf
- protocol-validation-suite-framework-apis
All the above python dependencies are installed automatically when installing the package.
Installation
pip install protocol-validation-suite-swi3s-peripheral-validation-apis
Basic Usage
from Protocol_Validation_Suite_SWI3S_Peripheral_APIs import SWI3SPeripheralAPIs
api = SWI3SPeripheralAPIs()
# Launch and connect to the service
api.launch_server()
# Execute required operations
# ...
# Close the connection
api.close_server()
Refer to the included example scripts for complete workflow demonstrations.
Package Contents
Protocol_Validation_Suite_SWI3S_Peripheral_APIs/
Contains:
- Core API implementation
- gRPC client wrappers
- Generated protobuf stubs
- Request and response models
- Utility modules
Examples/
Contains sample scripts demonstrating common SWI3S Peripheral validation workflows.
Architecture
This package acts as a Python client SDK that communicates with the underlying SWI3S Peripheral validation service through gRPC. Protocol validation logic, execution, and device interaction are handled by the backend service, while this package provides a simplified Python interface for automation and integration.
Compatibility
| Component | Version |
|---|---|
| Python | 3.12+ |
| grpcio | 1.81.1+ |
| protobuf | 6.33.5+ |
| tabulate | 0.9.0+ |
Main API Operations
| Method | Description |
|---|---|
configure_swi3s_timing() |
Configure SWI3S timing parameters |
configure_bus_voltage() |
Configure SWI3S bus voltage settings |
swi3s_start() |
Start SWI3S communication |
swi3s_stop() |
Stop SWI3S communication |
configure_swi3s_transport_pattern() |
Configure SWI3S transport pattern settings |
swi3s_ping_get_status() |
Send Get Status Ping commands |
swi3s_read_setup() |
Configure SWI3S read operations |
swi3s_write_a32() |
Write data to SWI3S registers |
start_of_phase_marker() |
Generate Start of Phase Marker operations |
swi3s_announce_exit_dormant() |
Announce device exit from dormant mode |
swi3s_announce_sspa() |
Announce SSPA configuration |
swi3s_bus_reset() |
Perform SWI3S bus reset operations |
swi3s_commit_dscr() |
Commit DSCR configuration |
swi3s_commit_sscr() |
Commit SSCR configuration |
swi3s_read_data() |
Read data from SWI3S devices |
swi3s_start_audio() |
Start audio streaming |
swi3s_stop_audio() |
Stop audio streaming |
swi3s_write_unblock() |
Send Write Unblock commands |
i3s_monitor_setup() |
Configure I3S monitoring |
swi3s_monitoracq_start() |
Start monitor acquisition |
swi3s_monitoracq_stop() |
Stop monitor acquisition |
Configuration Utilities
| Method | Description |
|---|---|
update_frame() |
Update frame configuration folders |
setup_configure_frame() |
Generate and configure frame files and visualizer outputs |
setup_Configure_Source_payload() |
Configure source payload generation settings |
setup_configure_Sink_Payload() |
Configure sink payload settings |
extract_payload_data() |
Extract (and optionally decode) payload samples for one Data Port / Channel. |
For more detailed information , please refer the Soliton_SWI3S_Python_Automation_APIs_User_Manual.pdf
License
Proprietary
Copyright © Soliton Technologies.
Redistribution, modification, or distribution of this package without prior authorization is prohibited.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file protocol_validation_suite_swi3s_peripheral_validation_apis-26.7.8.tar.gz.
File metadata
- Download URL: protocol_validation_suite_swi3s_peripheral_validation_apis-26.7.8.tar.gz
- Upload date:
- Size: 48.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.2.1 CPython/3.12.7 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
48113c67fa3f1fb41a8322d244ae03f43d66d3b6968c8cba28cbb233721e6990
|
|
| MD5 |
21fbbbdb813d3a702f9003d0ca9feb44
|
|
| BLAKE2b-256 |
3fa9e5ebd88d8fb6c6ad3ea8727555616fdca3fd799a68332273caf188bc5c08
|
File details
Details for the file protocol_validation_suite_swi3s_peripheral_validation_apis-26.7.8-py3-none-any.whl.
File metadata
- Download URL: protocol_validation_suite_swi3s_peripheral_validation_apis-26.7.8-py3-none-any.whl
- Upload date:
- Size: 51.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.2.1 CPython/3.12.7 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3b84dfcb06a04e0590192f727528c5a31febf8df353763327f488127b444adb4
|
|
| MD5 |
557945b81c5ad8bc5541ebc917f4a077
|
|
| BLAKE2b-256 |
12a60adadf76c6e6c140d43919f6b40a80fd28ad2be5de9987528985152cc1bd
|
