> 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/readme/release-notes-2022.md).

# Release Notes 2022

## Version: 2022.2

### New features

* Added support for MATLAB R2022a
* Added Control Protection Relays Models:
  * 51- Inverse Time Overcurrent (1-ph)
  * 67 - Directional Relay Based on Impedance
* Added Protection Example Model:
  * IEC 61850 SAS with MMS
* Added Control Measurement Model:
  * RMS 1-ph
* Added the following Python API commands:
  * startMonitoring() which starts running Monitor components
  * stopMonitoring() which stops running Monitor components
  * getMonitoringValue()
  * getMonitoringAllValue()
  * getLastSensorValues()
  * getSimulationTime()
* Added support for Python 3.7 to 3.9
  * Note : Support for Python 2.X will be removed in the next version
* Added capability to read .oprec files in MATLAB
* Added popup to save the sensor file when saving the .ecf model
* Added validation for CSV file playback:
  * uniqueness of time values
  * time values are ascending
* **C37.118 Slave**: Added support to scale asynchronous computation on multiple cores depending on the amount of PMUs, their data rate, and size
* **OPAL-RT Board**: Added support for new mezzanines OP5367-1, OP5367-3 and OP5367-5
* **OPAL-RT Board**: Added capability to maintain common configuration elements when switching between bitstream configurations
* **OPAL-RT Board**: Added capability to maintain the board configuration when changing the chassis type
* **OPAL-RT Board**: Added support for the OP4512 and OP4610 chassis
* **OPAL-RT Board**: Added support for 64 ports LoadIN and LoadOUT
* **Signal Generator**: Added support for .oprec as input data files
* **Synchronization**: Added support for C37.238-2017 sync profile for Oregano
* **Synchronization**: Added capability to launch the synchronization setup tool at boot time, thus accelerating simulation start time after a system reboot
* **Synchronization**: Added support for Oregano card revision 2.3 (OPAL-RTLinux x64-based)
* **TCP-UDP**: Added capability to automatically correct overlap in data frames
* **Communication Network Simulation**: Added support for the new IEC 61850 I/O interface

### Improvements

* Improved acquisition performance with HYPERSIM data source in ScopeView
* Improved PSCAD/PSSE import through custom options and separate menus
* Improved Line Distance Protection with POTT example with updated protection components
* Improved Renewable Energy Example Models with native components instead of UCM for controls:
  * BESS
  * PVGS
* Improved error messages on certain license installation issues
* Improved expression's Content Editor by indicating the model unit
* Improved pu Unit Notation consistency through all components
* **I/O interface**: Improved network configuration by validating the port used at simulation start (C37.118 Slave, DNP3 Slave, IEC 60870-5-104 Slave, IEC 61850 MMS, MODBUS TCP Slave, OPC-UA Server)
* **IEC 61850**: Improved network configuration validation for MMS
* **OPAL-RT Board**: Improved configuration file management for the FPGA scope feature

### Bug fixes

* Fixed issue with machines when wye grounded stator connection is selected
* Fixed limitation during acquisition in ScopeView when reading more than 100 .out PSCAD files
* Fixed expression unit display when setting an expression on a transformer parameter that depends on the connection type
* Fixed Python API closeHyperWorks() not working if the API connects to a manually started HYPERSIM instance
* Fixed Python API closeHyperWorks() global name 'proc' is not defined when used after startAndConnectHypersim()
* Fixed issue with license installation on target when the clock has changed within 24h range
* Fixed timing display in the .simout console when localhost simulation is stopped
* Fixed issue with non-persisting UI user-defined property values when updating HYPERSIM
* Fixed .simout console not highlighting warnings and errors in color
* Fixed issue with processes leading to target instabilities
* **C37.118 Slave**: Fixed limitation of 1000 slaves per instance
* **C37.118 Slave**: Fixed communication issue when the IDs of consecutive PMUs are not in ascending order
* **IEC 61850**: Fixed stack trace appearing at reset
* **OPAL-RT Board**: Fixed various FPGA enumeration issues
* **FPGA-Based Simulation**: Fixed path used for the configuration file of the FPGA scope

### Known issues

N/A

***

## Version: 2022.1

### New features

* Added the ability to simultaneously run 2 or more instances of HYPERSIM on the host PC
* Added a license for PSCAD Import available to all users
* Added a license for PSS®E Import available to all users
* Added a model to the Target Inputs and Outputs Library:
  * Target I/O Interface to help visualize and simplify the management of I/O connections in the schematic
* Added models to the Control Protection Relay Library:
  * 27 - Undervoltage Relay (1-ph)
  * 50 - Instantaneous or Definite Time Overcurrent Relay (1-ph)
  * 50BF - Breaker Failure Protection
  * 59 - Overvoltage Relay (1-ph)
  * 79 - Auto recloser
* Added new Example models:
  * Renewable Energy: MicroGrid Droop Control which demonstrates the Islanded Operation of an Inverter-based Microgrid Using a Droop Control Technique
  * IO Interfaces: MuSE Example Project with the OP5033 which shows how MuSE can easily expand I/O capability by connecting multiple FPGA-based I/O expansion chassis
  * IO Interfaces: Added MMS Support and the IO Interface component to the IEC61850 Sync1588 Example Model
* Added the following Python API commands:
  * getMonitoringValue which returns the current value of the specified, actively running Monitor Block
  * getMonitoringAllValues which returns the current value of all actively running Monitor Blocks
* Added a new Warning for devices that are missing sensors
* Added a "Select/Deselect All" option for Record in Sensors Summary Form
* Added the ability to lock a model when a second user opens the same model when more than one instance of HYPERSIM is running
* Added a Transformer Data tab in the Z-Based Transformer Parameter form that enables users to automatically generate parameters from manufacturer specifications
* Added FPGA details and a refresh button to the Target Information window that returns FPGA card type and Chassis ID
* **I/O interface**: Added jitter detection mechanism during idle time (hardware and software sync)
* **IEC 61850**: Added a new I/O interface with support for IEC 61850 MMS protocol
* **IEC 61850**: Added conversion wizard to port legacy configuration and connections to the new interface
* **Modbus Master**: Added the triggered read/write functionality
* **OPAL-RT Board**: Added support for new mezzanine OP5360-3
* **OPAL-RT Board**: Added BETA support for new mezzanines OP5367-1, OP5367-3, OP5367-5

### Improvements

* Improved the simulation startup time for large models
* Improved the Sensor Management workflow
* Improved Simulation Settings window with a cleaner interface, and additional information such as the Target Architecture
* Improved error messages:
  * related to RPC timeouts by giving more specific information and additional details
  * when a user attempts to start or apply a Target when the license (Host and/or Target) is invalid or missing
* Improved battery current measurement from bundle to output pin which will improve stability
* **I/O interface**: Improved I/O Configuration UI:
  * Added filter columns on table of any configuration page
* **I/O interface**: Fixed reorder columns on any configuration page
  * Removed the "Add above" button and simplified additions in lists by reducing insertion buttons to just 1
* **I/O interface**: Improved the handling time of large configurations
* **I/O interface**: Improved the configuration of the collapsed tree state following a refresh

### Bug fixes

* Fixed .oprec opening error when double-clicking on the file
* Fixed signal group returning to the default value when clicking on record in sensor summary view
* Fixed issue in Export Project Wizard where not all sensor configuration files were listed
* Fixed issue where localhost would sometimes not initialize due an IP address conflict
* Fixed naming of the output current and input voltage in the "Controlled V Source, series" to help address stability issues in models using this component
* **IEC 61850**: Fixed use on non-English Windows PCs
* **IEC 61850**: Fixed microsecond value placed in GOOSE packets when using the automatic clock detection mechanism
* **Modbus Master**: Fixed byte ordering when reading float values
* **OPAL-RT Board**: Fixed use of PWM Synchronize AIn (RCP) on OPAL-RTLinux systems
* **OPAL-RT Board**: Fixed TSDIN performance issues
* **OPAL-RT Board**: Fixed overruns occurring due to remotes not having output connections
* **OPAL-RT Board**: Fixed incompatibility between the Fast Scope FPGA and Default Output Values (DOV) features
* **OPAL-RT Board**: Fixed board ID validation issues for threshold (OP5369) and multi-rate (OP5030-#) configuration on remotes

### Breaking changes

* Removed Samba dependencies
* Removed export as JPG in ScopeView (image export only supports \*.png)

### Known issues

N/A


---

# 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/readme/release-notes-2022.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.
