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.
Python API | Commands
- Sylvain Ménard
- Jean-Nicolas Brunet
- Victoria Bruny
Owned by Sylvain Ménard
-
HyWorksApi Commands
-
General
- closeHyperWorks():
- closeLibrary(libraryPath):
- connectToHyWorks(host=socket.gethostname(), register=getpass.getuser(), timeout=120000, id=None):
- disableHyWorksApiExceptions():
- enableHyWorksApiExceptions():
- getCurrentDesign():
- getProperties():
- getProperty(key):
- getVersion(long=False) :
- openLibrary(libraryPath, visible=True):
- setProperty(key, value, save=False):
- startAndConnectHypersim(host=socket.gethostname(), register=getpass.getuser(), stdout=None, stderr=None:
- startHyperWorks(stdout=None, stderr=None):
-
Design
- closeDesign(designPath):
- disconnectDesign(designPath):
- findMinimalStepSize(timeout, overrunsThreshold: int, nCores=100, startingTimeStep=1e-6, jump=1e-6):
- getAllComponentDescriptions():
- getAllComponentParameters(compName):
- getAllComponentSensors(compName):
- getAllDevicesNames():
- getDesignPrefs():
- importEDD(eddFilePath, doConnections):
- importPSCAD(filePath, onlyDll, removeNotConnectedBuses=False):
- importPSSE(filePath, replaceMachines=False, groupMachinesWithControls=True):
- importPowerFactory(filePath, mode=0):
- newDesign(designFilePath=None):
- openDesign(designPath):
- recheckPorts():
- saveDesign():
- saveDesignAs(fileName):
- updateEDD(eddFilePath, doConnections):
-
Device
- activateObservables(deviceName, observables):
- addBus1ph(signalName, points, hitCheck=False, subcircuit=None):
- addBus3ph(signalName, points, hitCheck=False, subcircuit=None):
- addControlSignal(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):
- connectDeviceToBus1ph(deviceName, pinName, signalName):
- connectDeviceToBus3ph(deviceName, pinName, signalName):
- connectDeviceToControlSignal(deviceName, pinName, signalName):
- connectDevices(blocA, pinA, blocB, pinB, isThreePhaseAndPowerFlexible, signalName=None):
- connectPinToBundle(blocA, pinA, blocB, signalListB):
- createSubCircuit(name, subType, coordX=0, coordY=0, page=1):
- disconnectPin(deviceName, pinName, removeAllConnections=False):
- displayComponent(componentName, printAttributes=True, printSignals=True, printConnectors=True:
- displayConnections(componentName):
- flipHorizontallyDevice(deviceName, keepConnections=True):
- flipVerticallyDevice(deviceName, keepConnections=True):
- getComponentParameter(compName, compParam):
- getCoordinates(deviceName, pinName=None):
- getDeviceBundleChildPins(deviceName, pinName):
- getDeviceBundlePins(deviceName):
- getDevicePinTypes(deviceName: str, pinNames: list):
- 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):
- setComponentParameters(compNames, compParams, values):
- setDeviceFillColor(name, colorHexRGB):
- setDeviceLineColor(name, colorHexRGB):
- setDevicesNameVisibility(deviceList, isVisible):
- setPinPhaseNumber(deviceName, pinName, value):
- setSignalLineColor(signalName, colorHexRGB):
- setSignalLineWidth(signalName, width):
- setSubcircuitScripts(compName, initialValues, rules, variablesToTransmit, evaluateOnly=False):
- unbindUCMFromLibrary(deviceName):
- updateUCM(deviceName, ucmPath=None):
-
Sensor
- editSensor(blocName, sensorName, IOType=None, IONumber=None, base=None, unit=None):
- getLastSensorValues(sensorNames):
- getSensorInfo(blocName, sensorName, key):
- getSensorsValues(sensorNames: List[str], timeLength, timeStart=0, acquisitionRate=Non:
- loadSensors(filePath):
- selectAllSensors(blocName):
- selectSensor(blocName, sensorName, selected=True):
- setSensorDataLogger(blocName, sensorName, record, groupName, trigger):
- setSensorDataPoint(blocName, sensorName, exchangerTag, dataPointName, dataPointIdx):
- Settings
-
Simulation
- getMonitoringAllValues():
- getMonitoringValue(monitorName):
- getPreparationTimings(modelPath: str = None) :
- getSimulationCoreTimings(modelPath: str = None) :
- getSimulationTime():
- getSimulationTimings(modelPath: str = None) :
- loadSnapshot():
- resetMonitoring(cpuList):
- resetPerfIndic(cpuList):
- resetTiming(cpuList):
- simtrig(sync):
- startMonitoring():
- startSim():
- stopMonitoring():
- stopSim():
- takeSnapshot():
-
Target
- addTargetToManager(targetHostName):
- diagnosticTarget(targetHostName):
- getAllTargetsName():
- getCurrentVersionOnTarget(targetHostName):
- getInstalledVersionOnTarget(targetHostName):
- installHypersimOnTarget(targetHostName):
- isTargetReady(targetHostName):
- removeTargetFromManager(targetHostName):
- switchVersionOnTarget(targetHostName, switchToVersion):
-
General
-
ScopeViewApi Commands
- General
-
Acquisition
- evalAllExpressions():
- exportToFile(file_name):
- exportToPDF(file_name):
- getCont():
- getExpressions():
- getNumAcq():
- getNumData():
- getSamplingRate():
- getStartTime():
- getTimeLength():
- pauseAcquisition():
- setCont(value):
- setNumAcq(value):
- setSamplingRate(value):
- setStartTime(value):
- setSync(value):
- setTimeLength(value):
- setTrig(value):
- startAcquisition():
- stopAcquisition():
-
Comtrade
- calculateComtradeSignalDelay(files, signal_pairs=None):
- combineComtrade(inputs, output_file, parameters=None, selected_signals: Dict[str, List[str]] = None):
- convertComtradeRevisionYear(filepath, version, new_filepath=None):
- findSynchronizableComtradeSignalPairs(files):
- getCombineComtradeParameters(files=None) :
- getComtradeSignals(files) :
- Data Source
-
Template
- addExpression(expression):
- addTemplateFunction(function, signals, page, visible):
- addTemplateSignals(signals, page, visible):
- executeTemplate(file_name):
- getSignal(signal_name, data_source_label):
- getTemplateDataSources():
- importTemplate(file_name, appendNewPage):
- loadTemplate(file_name):
- newTemplate():
- removeAllPages():
- removeTemplateFunction(function, page, visible):
- removeTemplateSignals(signals, page, visible):
- saveTemplate(file_name):
OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter