Skip to content

Commit 3a0d2ec

Browse files
neil-rtijacobperron
neil-rti
authored and
jacobperron
committed
Update RTI Connext installation details for 6.0.0--5.3.1 clarity (ros2#285)
* update to show 5.3.1 options * add university link to debian install * minor edits * fix Travis CI build fails
1 parent bfe80ed commit 3a0d2ec

16 files changed

+131
-70
lines changed

‎source/Installation/Crystal/Install-Connext-University-Eval.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
.. redirect-from::
2+
3+
Install-Connext-University-Eval
4+
Installation/Install-Connext-University-Eval
5+
6+
Installing University or Evaluation Versions of RTI Connext DDS
7+
===============================================================
8+
9+
A libraries-only version of RTI Connext DDS 5.3.1 may be installed per the `installation instructions <Linux-Install-Debians>` for
10+
Debian/Ubuntu Linux (amd64) platforms only, under a `non-commercial license <https://www.rti.com/ncl>`__.
11+
12+
A full-suite installation of RTI Connext DDS is available for many additional platforms, for universities, evaluation, or purchase.
13+
This installation includes diagnostic tools, layered services, and security. See below for installation details.
14+
15+
.. note::
16+
As of the ROS2 'Dashing' release, the Connext RMW layer in ROS2 is compatible with version 5.3.x of RTI Connext DDS, but not with the most-recent version (6.0.0).
17+
18+
The Connext RMW layer is being modified for 6.0.x compatibility and will be available prior to the next release of ROS2.
19+
20+
RTI University Program
21+
----------------------
22+
23+
University researchers and classroom users may be eligible for a free academic license through the `RTI University Program <https://www.rti.com/free-trial/university-program>`__.
24+
This includes a one-year (renewable) license to the unabridged version of Connext DDS Secure, which includes diagnostic tools and layered services.
25+
The university license application can be found `here <https://www.rti.com/free-trial/university-program>`__.
26+
27+
28+
RTI Connext DDS Evaluation
29+
--------------------------
30+
31+
To install RTI Connext DDS **version 5.3.1** Evalution:
32+
* Visit the `RTI Free Trial (5.3.1) site <https://www.rti.com/free-trial-5.3.1>`__.
33+
* Register using the online form.
34+
* When directed to the download page, choose the **version 5.3.1** installer for your platform.
35+
* Install RTI Connext 5.3.1 by running the installation program. When finished, it will run the RTI Launcher.
36+
* Use the RTI Launcher to install the license file (rti_license.dat) if needed. The launcher may also be used to launch the diagnostic tools and services.

‎source/Installation/Crystal/Linux-Development-Setup.rst‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -191,20 +191,21 @@ If you want to install the Connext DDS-Security plugins please refer to `this pa
191191
Official binary packages from RTI
192192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193193

194-
You can install the Connext 5.3.1 package for Linux provided by RTI from their `downloads page <https://www.rti.com/downloads>`__.
194+
You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <Install-Connext-University-Eval>`.
195+
196+
After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it.
197+
Note that if you're installing to a system directory use ``sudo`` as well.
198+
199+
The default location is ``~/rti_connext_dds-5.3.1``
200+
201+
After installation, run RTI launcher and point it to your license file (obtained from RTI).
195202

196-
To use RTI Connext you will need to have obtained a license from RTI.
197203
Add the following line to your ``.bashrc`` file pointing to your copy of the license.
198204

199205
.. code-block:: bash
200206
201207
export RTI_LICENSE_FILE=path/to/rti_license.dat
202208
203-
After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it.
204-
Note that if you're installing to a system directory use ``sudo`` as well.
205-
206-
The default location is ``~/rti_connext_dds-5.3.1``
207-
208209
Source the setup file to set the ``NDDSHOME`` environment variable.
209210

210211
.. code-block:: bash

‎source/Installation/Crystal/Linux-Install-Binary.rst‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -108,21 +108,31 @@ Bouncy and earlier:
108108
RTI Connext (version 5.3.1, amd64 only)
109109
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
110110

111-
To use RTI Connext you will need to have obtained a license from RTI.
111+
To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
112+
or you can install a libraries-only Debian package of RTI Connext 5.3.1, available from the OSRF Apt respository
113+
under a `non-commercial license <https://www.rti.com/ncl>`__.
114+
115+
To install the libs-only Debian package:
116+
.. code-block:: bash
117+
118+
sudo apt update && sudo apt install -q -y \
119+
rti-connext-dds-5.3.1
120+
121+
You will need to accept a license agreement from RTI, and will find an 'rti_license.dat file in the installation.
122+
112123
Add the following line to your ``.bashrc`` file pointing to your copy of the license (and source it).
113124

114125
.. code-block:: bash
115126
116127
export RTI_LICENSE_FILE=path/to/rti_license.dat
117128
118-
You can install a Debian package of RTI Connext built by OSRF.
119-
You will need to accept a license from RTI.
129+
All options need you to source the setup file to set the ``NDDSHOME`` environment variable:
120130

121131
.. code-block:: bash
122132
123-
sudo apt update && sudo apt install -q -y \
124-
rti-connext-dds-5.3.1
133+
cd /opt/rti.com/rti_connext_dds-5.3.1/resource/scripts && source ./rtisetenv_x64Linux3gcc5.4.0.bash; cd -
125134
135+
Note: the above may need modification to match your RTI installation location
126136

127137
If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.
128138

‎source/Installation/Crystal/Linux-Install-Debians.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ If you want to install the Connext DDS-Security plugins please refer to `this pa
142142

143143
.. _linux-ros1-add-pkgs:
144144

145+
`University, purchase or evaluation <Install-Connext-University-Eval>` options are also available for RTI Connext.
146+
145147
Install additional packages using ROS 1 packages
146148
------------------------------------------------
147149

‎source/Installation/Crystal/OSX-Development-Setup.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,7 @@ Source the ``release.com`` file provided to set up the environment before buildi
191191
RTI Connext (5.3)
192192
^^^^^^^^^^^^^^^^^
193193

194-
To use RTI Connext you will need to have obtained a license from RTI.
195-
196-
You can install the OS X package of Connext version 5.3 provided by RTI from their `downloads page <https://www.rti.com/downloads>`__.
194+
If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`.
197195

198196
You also need a Java runtime installed to run the RTI code generator, which you can get `here <https://support.apple.com/kb/DL1572?locale=en_US>`__.
199197

‎source/Installation/Crystal/OSX-Install-Binary.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable
140140
Enable Connext support
141141
^^^^^^^^^^^^^^^^^^^^^^
142142

143-
To use RTI Connext you will need to have obtained a license from RTI.
144-
145-
You can install the OS X package of Connext version 5.3.1 provided by RTI from their `downloads page <https://www.rti.com/downloads>`__.
143+
To use RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
146144

147145
After installing, run RTI launcher and point it to your license file.
148146

‎source/Installation/Crystal/Windows-Development-Setup.rst‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,15 +204,17 @@ where the exact paths may need to be slightly altered depending on where you sel
204204
RTI Connext 5.3
205205
^^^^^^^^^^^^^^^
206206

207-
If you would like to also build against RTI Connext, you will need to first visit the RTI website and obtain a license (evaluation or purchased) for RTI Connext DDS as well as the installer via their `downloads page <https://www.rti.com/downloads>`__.
207+
If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`.
208+
208209
After installing, use the RTI Launcher to load your license file.
210+
209211
Then before building ROS 2, set up the Connext environment:
210212

211213
.. code-block:: bash
212214
213215
call "C:\Program Files\rti_connext_dds-5.3.1\resource\scripts\rtisetenv_x64Win64VS2017.bat"
214216
215-
Note that this path might need to be slightly altered depending on where you selected to install RTI Connext DDS.
217+
Note that this path might need to be slightly altered depending on where you selected to install RTI Connext DDS, and which version of Visual Studio was selected.
216218
The path above is the current default path as of version 5.3.1, but will change as the version numbers increment in the future.
217219

218220
If you want to install the Connext DDS-Security plugins please refer to `this page <Install-Connext-Security-Plugins>`.

‎source/Installation/Crystal/Windows-Install-Binary.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable
119119
RTI Connext
120120
~~~~~~~~~~~
121121

122-
To use RTI Connext (available as of ROS 2 Bouncy) you will need to have obtained a license from RTI.
123-
124-
You can install the Windows package of Connext version 5.3.1 provided by RTI from their `downloads page <https://www.rti.com/downloads>`__.
122+
To use RTI Connext DDS there are options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
125123

126124
After installing, run RTI launcher and point it to your license file.
127125

‎source/Installation/Dashing/Install-Connext-University-Eval.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Installing University or Evaluation Versions of RTI Connext DDS
2+
===============================================================
3+
4+
A libraries-only version of RTI Connext DDS 5.3.1 may be installed per the `installation instructions <Linux-Install-Debians>` for
5+
Debian/Ubuntu Linux (amd64) platforms only, under a `non-commercial license <https://www.rti.com/ncl>`__.
6+
7+
A full-suite installation of RTI Connext DDS is available for many additional platforms, for universities, evaluation, or purchase.
8+
This installation includes diagnostic tools, layered services, and security. See below for installation details.
9+
10+
.. note::
11+
As of the ROS2 'Dashing' release, the Connext RMW layer in ROS2 is compatible with version 5.3.x of RTI Connext DDS, but not with the most-recent version (6.0.0).
12+
13+
The Connext RMW layer is being modified for 6.0.x compatibility and will be available prior to the next release of ROS2.
14+
15+
RTI University Program
16+
----------------------
17+
18+
University researchers and classroom users may be eligible for a free academic license through the `RTI University Program <https://www.rti.com/free-trial/university-program>`__.
19+
This includes a one-year (renewable) license to the unabridged version of Connext DDS Secure, which includes diagnostic tools and layered services.
20+
The university license application can be found `here <https://www.rti.com/free-trial/university-program>`__.
21+
22+
23+
RTI Connext DDS Evaluation
24+
--------------------------
25+
26+
To install RTI Connext DDS **version 5.3.1** Evalution:
27+
* Visit the `RTI Free Trial (5.3.1) site <https://www.rti.com/free-trial-5.3.1>`__.
28+
* Register using the online form.
29+
* When directed to the download page, choose the **version 5.3.1** installer for your platform.
30+
* Install RTI Connext 5.3.1 by running the installation program. When finished, it will run the RTI Launcher.
31+
* Use the RTI Launcher to install the license file (rti_license.dat) if needed. The launcher may also be used to launch the diagnostic tools and services.

‎source/Installation/Dashing/Linux-Development-Setup.rst‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -185,20 +185,21 @@ If you want to install the Connext DDS-Security plugins please refer to `this pa
185185
Official binary packages from RTI
186186
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187187

188-
You can install the Connext 5.3.1 package for Linux provided by RTI from their `downloads page <https://www.rti.com/downloads>`__.
188+
You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <Install-Connext-University-Eval>`
189+
190+
After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it.
191+
Note that if you're installing to a system directory use ``sudo`` as well.
192+
193+
The default location is ``~/rti_connext_dds-5.3.1``
194+
195+
After installation, run RTI launcher and point it to your license file (obtained from RTI).
189196

190-
To use RTI Connext you will need to have obtained a license from RTI.
191197
Add the following line to your ``.bashrc`` file pointing to your copy of the license.
192198

193199
.. code-block:: bash
194200
195201
export RTI_LICENSE_FILE=path/to/rti_license.dat
196202
197-
After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it.
198-
Note that if you're installing to a system directory use ``sudo`` as well.
199-
200-
The default location is ``~/rti_connext_dds-5.3.1``
201-
202203
Source the setup file to set the ``NDDSHOME`` environment variable.
203204

204205
.. code-block:: bash

0 commit comments

Comments
 (0)