Releases: ni/niveristand-scan-engine-ethercat-custom-device
Scan Engine and EtherCAT Custom Device 24.0.0 (2024 Q1)
Enhancements
- Add support for VeriStand 2024 Q1
- Replace "localhost" with target IP address to auto-detect more than 255 IO Variables #261
VeriStand Version Support
- VeriStand 2024
- VeriStand 2023
- VeriStand 2021
VeriStand Version Support Removed
- VeriStand 2020
Packages and Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_24.0.0.7_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_24.0.0.7_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_24.0.0.7_windows_x64.nipkg
- Optional
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 2024 Q1 or later to install.
Scan Engine and EtherCAT Custom Device 23.8.0 (2023 Q4)
Enhancements
- Add option to disable Refresh Modules code to use persistent config #255
VeriStand Version Support
- VeriStand 2023
- VeriStand 2021
- VeriStand 2020
Packages and Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_23.8.0.2_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_23.8.0.2_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_23.8.0.2_windows_x64.nipkg
- Optional
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 2023 Q4 or later to install.
Scan Engine and EtherCAT Custom Device 23.5.0 (2023 Q3)
Enhancements
- Enable third-party EtherCAT Slaves with Modules #249
Bug Fixes
- Fix error file installation for VeriStand 2021 and newer #253
VeriStand Version Support
- VeriStand 2023
- VeriStand 2021
- VeriStand 2020
Packages and Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_23.5.0.6_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_23.5.0.6_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_23.5.0.6_windows_x64.nipkg
- Optional
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 2023 Q3 or later to install.
Scan Engine and EtherCAT Custom Device 23.3.0 (2023 Q2)
Enhancements
- Add cRIO and C Series Help to Slot Page #228
- Check if EtherCAT Driver is installed before calling into DLL #244
Bug Fixes
- Fix Auto-Detect and EtherCAT actions in 2023 Q1 #236
VeriStand Version Support
- VeriStand 2023
- VeriStand 2021
- VeriStand 2020
Packages and Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_23.3.0.6_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_23.3.0.6_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_23.3.0.6_windows_x64.nipkg
- Optional
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 2023 Q1 or later to install.
Scan Engine and EtherCAT Custom Device 23.0.0 (2023 Q1)
Enhancements
- Add support for VeriStand 2023 Q1
VeriStand Version Support
- VeriStand 2023
- VeriStand 2021
- VeriStand 2020
VeriStand Version Support Removed
- VeriStand 2019
Packages and Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_23.0.0.7_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_23.0.0.7_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_23.0.0.7_windows_x64.nipkg
- Optional
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 2023 Q1 or later to install.
Scan Engine and EtherCAT Custom Device 21.3.1
Enhancements
- Add property to optionally enable Distributed Clock on third-party EtherCAT devices #216
Bug Fixes
- Fix discovery of some third-party EtherCAT devices due to
Refresh Modules
error #215 - VeriStand 2021 packages failed to install error file and scripting API
Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_21.3.1.2_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_21.3.1.2_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_21.3.1.2_windows_x64.nipkg
- Optional
VeriStand Version Support
- VeriStand 2021
- VeriStand 2020
- VeriStand 2019
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 21.8 or later to install.
Scan Engine and EtherCAT Custom Device 21.3.0
Enhancements
- Enable hybrid mode deployment on Combo Chassis #205
Bug Fixes
- Check if LV, LVRT, and ECAT are installed before launching ECAT dialog #210
Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_21.3.0.6_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_21.3.0.6_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_21.3.0.6_windows_x64.nipkg
- Optional
VeriStand Version Support
- VeriStand 2021
- VeriStand 2020
- VeriStand 2019
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 21.8 or later to install.
Scan Engine and EtherCAT Custom Device 21.2.0
Enhancements
- Update readme with more details and dependencies #198
Bug Fixes
- Update
Get ECAT IOVar Data.vi
to address Bug 881503 #199 - Remove Phar Lap and Linux ARM targets from CD XML #202
- Remove FPGA dependent files when changing bitfiles #203
- Disable engine debug prints of variable names behind debug symbol #204
Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_21.2.0.8_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_21.2.0.8_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_21.2.0.8_windows_x64.nipkg
- Optional
VeriStand Version Support
- VeriStand 2021
- VeriStand 2020
- VeriStand 2019
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 21.8 or later to install.
Scan Engine and EtherCAT Custom Device 21.0.0
Enhancements
- Add support for VeriStand 2021
Bug Fixes
- Auto-detect should not remove the existing configuration if auto-detect fails #166
Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_21.0.0.24_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_21.0.0.24_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_21.0.0.24_windows_x64.nipkg
- Optional
VeriStand Version Support
- VeriStand 2021
- VeriStand 2020
- VeriStand 2019
VeriStand Version Support Removed
- VeriStand 2018
- VeriStand 2017
RT Target Support Removed
- Phar Lap ETS
- ARM-based Linux Real-Time
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 21.3 or later to install.
Scan Engine and EtherCAT Custom Device 20.4.0
Enhancements
- Initial release of limited-scope Scripting API (see below)
Bug Fixes
- Error dialog now appears when attempting to add a local chassis twice #103
Scripting API
Initial Release Scope
This release introduces a Scripting API for the Custom Device. It is of limited scope, only providing operations for configuring C Series modules in a local chassis. Only a small subset of modules supported by the Custom Device are configurable via the Scripting API. Current high level actions include:
- Add/remove/find the Custom Device and Local Chassis
- Set Custom Device and chassis properties
- Create or read module information per slot
Module Support
This is a list of modules supported by the Scripting API. Note that not all modules are supported in every configuration, such as Digital Input modules not supporting Specialty Digital configurations.
9212, 9213, 9224, 9225, 9227, 9228, 9375, 9422, 9423, 9437, 9474, 9475, 9482
Example VIs
An example project and VIs showing how to use the Scripting API can be found on disk at the path below. The LabVIEW Examples package must be installed to use them.
<Program Files (x86)>\National Instruments\LabVIEW 20xx\examples\NI VeriStand Custom Devices\Scan Engine\Scan Engine Scripting Examples.lvproj
Install Order
Optional packages are included that enable scripting each of the custom device configurations from LabVIEW, as well as examples of using these scripting APIs. To use these packages, the install order is as follows:
ni-scan-engine-veristand-<version>-support_20.4.0.21_windows_x64.nipkg
- Requiredni-scan-engine-veristand-<version>-labview-support_20.4.0.21_windows_x64.nipkg
- Optionalni-scan-engine-veristand-<version>-labview-examples_20.4.0.21_windows_x64.nipkg
- Optional
VeriStand Version Support
- VeriStand 2020
- VeriStand 2019
- VeriStand 2018
- VeriStand 2017
NIPM Compatibility
All installer packages (.nipkg) require NI Package Manager 20.5 or later to install.