Proto Request Example

{
  "project": "Tutorial",
  "CCAs": [
    {
      "ccaName": "Test CCA",
      "description": "Added from GRPC",
      "defaultSolderType": "SAC305",
      "defaultStencilThickness": 0.135,
      "defaultStencilThicknessUnits": "mm",
      "defaultPartTempRise": 10.53,
      "defaultPartTempRiseUnits": "F",
      "guessPartPropertiesEnabled": false
    }
  ]
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request to add a project to Sherlock

Proto Request Example

{
  "project": "New Project",
  "category": "Test Category",
  "description": "Test Description"
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request to add strain map files to CCAs in a Sherlock project.

Response from adding strain map CSV files

Proto Request Example:

The image property dimensions were obtained from the image .properties file under the CCA _METADATA folder after aligning the layer interactively.

{
  "project": "Tutorial Project",
  "strainMapFiles": [
    {
      "strainMapFile": "v242\\sherlock\\tutorial\\StrainMaps\\StrainMap.csv",
      "fileComment": "test comment",
      "headerRowCount": 0,
      "referenceIDColumn": "SolidID",
      "strainColumn": "PCB Strain",
      "strainUnits": "µε",
      "cca": [
        "Main Board"
      ],
      "numericFormat": "English",
      "fileType": 0
    },
    {
      "strainMapFile": "v242\\sherlock\\tutorial\\StrainMaps\\TutorialStrainMap-BOT.jpg",
      "fileComment": "test comment",
      "cca": [
        "Main Board"
      ],
      "fileType": 2,
      "imageFile": {
        "coordinateUnits": "in",
        "boardBounds": [
          {
            "vertexX": -3.7464000000000004,
            "vertexY": -2.2515
          },
          {
            "vertexX": 3.746400000000001,
            "vertexY": -2.2370759615384617
          },
          {
            "vertexX": 3.746400000000001,
            "vertexY": 2.2343759615384617
          },
          {
            "vertexX": -3.7464000000000004,
            "vertexY": 2.2488
          }
        ],
        "imageBounds": {
          "imageX": -5.020737315246,
          "imageY": -2.2660262062839065,
          "imageH": 5.30825048949089,
          "imageW": 10.225039886616724
        },
        "legendBounds": {
          "legendX": -4.881167037861916,
          "legendY": 2.5084326923076925,
          "legendH": 0.33175288461538466,
          "legendW": 9.728958574610246
        },
        "legendOrientation": 0,
        "minStrain": 9.16,
        "maxStrain": 1680.1,
        "strainUnits": "µε"
      }
    }
  ]
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request to add thermal map files to a Sherlock project.

Response from adding thermal map files.

Proto Request Example

The image property dimensions were obtained from the image .properties file under the CCA _METADATA folder after aligning the layer interactively.

{
  "project": "Tutorial Project",
  "thermalMapFiles": [
    {
      "thermalMapFile": "v242\\sherlock\\tutorial\\ThermalMaps\\Thermal Map.csv",
      "thermalMapFileProperties": {
        "fileName": "Thermal Map CSV",
        "fileType": 0,
        "fileComment": "Test Comment",
        "thermalBoardSide": 1,
        "csvExcelFile": {
          "headerRowCount": 0,
          "referenceIDColumn": "RefDes",
          "temperatureColumn": "Temp",
          "temperatureUnits": "C",
          "numericFormat": "English"
        },
        "thermalProfiles": [
          "Environmental/1 - Temp Cycle - Min"
        ],
        "cca": [
          "Main Board"
        ]
      }
    },
      {
      "thermalMapFile": "v242\\sherlock\\tutorial\\ThermalMaps\\Thermal Image.jpg",
      "thermalMapFileProperties": {
        "fileName": "Thermal Image Test",
        "fileType": 2,
        "fileComment": "test comment",
        "thermalBoardSide": 1,
        "imageFile": {
          "coordinateUnits": "in",
          "boardBounds": [
            {
              "vertexX": -3.7464,
              "vertexY": -2.2515
            },
            {
              "vertexX": 3.56139,
              "vertexY": -2.132
            },
            {
              "vertexX": 3.7464,
              "vertexY": 2.228887
            },
            {
              "vertexX": -3.5614,
              "vertexY": 2.2488
            }
          ],
          "imageBounds": {
            "imageX": -4.20314,
            "imageY": -4.44105,
            "imageH": 7.0474,
            "imageW": 9.08464157
          },
          "legendBounds": {
            "legendX": 4.17808,
            "legendY": -3.3467,
            "legendH": 4.71934,
            "legendW": 0.27751
          },
          "legendOrientation": 1,
          "minTemperature": 17,
          "minTemperatureUnits": "C",
          "maxTemperature": 90,
          "maxTemperatureUnits": "C"
        },
        "thermalProfiles": [
          "Environmental/1 - Temp Cycle - Max", "On The Road/4 - Thermal Shock - Max"
        ],
        "cca": [
          "Main Board"
        ]
      }
    }
  ]
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request a project CCA report.

Streams the project CCA report in chunks.

Proto Request Example

{
  "project": "Tutorial Project",
  "cca": "Main Board",
  "author": "Testing",
  "company": "Ansys"
}

Python Example

For a Python example, refer to the online PySherlock Reference.

Request a project report.

Streams the project report in chunks.

Proto Request Example

{
  "project": "Tutorial Project",
  "author": "Testing",
  "company": "Ansys"
}

Python Example

For a Python example, refer to the online PySherlock Reference.

Request for importing an IPC-2581 archive

Proto Request Example

{
  "archiveFile": "IPC2581.cvg",
  "project": "IPC",
  "ccaName": "CCA",
  "includeOtherLayers": true,
  "guessPartProperties": true,
  "polylineSimplification": true,
  "polylineTolerance": 0.05,
  "polylineToleranceUnits": "mm"
}

Python Example

For a Python example, refer to the online PySherlock Reference.

Request for importing an ODB++ archive.

Proto Request Example

{
  "archiveFile": "v242\\sherlock\\tutorial\\ODB++ Tutorial.tgz",
  "project": "ODB Import",
  "ccaName": "ODB CCA",
  "processLayerThickness": true,
  "includeOtherLayers": true,
  "processCutoutFile": true,
  "guessPartProperties": true,
  "imsStackup": true,
  "polylineSimplification": true,
  "polylineTolerance": 0.1,
  "polylineToleranceUnits": "mm"
}

Python Example

For a Python example, refer to the online PySherlock Reference.

Request for importing a .zip project archive when Sherlock is in multiple project mode.

Proto Request Example

{
  "project": "Tutorial Project Import",
  "category": "Test Category",
  "archiveFile": "v242\\sherlock\\tutorial\\Tutorial Project.zip"
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request for importing a .zip project archive when Sherlock is in single project mode.

Proto Request Example

{
  "projZipRequest": {
    "project": "Tutorial Project Import",
    "category": "Test Category",
    "archiveFile": "v242\\sherlock\\tutorial\\Tutorial Project.zip"
  },
  "destFileDir": "C:\\Users\\Documents\\Sherlock\\projects"
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request to list CCA's and sub-assembly CCA's for a project

Proto Request Example:

{
  "project": "Tutorial Project",
  "cca": [
    "Main Board"
  ]
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request to list CCA strain maps for a project

Lists the strain maps assigned to the project CCA's.

Proto Request Example:

{
  "project": "Tutorial Project",
  "cca": [
    "Main Board"
  ]
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request to list Thermal map files and their types for a project.

Represents the thermal map files and their types for a Sherlock project.

Proto Request Example

{
  "project": "Tutorial Project",
  "cca": [
    "Main Board"
  ]
}

Python Example:

For a Python example, refer to the online PySherlock Reference.

Request to update thermal map files to a Sherlock project.

Proto Request Example

{
  "project": "Tutorial Project",
  "thermalMapFiles": [
    {
      "fileName": "Thermal Map CSV",
      "fileType": 0,
      "fileComment": "Test Comment Updated",
      "thermalBoardSide": 0,
      "csvExcelFile": {
        "headerRowCount": 0,
        "referenceIDColumn": "RefDes",
        "temperatureColumn": "Temp",
        "temperatureUnits": "C",
        "numericFormat": "English"
      },
      "thermalProfiles": [
        "On The Road/4 - Thermal Shock - Min", "On The Road/4 - Thermal Shock - Max"
      ],
      "cca": [
        "Main Board"
      ]
    },
    {
      "fileName": "Thermal Image Test",
      "fileType": 2,
      "fileComment": "Test Comment Updated",
      "thermalBoardSide": 0,
      "imageFile": {
        "coordinateUnits": "in",
        "boardBounds": [
          {
            "vertexX": -3.7464,
            "vertexY": -2.2515
          },
          {
            "vertexX": 3.56139,
            "vertexY": -2.132
          },
          {
            "vertexX": 3.7464,
            "vertexY": 2.228887
          },
          {
            "vertexX": -3.5614,
            "vertexY": 2.2488
          }
        ],
        "imageBounds": {
          "imageX": -4.20314,
          "imageY": -4.44105,
          "imageH": 7.0474,
          "imageW": 9.08464157
        },
        "legendBounds": {
          "legendX": 4.17808,
          "legendY": -3.3467,
          "legendH": 4.71934,
          "legendW": 0.27751
        },
        "legendOrientation": 1,
        "minTemperature": 17,
        "minTemperatureUnits": "C",
        "maxTemperature": 90,
        "maxTemperatureUnits": "C"
      },
      "thermalProfiles": [
        "Environmental/1 - Temp Cycle - Max", "Environmental/1 - Temp Cycle - Min"
      ],
      "cca": [
        "Main Board"
      ]
    }
  ]
}

Python Example:

For a Python example, refer to the online PySherlock Reference.