> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references.md).

# HYPERSIM API References

The **HyWorksApi** is divided into sections.

| Section         | Description                                                                                         | Function                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------------- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| General         | Get the informations on active projects and either connect to one or create a new project instance. | <p><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-closehyperworks">closeHyperWorks</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-closelibrary">closeLibrary</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-connecttohyworks">connectToHyWorks</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-disablehyworksapiexceptions">disableHyWorksApiExceptions</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-enablehyworksapiexceptions">enableHyWorksApiExceptions</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-getapisession">getApiSession</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-getcurrentdesign">getCurrentDesign</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-getproperties">getProperties</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-getproperty">getProperty</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-getversion">getVersion</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-newapisession">newApiSession</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-openlibrary">openLibrary</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-setapisession">setApiSession</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-setproperty">setProperty</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-startandconnecthypersim">startAndConnectHypersim</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/general.md#function-starthyperworks">startHyperWorks</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Design          | Manage and configure HYPERSIM designs.                                                              | <p><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-batchadddevices">batchAddDevices</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-closedesign">closeDesign</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-disconnectdesign">disconnectDesign</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-findminimalstepsize">findMinimalStepSize</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-getallcomponentdescriptions">getAllComponentDescriptions</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-getallcomponentparameters">getAllComponentParameters</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-getallcomponentsensors">getAllComponentSensors</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-getalldevicesnames">getAllDevicesNames</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-getallselectedsensors">getAllSelectedSensors</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-getdesignprefs">getDesignPrefs</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-importedd">importEDD</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-importpowerfactory">importPowerFactory</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-importproject">importProject</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-importpscad">importPSCAD</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-importpsse">importPSSE</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-newdesign">newDesign</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-opendesign">openDesign</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-recheckports">recheckPorts</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-savedesign">saveDesign</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-savedesignas">saveDesignAs</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/design.md#function-updateedd">updateEDD</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Device          | Manage devices and their configuration within a HYPERSIM design.                                    | <p><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-activateobservables">activateObservables</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-addbus1ph">addBus1ph</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-addbus3ph">addBus3ph</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-addcontrolsignal">addControlSignal</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-adddevice">addDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-addpinstodevice">addPinsToDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-batchconnectdevices">batchConnectDevices</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-connectbundletobundle">connectBundleToBundle</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-connectdevices">connectDevices</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-connectdevicetobus1ph">connectDeviceToBus1ph</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-connectdevicetobus3ph">connectDeviceToBus3ph</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-connectdevicetocontrolsignal">connectDeviceToControlSignal</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-connectpintobundle">connectPinToBundle</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-createsubcircuit">createSubCircuit</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-disconnectpin">disconnectPin</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-displaycomponent">displayComponent</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-displayconnections">displayConnections</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-exportcigre">exportCigre</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-fliphorizontallydevice">flipHorizontallyDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-flipverticallydevice">flipVerticallyDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-getcomponentparameter">getComponentParameter</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-getcoordinates">getCoordinates</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-getdevicebundlechildpins">getDeviceBundleChildPins</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-getdevicebundlepins">getDeviceBundlePins</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-getdevicepins">getDevicePins</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-getdevicepintypes">getDevicePinTypes</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-getimpedancemeasurement">getImpedanceMeasurement</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-importcigre">importCigre</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-importucm">importUCM</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-includedevice">includeDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-removedevice">removeDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-renamedevice">renameDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-renamesignal">renameSignal</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-rotateleftdevice">rotateLeftDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-rotaterightdevice">rotateRightDevice</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setcomponentparameter">setComponentParameter</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setcomponentparameters">setComponentParameters</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setdevicefillcolor">setDeviceFillColor</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setdevicelinecolor">setDeviceLineColor</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setdevicesattributevisibility">setDevicesAttributeVisibility</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setdevicesnamevisibility">setDevicesNameVisibility</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setpinphasenumber">setPinPhaseNumber</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setsignallinecolor">setSignalLineColor</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setsignallinewidth">setSignalLineWidth</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-setsubcircuitscripts">setSubcircuitScripts</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-unbinducmfromlibrary">unbindUCMFromLibrary</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/device.md#function-updateucm">updateUCM</a></p> |
| Graphic         | Create and configure graphical elements such as rectangles, text, lines, arcs, and ellipses.        | <p><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/graphic.md#function-drawarc">drawArc</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/graphic.md#function-drawellipse">drawEllipse</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/graphic.md#function-drawline">drawLine</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/graphic.md#function-drawrectangle">drawRectangle</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/graphic.md#function-drawtext">drawText</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Interface Block | Manage interface block definitions and configure interface block instances and parameters.          | <p><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/interface_block.md#function-addinterfaceblockdefinition">addInterfaceBlockDefinition</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/interface_block.md#function-deleteinterfaceblockdefinition">deleteInterfaceBlockDefinition</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/interface_block.md#function-initializeinterfaceblock">initializeInterfaceBlock</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/interface_block.md#function-listinterfaceblockdefinitions">listInterfaceBlockDefinitions</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/interface_block.md#function-setinterfaceblockparametervalues">setInterfaceBlockParameterValues</a><br><a href="https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/automation-api-and-scripting/hypersim-api-references/interface_block.md#function-setinterfaceblocksampletime">setInterfaceBlockSampleTime</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Sensor          | Manage, configure, select, and retrieve sensor data in a HYPERSIM design.                           | <p><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-editsensor">editSensor</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-getlastsensorvalues">getLastSensorValues</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-getsensorinfo">getSensorInfo</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-getsensorsvalues">getSensorsValues</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-loadsensors">loadSensors</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-selectallsensors">selectAllSensors</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-selectsensor">selectSensor</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-setsensordatalogger">setSensorDataLogger</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/sensor.md#function-setsensordatapoint">setSensorDataPoint</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Settings        | Configure HYPERSIM preferences, task mappings, model preparation, and simulation targets.           | <p><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-analyze">analyze</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-buildtopology">buildTopology</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-clearcodedir">clearCodeDir</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-gencode">genCode</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-getloadflowreport">getLoadFlowReport</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-getmodeltasks">getModelTasks</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-getpreference">getPreference</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-loadmodeltasks">loadModelTasks</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-maptask">mapTask</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-setmodeltasks">setModelTasks</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-setpreference">setPreference</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-settarget">setTarget</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/settings.md#function-startloadflow">startLoadFlow</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Simulation      | Control and manage HYPERSIM simulations.                                                            | <p><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getmonitoringallvalues">getMonitoringAllValues</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getmonitoringvalue">getMonitoringValue</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getpreparationtimings">getPreparationTimings</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getreservedprocessorcount">getReservedProcessorCount</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getsimulatingprocessorcount">getSimulatingProcessorCount</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getsimulationcoretimings">getSimulationCoreTimings</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getsimulationoverruns">getSimulationOverruns</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getsimulationperformancetimings">getSimulationPerformanceTimings</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getsimulationtime">getSimulationTime</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-getsimulationtimings">getSimulationTimings</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-loadsnapshot">loadSnapshot</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-resetmonitoring">resetMonitoring</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-resetperfindic">resetPerfIndic</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-resetsimulationperformancetimings">resetSimulationPerformanceTimings</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-resettiming">resetTiming</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-simtrig">simtrig</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-startmonitoring">startMonitoring</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-startsim">startSim</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-stopmonitoring">stopMonitoring</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-stopsim">stopSim</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/simulation.md#function-takesnapshot">takeSnapshot</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Target          | Manage HYPERSIM installations and versions on remote targets.                                       | <p><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-addtargettomanager">addTargetToManager</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-diagnostictarget">diagnosticTarget</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-getalltargetsname">getAllTargetsName</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-getcurrentversionontarget">getCurrentVersionOnTarget</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-getinstalledversionontarget">getInstalledVersionOnTarget</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-installhypersimontarget">installHypersimOnTarget</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-istargetready">isTargetReady</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-removetargetfrommanager">removeTargetFromManager</a><br><a href="https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references/target.md#function-switchversionontarget">switchVersionOnTarget</a></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/hypersim-api-references.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
