Documentation Home Page ◇ eHS Toolbox Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.
Software
- Sylvain Ménard
- Fabien Ducat
Simulation Tools
The following software is required to design circuits and run simulations.
Operating System
Windows 7 (64 bits), Windows 10 (64 bits) or Windows 11 (64 bits).
Third-Party Software
MATLAB, Simulink, Simulink Coder toolbox.
One of the following:
Simscape Electrical Specialized Power Systems (SPS) Simulink toolbox,
PLECS Simulink Toolbox,
PSIM or
NI Multisim.
Firmware Development
The following software is required to develop custom FPGA firmware for particular machine/drives applications.
Third-Party Software
MATLAB and Simulink
Xilinx Vivado suite & Xilinx Vivado System Generator for DSP
Compatibility Table
The following software versions must be installed and functioning to perform the tests described in this document. Confirm that the required software is installed and tested to ensure they are functioning properly.
Support for 32 bits systems has been dropped as of eFPGASIM 2.18
Tip!
Type ver on the MATLAB prompt and verify that you have installed the following toolboxes (or later versions of them).
Component | eFPGASIM version | 2.19 | 2.18 | 2.17 | 2.16 | 2.15 | 2.14 | 2.13 | 2.12 | 2.11 | 2.10 | 2.9 | 2.8 | 2.7 | 2.6 | 2.5 | 2.4 | 2.3 | 2.2 | 2.1 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
eFPGASIM | Release | 2.19.2 | 2.18.2.19 | 2.17.4.42 | 2.16.1.35 | 2.15.4.52 | 2.14.4.76 | 2.13.2.61 | 2.12.2.68 | 2.11.4.42 | 2.10.4.42 | 2.9.5.61 | 2.8.2.42 | 2.7.1.16 | 2.6.1.23 | 2.5.3.30 | 2.4.0.24 | 2.3.3.56 | 2.2.1.59 | 2.1.2.50 |
| 32/64 bits capability | 64 bits | 32 bits 64 bits | |||||||||||||||||
HYPERSIM | Release | 2024.4 | 2024.2 | 2024.1.3 | 2024.1 | 2023.3 | 2023.2.1 | 2023.2.0 | 2023.1 | 2022.2 | 2022.1 | 2022.1 | 2021.3 | 2021.2 | 2021.1 | 2020.3 | 2020.2 | 2020.2 | 2020.1 | 2019.3 |
Compatibility | From 2024.1 | From 2024.1 | From 2024.1 | From 2024.1 | From 2023.1 | From 2023.1 | From 2023.1 | From 2023.1 | From 2022.1* | From 2020.2* | From 2020.2* | From 2020.2 | From 2020.2 | From 2020.2 | From 2020.2 | Strict | Strict | Strict | Strict | |
RT-LAB | Release | 2024.4 | 2024.3 | 2024.1.3 | 2024.1 | 2023.3 | 2023.2 | 2023.1 | 2023.1 | 2023.1 | 2022.1 | 2022.1 | 2021.3.3 | 2021.2 | 2021.1 | 2020.4 | 2020.2.2 | 2020.2.2 | 2020.1 | 2019.3 |
Compatibility | From 2024.1 | From 2024.1 | From 2024.1 | From 2024.1 | From 2022.1.1 | From 2022.1.1 | From 2022.1.1 | From 2022.1.1 | From 2020.2 | From 2020.2 | From 2020.2 | From 2020.2 | From 2020.2 | From 2020.2 | From 2020.2 | Strict | Strict | Strict | Strict | |
MATLAB | 2018b, 2019b, 2021a to 2024a | 2018b, 2019b, 2021a to 2024a | 2018b, 2019b, 2021a to 2023b | 2018b, 2019b, 2021a to 2023b | 2018b, 2021a to 2023b | 2018b, 2020a to 2023a | 2018a to 2022a | 2015b to 2022a | 2015b to 2021b | 2015b to 2021b | 2015b to 2021b | 2015b to 2020b | 2015b to 2020b | 2015b to 2019b | 2015b to 2019b | 2015b to 2019b | 2015b to 2019b | 2015b to 2019b | 2015b to 2018b | |
Schematic editor | Release | 2.19.1.2836 | 2.18.1.2819 | 2.17.2.2801 | 2.15.1.2755 | 2.15.1.2755 | 2.14.3.2720 | 2.13.8.2689 | 2.12.3.2625 | 2.11.2.2589 | 2.10.0.2568 | 2.9.3.2553 | 2.8.2.2385 | 2.7.1.2211 | 2.6.2.2081 | 2.5.3.1926 | 2.4.7.1682 | 2.4.7.1682 | 2.3.1.1540 | 2.2.0.1348 |
Compatibility | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | |
Unified Database | Release | 4.1.1.8 | 4.0.1.8 | 3.29.2.3 | 3.28.1.4 | 3.28.1.4 | 3.27.3.1 | 3.26.4.1 | 3.22.1.3 | 3.16.0.1 | 3.13.0.5 | 3.12.0.3 | 3.10.2.3 | 3.9.2.5 | 3.8.1.3 | 3.7.3.20 | 3.5.6.2 | 3.5.6.2 | 3.2.3.4 | 3.1.3.5 |
Compatibility | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | Strict | |
RT-XSG ** | Release | 3.6.0.818 | 3.5.0.817 | 3.4.1.816 | 3.4.0.815 | 3.4.0.814 | 3.3.6 | 3.3.5 | 3.3.3 | 3.3.3 | 3.3.2 | 3.3.2 | 3.3.1 | 3.3.1 | 3.3.1 | 3.3.1 | 3.3.0 | 3.3.0 | 3.2.8 | 3.2.7 |
Compatibility** | ** | ** | ** | ** | ** | ** | ** | ** | ** | ** | ** | 3.3.2 | ** | ** | ** | ** | ** | ** | ** | |
MATLAB eFPGASIM XSG lib | 2018b to 2021b | 2018b to 2021b | 2018b to 2021b | 2018b to 2021b | 2018b to 2021b | 2016b to 2021b | 2016b to 2021b |
Same as RT-LAB | ||||||||||||
| Xilinx Vivado Suite | 2018.1 - 2023.1 | 2018.1 - 2023.1 | 2018.1 - 2023.1 | 2018.1 + | 2018.1 + | 2017.1 + | 2017.1 + | N/A | |||||||||||
* Exception of Hypersim 2022.0 that does not supports eFPGASIM.
** eFPGASIM is delivering firmwares with various RT-XSG base versions, refer to the firmware name to know it.
The compatibility for a firmware based on X.Y.Z version is always from X.Y.0 version,
e.g. for a firmware name VC707_2-EX-0001-3_3_1_790-eHSx128_Gen4_Machines_IOConfig1-35-44.bin, its base RT-XSG version is 3.3.1 and its compatibility is from RT-XSG 3.3.0.
Installation of a new Matlab version
In case of a new Matlab version need to be installed over an existing eFPGASIM installation, it is required to launch the executable setup_matlab.exe located here : "<InstallationPath>\eFPGASIM\<Version>\Matlab\Setup". This will setup all the Matlab installed on the computer with eFPGASIM. Note that all Matlab processes need to be closed during the setup.
Licensed RT-LAB/HYPERSIM Components
You must have licenses for the following RT-LAB/HYPERSIM components to run eFPGASIM properly. Verify with your sales representative that your system includes these licenses.
eHS specific licence keys
Key | Required Value | Description | Status |
|---|---|---|---|
XSG_EHS | true | This will enable eHS solver. | Mandatory |
EHS_TOTAL_PERFORMANCE | >0 | This indicates the total number of cores allowed. This parameter decides the total number of eHSx32 solvers available. One eHSx32 solver will occupy a total of 1 EHS_TOTAL_PERFORMANCE token during the license verification. As an example, 4 tokens of "EHS_TOTAL_PERFORMANCE" license key allows to use either one of the following configurations: 1x eHSx128 core, 2x eHSx64 cores, 4x eHSx32 cores or any other combination that would fit within the number of tokens available. | Mandatory |
EHS_CORE_TOKEN | >0 | This indicates the license class allowed. |
|
EHS_GEN5 | true | This will enable Generation 5 of the eHS Solver. | Optional |
EHS_PADE5 | true | This will enable specific PADE5 discretization method for Generation 5 of the eHS Solver. | Optional |
EHS_X16 | >0 |
Informs the user of the eHS license class as well as the number of eHS cores that were purchased. | Informative |
EHS_X32 | >0 | Informative | |
EHS_X64 | >0 | Informative | |
EHS_X128 | >0 | Informative | |
EHS_HIGH_PERFORMANCE_TOKEN | positive integer | Enables the highest performances of eHS (only supported in eHS Gen5) This parameter decides the total number of cores allowed to get the highest performances. One eHSx32 solver will occupy a total of 32 EHS_HIGH_PERFORMANCE_TOKEN during the license verification. As an example, 128 EHS_HIGH_PERFORMANCE_TOKEN license key allows to use either one of the following configurations: 1x eHSx128 core, 2x eHSx64 cores, 4x eHSx32 cores or any other combination that would fit within the number of tokens available. | Optional |
EHS_MACHINE_CORE_TOKEN | >0 | This indicates the total number of machines allowed per model. | Mandatory |
FPGA related licence keys
Key | Required Value | Description | Status |
|---|---|---|---|
RTLAB_RT | true | Allows to execute a model in real-time mode with RT-LAB. | Mandatory |
RTLAB_XHP | true | Enables the XHP mode within RT-LAB. | Mandatory |
RTLAB_DEV | true | Allows to compile a model. | Mandatory |
RTLAB_NUM_CORES | >0 | Allows to execute a model in non real-time mode with RT-LAB. | Mandatory |
XSG_EHS | true | Enables ultra-fast electric solver (eHS) on FPGA | Mandatory |
XSG_PMSM_VDQ | true | Enables variable-DQ (VDQ) PMSM motor models on FPGA | Optional |
XSG_PMSM_SH | true | Enables spatial harmonic (SH) PMSM motor models on FPGA | Optional |
XSG_IM | true | Enables Induction machine (Double Fed - DFIM and Squirrel Cage - SCIM) | Optional |
XSG_SRM | true | Enables switched reluctance motor (SRM) models on FPGA | Optional |
XSG_FDLINE | true | Enables FD Line on FPGA |
|
RT-LAB related licence keys
Key | Required Value | Description | Status |
|---|---|---|---|
RTLAB_RT | true | Allows to execute a model in real-time mode with RT-LAB. | Mandatory |
RTLAB_XHP | true | Enables the XHP mode within RT-LAB. | Mandatory |
RTLAB_DEV | true | Allows to compile a model. | Mandatory |
RTLAB_NUM_CORES | >0 | Allows to execute a model in non real-time mode with RT-LAB. | Mandatory |
OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter