Request to define and add a new harmonic vibe Life Cycle event.

Response from adding a harmonic vibe event.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "On The Road",
  "eventName": "7 - New Harmonic Vibe",
  "description": "This is the addition of a new harmonic event",
  "duration": 15,
  "durationUnits": "ms",
  "numOfCycles": 100,
  "cycleType": "DUTY CYCLE",
  "sweepRate": 1,
  "orientation": "30,15",
  "profileType": "Uniaxial",
  "loadDirection": "0,0,1"
}

Request Response

Python Example

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

Request to define and add new harmonic vibe life cycle event profiles.

Response from adding harmonic vibe life cyle event profiles.

Proto Request Example:

{
  "project": "Tutorial Project",
  "harmonicVibeProfiles": [
    {
      "phaseName": "On The Road",
      "eventName": "5 - Harmonic Vibe",
      "profileName": "First Harmonic Profile",
      "freqUnits": "Hz",
      "loadUnits": "G",
      "harmonicVibeProfileEntries": [
        {
          "freq": 100.0,
          "load": 10.0
        },
        {
          "freq": 1000.0,
          "load": 10.0
        }
      ],
      "triaxialAxis": "x"
    },
    {
      "phaseName": "On The Road",
      "eventName": "Test HV",
      "profileName": "Second Harmonic Profile",
      "freqUnits": "Hz",
      "loadUnits": "G",
      "harmonicVibeProfileEntries": [
        {
          "freq": 100.0,
          "load": 10.0
        },
        {
          "freq": 1000.0,
          "load": 10.0
        }
      ],
      "triaxialAxis": "y"
    }
  ]
}

Python Example:

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

Request to define and add a new shock Life Cycle event.

Response from adding a shock life cycle event.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "On The Road",
  "eventName": "Test Shock API",
  "description": "Test Description",
  "duration": 2,
  "durationUnits": "ms",
  "numOfCycles": 100,
  "cycleType": "DUTY CYCLE",
  "orientation": "5, 5",
  "loadDirection": "0, 0, -1"
}

Python Example

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

Request to define and add new shock life cycle event profiles.

Response from adding shock life cycle event profiles.

Proto Request Example:

{
  "project": "Tutorial Project",
  "shockProfiles": [
    {
      "phaseName": "On The Road",
      "eventName": "2 - Pothole",
      "profileName": "First Shock Profile",
      "duration": 100,
      "durationUnits": "sec",
      "sampleRate": 1,
      "sampleRateUnits": "sec",
      "loadUnits": "in/s2",
      "freqUnits": "KHZ",
      "shockProfileEntries": [
        {
          "shape": "Triangle",
          "load": 15.0,
          "freq": 10.0,
          "decay": 5.0
        },
        {
          "shape": "HalfSine",
          "load": 10.0,
          "freq": 100.0,
          "decay": 4.0
        }
      ]
    },
    {
      "phaseName": "On The Road",
      "eventName": "2 - Pothole",
      "profileName": "First Shock Profile",
      "duration": 100,
      "durationUnits": "ms",
      "sampleRate": 0.1,
      "sampleRateUnits": "ms",
      "loadUnits": "m/s2",
      "freqUnits": "HZ",
      "shockProfileEntries": [
        {
          "shape": "Triangle",
          "load": 115.0,
          "freq": 101.0,
          "decay": 51.0
        },
        {
          "shape": "HalfSine",
          "load": 110.0,
          "freq": 1010.0,
          "decay": 41.0
        }
      ]
    }
  ]
}

Python Example:

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

Request to define and add a new random vibe life cycle event.

Response from adding a random vibe life cycle event.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "Environmental",
  "eventName": "Test Random Vibe Event",
  "description": "Random Vibe Event Description",
  "duration": 100,
  "durationUnits": "ms",
  "numOfCycles": 100,
  "cycleType": "DUTY CYCLE",
  "orientation": "30,15",
  "profileType": "Uniaxial",
  "loadDirection": "0, 0, -1"
}

Python Example

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

Request to define and add new random vibe life cycle event profiles.

Proto Request Example:

{
  "project": "Tutorial Project",
  "randomVibeProfiles": [
    {
      "phaseName": "On The Road",
      "eventName": "1 - Vibration",
      "profileName": "First Random Vibe Profile",
      "freqUnits": "HZ",
      "amplUnits": "G2/Hz",
      "randomVibeProfileEntries": [
        {
          "freq": 10,
          "ampl": 15
        },
        {
          "freq": 100,
          "ampl": 10
        }
      ]
    },
    {
      "phaseName": "Environmental",
      "eventName": "Test RV",
      "profileName": "Second Random Vibe Profile",
      "freqUnits": "HZ",
      "amplUnits": "G2/Hz",
      "randomVibeProfileEntries": [
        {
          "freq": 100,
          "ampl": 150
        },
        {
          "freq": 1000,
          "ampl": 100
        }
      ]
    }
  ]
}

Python Example:

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

Response from adding random vibe profiles.

Request to define and add a new thermal Life Cycle event.

Response from adding a thermal life cycle event.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "On The Road",
  "eventName": "Test Thermal Event Creation API",
  "description": "Test Description",
  "numOfCycles": 99,
  "cycleType": "DUTY CYCLE",
  "cycleState": "STORAGE"
}

Python Example

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

Request to define and add a new thermal life cycle event profiles.

Response from adding thermal profiles.

Proto Request Example:

{
  "project": "Tutorial Project",
  "thermalProfiles": [
    {
      "phaseName": "Environmental",
      "eventName": "1 - Temp Cycle",
      "profileName": "First Thermal Profile",
      "timeUnits": "min",
      "tempUnits": "F",
      "thermalProfileEntries": [
        {
          "step": "Min Temp",
          "type": "HOLD",
          "time": 15,
          "temp": 15
        },
        {
          "step": "Ramp Up",
          "type": "RAMP",
          "time": 25,
          "temp": 50
        },
        {
          "step": "Max Temp",
          "type": "HOLD",
          "time": 15,
          "temp": 50
        },
        {
          "step": "Ramp Down",
          "type": "RAMP",
          "time": 15,
          "temp": 15
        }
      ]
    },
    {
      "phaseName": "On The Road",
      "eventName": "4 - Thermal Shock",
      "profileName": "Second Thermal Profile",
      "timeUnits": "min",
      "tempUnits": "C",
      "thermalProfileEntries": [
        {
          "step": "Min Temp",
          "type": "HOLD",
          "time": 15,
          "temp": 15
        },
        {
          "step": "Ramp Up",
          "type": "RAMP",
          "time": 25,
          "temp": 50
        },
        {
          "step": "Max Temp",
          "type": "HOLD",
          "time": 15,
          "temp": 50
        },
        {
          "step": "Ramp Down",
          "type": "RAMP",
          "time": 15,
          "temp": 15
        }
      ]
    }
  ]
}

Python Example:

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

Request for creating a life phase.

Response from creating a life phase.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "createLifePhase Test",
  "description": "Test Life Phase Created",
  "duration": 100,
  "durationUnits": "ms",
  "numOfCycles": 100,
  "cycleType": "DUTY CYCLE"
}

Python Example

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

Request to delete a life cycle event in a project.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "On The Road",
  "eventName": "4 – Thermal Shock"
}

Python Example

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

Request for deleting a life phase.

Response for deleting a life phase

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "On The Road"
}

Python Example

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

Request for a list of amplitude units.

Represents a list of amplitude units.

Proto Request Example

import SherlockLifeCycleService_pb2
import SherlockLifeCycleService_pb2_grpc
import grpc

channel = grpc.insecure_channel('localhost:9090')

stub = SherlockLifeCycleService_pb2_grpc.SherlockLifeCycleServiceStub(channel)

message = SherlockLifeCycleService_pb2.ListAmplUnitsRequest()

response = stub.listAmplUnits(message)

print(str(response))

Python Example:

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

Request for a list of duration units for event settings.

Represents a list of duration units for event settings in life cycle.

Proto Request Example

{ }

Python Example

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

Request for a list of frequency units.

Represents a list of frequency units.

Proto Request Example

{ }

Python Example

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

Request for a list of harmonic events defined for a project.

Represents a list of harmonic events defined for a project.

Proto Request Example

{
  "project": "Tutorial Project"
}

Python Example

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

Request for a list of harmonic load profile types.

Represents a list of harmonic load profile types.

Proto Request Example

{ }

Python Example

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

Request for a list of Life Cycle phases and events for a project.

Represents the Life Cycle phases and events for a Sherlock project.

Proto Request Example

{
  "project": "Tutorial Project"
}

Python Example

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

Request for a list of Life Cycle states.

Proto Request Example

{ }

Python Example

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

Request for a list of Life Cycle types.

Represents a list of Life Cycle types.

Proto Request Example

{ }

Python Example

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

Request for a list of random vibe profile types.

Represents a list of random vibe profile types.

Proto Request Example

{}

Python Example

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

Request for a list of random vibe events defined for a project.

Represents a list of random vibe events defined for a project.

Proto Request Example

{
  "project": "Tutorial Project"
}

Python Example

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

Request for a list of shock events defined for a project.

Represents a list of shock events defined for a project.

Proto Request Example

{
  "project": "Tutorial Project"
}

Python Example

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

Request for a list of shock load units.

Represents a list of shock load units.

Proto Request Example

{ }

Python Example

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

Request for a list of shock pulses.

Represents a list of shock pulses.

Proto Request Example

{ }

Python Example

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

Request for a list of temperature units.

Represents a list of temperature units.

Proto Request Example

{ }

Python Example

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

Request to load a harmonic Life Cycle Event Profile from a .dat or .csv file.

.csv file properties. This is only required for a .csv file load.

Response from loading a harmonic vibe life cycle event profile from a .dat or .csv file.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "On The Road",
  "eventName": "5 - Harmonic Vibe",
  "filePath": "C:\\Users\\jdoe\\Documents\\Default Profile.dat"
}

Proto Request Example (CSV)

{
  "project": "Tutorial Project",
  "phaseName": "On The Road",
  "eventName": "Test Harmonic API",
  "filePath": " C:\\Users\\jdoe\\Documents\\Default Profile.csv",
  "harmonicCsvProps": {
    "profileName": "Harmonic Profile - Script Test",
    "headerRowNumber": 0,
    "columnDelim": "Comma",
    "numericFormat": "English (United States)",
    "freqColumn": "Freq (HZ)",
    "freqUnits": "Hz",
    "loadColumn": "Load (G)",
    "loadUnits": "G"
  }
}

Python Example

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

Request to load a random vibe life cycle event profile from a .dat or .csv file.

.csv file properties. This is only required for a .csv file load.

Response from loading a random vibe life cycle event profile from a .dat or .csv file.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "On The Road",
  "eventName": "1 - Vibration",
  "filePath": "C:\\Temp\\Random Vibe Profile.csv",
  "randomVibeCsvProps": {
    "profileName": "Random Vibe – Script Test",
    "headerRowNumber": 0,
    "columnDelim": "Comma",
    "numericFormat": "English (United States)",
    "freqColumn": "Freq (HZ)",
    "freqUnits": "Hz",
    "amplColumn": "Ampl (G2/Hz)",
    "amplUnits": "G2/Hz"
  }
}

Python Example

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

Request to load a shock Life Cycle Event Profile using dataset (time and load) from a .dat or .csv file.

.csv file properties. This is only required for a .csv file load.

Response from loading a shock profile using the dataset from a .dat or .csv file.

Proto Request Example

{
  "project": "Tutorial",
  "phaseName": "Environmental",
  "eventName": "3 - Earthquake",
  "filePath": "C:\\Users\\jdoe\\Documents\\Full Sine Damped.csv",
  "shockDsCsvProps": {
    "profileName": "Shock Dataset",
    "headerRowNumber": 0,
    "columnDelim": "Comma",
    "numericFormat": "English (United States)",
    "timeColumn": "Time (ms)",
    "timeUnits": "ms",
    "loadColumn": "Load (G)",
    "loadUnits": "G"
  }
}

Python Example

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

Request to load a shock Life Cycle Event Profile using pulses from a .dat or .csv file.

.csv file properties. This is only required for a .csv file load.

Response from loading a shock profile using pulses from a .dat or .csv file.

Proto Request Example

{
  "project": "Tutorial Project",
  "phaseName": "Environmental",
  "eventName": "3 - Earthquake",
  "filePath": "C:\\Users\\jdoe\\Documents\\Sawtooth.csv",
  "shockPulsesCsvProps": {
    "profileName": "Shock Pulses",
    "headerRowNumber": 0,
    "columnDelim": "Comma",
    "numericFormat": "English (United States)",
    "duration": 20.0,
    "durationUnits": "ms",
    "sampleRate": 1.0,
    "sampleRateUnits": "sec",
    "shapeColumn": "Shape",
    "loadColumn": "Load (G)",
    "loadUnits": "G",
    "freqColumn": "Freq (Hz)",
    "freqUnits": "Hz",
    "decayColumn": "Decay"
  }
}

Python Example

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

Request to load a thermal Life Cycle Event Profile from a .dat or .csv file.

.csv file properties. This is only required for a .csv file load.

Response from loading a thermal profile from a .dat or .csv file.

Proto Request Example

{
  "project": "Tutorial Project", 
  "phaseName": "Environmental",
  "eventName": "5 - Fire",
  "filePath": "C:\\Users\\jdoe\\AppData\\Roaming\\Sherlock\\thermalProfiles\\Single Step.dat"
}

Proto Request Example (CSV)

{
  "project": "Tutorial Project",
  "phaseName": "Environmental",
  "eventName": "1 - Temp Cycle",
  "filePath": "C:\\Users\\aklara\\Desktop\\APIexamples\\SherlockLifeCycleService\\Thermal.csv",
  "csvProps": {
    "profileName": "Temperature Profile - Script Test",
    "headerRowNumber": 0,
    "columnDelim": "Comma",
    "numericFormat": "English (United States)",
    "stepColumn": "Step",
    "typeColumn": "Type",
    "timeColumn": "Time (min)",
    "timeUnits": "min",
    "tempColumn": "Temp (C)",
    "tempUnits": "C"
  }
}

Python Example

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