-
HyWorksApi Commands
-
General
- closeHyperWorks():
- connectToHyWorks(host=socket.gethostname(), register=getpass.getuser(), timeout=120000, index=1):
- disableHyWorksApiExceptions():
- enableHyWorksApiExceptions():
- getProperty(key):
- getProperties():
- setProperty(key, value, save=False):
- startHyperWorks(stdout=None, stderr=None):
- startAndConnectHypersim(host=socket.gethostname(), register=getpass.getuser(), stdout=None, stderr=None, timeout=2500):
- Design
-
Device
- activateObservables(deviceName, observables):
- addControlSignal(signalName, points, hitCheck = False, subcircuit=None):
- addBus1ph(signalName, points, hitCheck = False, subcircuit=None):
- addBus3ph(signalName, points, hitCheck = False, subcircuit=None):
- addDevice(libName, blocName, coordX=0, coordY=0, page=1, subcircuit=None, name=None):
- addPinsToDevice(name, cardinalPoint, function, pins, redraw=False):
- connectBundleToBundle(blocA, signalListA, blocB, signalListB):
- connectDevices(blocA, pinA, blocB, pinB, isThreePhaseAndPowerFlexible, signalName=None):
- connectDeviceToControlSignal(deviceName, pinName, signalName):
- connectDeviceToBus1ph(deviceName, pinName, signalName):
- connectDeviceToBus3ph(deviceName, pinName, signalName):
- connectPinToBundle(blocA, pinA, blocB, signalB):
- createSubCircuit(name, type=None, coordX=0, coordY=0, page=1):
- disconnectPin(deviceName, pinName, removeAllConnections = False):
- displayComponent(componentName=””):
- flipHorizontallyDevice(deviceName, keepConnections=True):
- flipVerticallyDevice(deviceName, keepConnections=True):
- getAllDevicesNames():
- getCoordinates(deviceName, pinName = None):
- getComponentParameter(compName, compParam):
- getDeviceBundleChildPins(deviceName, pinName):
- getDeviceBundlePins(deviceName):
- importUCM(defFilePath):
- includeDevice(deviceName, include):
- removeDevice(deviceName):
- renameDevice(oldDeviceName, newDeviceName):
- renameSignal(oldName, newName, visible=True):
- rotateLeftDevice(deviceName, keepConnections=True):
- rotateRightDevice(deviceName, keepConnections=True):
- setComponentParameter(compName, compParam, value):
- setDeviceFillColor(name, colorHexRGB):
- setDeviceLineColor(name, colorHexRGB):
- setSignalLineColor(name, colorHexRGB):
- HyWorksApiGRPC.setSignalLineWidth(name, width):
- setDevicesNameVisibility(deviceList, isVisible):
- setPinPhaseNumber(deviceName, pinName, value):
- updateUCM(deviceName):
-
Sensor
- editSensor(blocName, sensorName, IOType=None, IONumber=None, base=None, unit=None):
- getSensorInfo(blocName, sensorName, key):
- loadSensors (filePath):
- selectAllSensors(blocName):
- setSensorDataLogger(blocName, sensorName, record, groupName, trigger):
- setSensorDataPoint(blocName, sensorName, exchangerTag, dataPointName, dataPointIdx):
- selectSensor(blocName, sensorName, selected=True):
- Settings
- Simulation
-
Target
- addTargetToManager(targetHostName):
- diagnosticTarget(targetHostName):
- getAllTargetsName():
- getCurrentVersionOnTarget(targetHostName):
- getInstalledVersionOnTarget(targetHostName):
- installHypersimOnTarget(targetHostName):
- isTargetReady(targetHostName):
- removeTargetFromManager(targetHostName):
- switchVersionOnTarget(targetHostName, switchToVersion):
-
General
-
ScopeViewApi Commands
- General
-
Acquisition
- ScopeViewApiGRPC.exportToPDF(filePath):
- ScopeViewApiGRPC.exportToFile(filePath):
- ScopeViewApiGRPC.evalAllExpressions():
- ScopeViewApiGRPC.getCont():
- ScopeViewApiGRPC.getExpressions():
- ScopeViewApiGRPC.getNumAcq():
- ScopeViewApiGRPC.getNumData():
- ScopeViewApiGRPC.getSamplingRate():
- ScopeViewApiGRPC.getStartTime():
- ScopeViewApiGRPC.getTimeLength():
- ScopeViewApiGRPC.startAcquisition():
- ScopeViewApiGRPC.stopAcquisition():
- ScopeViewApiGRPC.pauseAcquisition():
- ScopeViewApiGRPC.setCont(state):
- ScopeViewApiGRPC.setNumAcq(numAcq):
- ScopeViewApiGRPC.setSamplingRate(rate):
- ScopeViewApiGRPC.setStartTime(time):
- ScopeViewApiGRPC.setTimeLength(time):
- ScopeViewApiGRPC.setSync(state):
- ScopeViewApiGRPC.setTrig(state):
-
Data Source
- ScopeViewApiGRPC.loadDataSource(strURI):
- ScopeViewApiGRPC.loadFileDataSource(filePath):
- ScopeViewApiGRPC.reloadAllDataSources():
- ScopeViewApiGRPC.removeAllDataSources():
- ScopeViewApiGRPC.replaceDataSource(oldDataSourceLabel, newDataSourceLocation):
- ScopeViewApiGRPC.setDataSourceParameter(dataSourceLabel, parameter, value):
- Template
Documentation Home Page ◇ HYPERSIM Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.
General
Content
Integrations
App links