Update and Export Parts List Properties

This example demonstrates how to connect to the Sherlock gRPC service, import a project, update the parts list properties, export the parts list, and properly close the connection.

Description

Sherlock’s gRPC API allows users to automate workflows such as updating the parts list properties and exporting the parts list for printed circuit boards (PCBs). This script demonstrates how to: - Launch the Sherlock service. - Import a project. - Update the parts list properties.

The updated properties and exported list ensure consistency and provide documentation for further use.

import os

from examples.examples_globals import SHERLOCK_CONNECT_TIMEOUT, get_sherlock_tutorial_path

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockImportProjectZipArchiveError,
    SherlockUpdatePartsListPropertiesError,
)

Connect to Sherlock

Connect to the Sherlock service and ensure proper initialization.

sherlock = launcher.connect(port=9092, timeout=SHERLOCK_CONNECT_TIMEOUT, transport_mode="wnua")

Traceback (most recent call last):
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\examples\01-project-configuration\update_parts_list_properties.py", line 65, in <module>
    sherlock = launcher.connect(port=9092, timeout=SHERLOCK_CONNECT_TIMEOUT, transport_mode="wnua")
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 326, in connect
    raise e
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 308, in connect
    _wait_for_sherlock_grpc_ready(channel, timeout)
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^
  File "C:\Users\ansys\actions-runner\_work\pysherlock\pysherlock\.venv\Lib\site-packages\ansys\sherlock\core\launcher.py", line 397, in _wait_for_sherlock_grpc_ready
    raise SherlockConnectionError(message="Error starting gRPC service")
ansys.sherlock.core.errors.SherlockConnectionError: gRPC connection error: Error starting gRPC service

Delete Project

Delete the project if it already exists.

try:
    sherlock.project.delete_project("Test")
    print("Project deleted successfully.")
except Exception:
    pass

Import Tutorial Project

Import the tutorial project zip archive from the Sherlock tutorial directory.

try:
    sherlock.project.import_project_zip_archive(
        project="Test",
        category="Demos",
        archive_file=os.path.join(get_sherlock_tutorial_path(), "Auto Relay Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print("Error importing project zip archive.")

Update Parts List Properties

Update the parts list properties for the “Card” of the “Test” project.

try:
    parts_properties = [
        {
            "reference_designators": ["D1"],
            "properties": [{"name": "partType", "value": "RESISTOR"}],
        },
        {
            "reference_designators": ["D2"],
            "properties": [{"name": "locX", "value": "1"}, {"name": "userNotes", "value": "test"}],
        },
        {"reference_designators": ["D3"], "properties": [{"name": "userNotes", "value": "test2"}]},
        {"reference_designators": ["D4"], "properties": [{"name": "leadBend", "value": "45"}]},
    ]
    sherlock.parts.update_parts_list_properties(
        project="Test",
        cca_name="Auto Relay",
        part_properties=parts_properties,
    )
    print("Parts list properties updated successfully.")
except SherlockUpdatePartsListPropertiesError as e:
    print("Error updating parts list properties.")