Using the correct Niagara version and matching driver releases is essential for stable operation, compatibility and successful commissioning.
Why Version Matching Matters
Version matching helps you:
- Ensure compatibility between Workbench and controllers.
- Avoid errors and issues when making changes.
- Use the correct drivers built for your Niagara version.
1. Use a Matching Workbench Version
Connect to the controller using the same major Niagara version.
For example, if the controller is running Niagara 4.10.5, use Niagara 4.10 in Workbench.
As a best practice, upgrade controllers to the latest maintenance release, such as Niagara 4.10.9.
Using a different version may allow you to connect but can lead to issues when making significant changes.
2. Use the Correct Driver Version
Drivers are built for specific Niagara versions, including individual maintenance releases.
Examples include:
- Niagara 4.10.7
- Niagara 4.10.8
- Niagara 4.10.9
- Niagara 4.13.2
- Niagara 4.14.0
Niagara 4.10 is a Long-Term Maintenance release. Upgrade to the latest version for security patches at no extra cost.
Always use the driver built for your exact version.
You cannot use a Niagara 4.10 driver on a Niagara 4.14 system, or vice versa.
Tyrrell Products provides version-specific driver releases to ensure full compatibility and reliable operation.
3. Driver Files: What You Get
Each driver package contains two JAR files:
tyrellIP-rt.jartyrellIP-wb.jar
You always need both files.
Whether both files are used on the controller depends on Runtime Profiles, including whether the user interface is enabled during commissioning.
Copy both files from the downloaded package.
4. Where to Install Drivers
- Go to your Niagara installation folder. Example:
C:\NiagaraUse the correct brand folder if different. - Open the version folder. Example:
4.13.2 - Open the
modulesfolder. - Copy the two JAR files into the
modulesfolder. - If prompted, replace the existing files to ensure you have the latest version.
The driver is now available for use on your local machine and for commissioning.
5. Checking JAR Compatibility
Open the JAR file with WinRAR or 7-Zip.
Navigate to META-INF and open module.xml.
<module>
<name>tyrellIP</name>
<vendor>Tyrrell Products</vendor>
<vendorVersion>4.13.2.18</vendorVersion>
<buildDate>2024-11-15</buildDate>
<runtimeProfile>true</runtimeProfile>
...
</module>
The Vendor Version shows the exact Niagara version for which the driver was compiled.
Using a driver with a different Vendor Version is not supported and may cause issues.
When in doubt, get the driver version that explicitly supports your Niagara release.
6. Driver Files Are Stored in Multiple Locations
After being copied to the modules folder, Niagara also stores drivers in the software repository.
Modules Folder – Active Version
tyrellIP-rt.jartyrellIP-wb.jar
Software Repository – All Installed Versions
...\Niagara\software\tyrellIP\
The software repository may contain multiple versions, such as:
- 18.6
- 18.7
- 18.8
When new driver versions are installed, they are added to the software repository. This allows you to choose which version to install on a controller.
7. Software Manager Version Control
When connected to a controller, Niagara scans the software repository and shows available versions in Software Manager.
In the example, the JACE is running Niagara 4.10.7 while Workbench is running Niagara 4.13.2.
Niagara prevents cross-version installation. To install a driver for a different platform version, recommissioning is required.
Key Takeaway
Version control is critical when working with Niagara.
- Use a matching Workbench version.
- Upgrade controllers to the latest maintenance release.
- Use drivers built for your exact Niagara version.
- Always replace with the latest driver files.
- Check compatibility using
module.xmlor Software Manager. - Avoid mixing different major versions.
Best Practices
- Plan upgrades carefully and test in a lab environment.
- Keep a record of driver versions used on each site.
- Always download drivers from your trusted supplier.
- When upgrading Tridium Niagara, ensure all third-party drivers are compatible with the new version.
Download the Correct Driver Versions
Visit www.tyrrellproducts.com for the latest driver releases.
Note: Using incorrect versions can cause instability, unexpected behaviour and loss of functionality.
Always use the correct Niagara and driver versions for reliable and secure operation.