-
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
-
ScopeViewApi Commands