Skip to content

Commit dd0f1ea

Browse files
committed
Add section about RTI Connext DDS documentation and other resources
Signed-off-by: Andrea Sorbini <[email protected]>
1 parent 08eddf3 commit dd0f1ea

File tree

1 file changed

+102
-1
lines changed

1 file changed

+102
-1
lines changed

README.md

+102-1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,11 @@ For any questions or direct feedback, feel free to reach out to [email protected]
4747
- [Topic](#topic)
4848
- [DataWriter](#datawriter)
4949
- [DataReader](#datareader)
50+
- [RTI Connext DDS Documentation](#rti-connext-dds-documentation)
51+
- [Other RTI Connext DDS Resources](#other-rti-connext-dds-resources)
52+
- [Free Trial](#free-trial)
53+
- [RTI Community](#rti-community)
54+
- [RTI Labs](#rti-labs)
5055

5156
## Quick Start
5257

@@ -696,7 +701,7 @@ the value of several other policies which are not exposed by the ROS 2 API.
696701
For example, Connext's default settings controlling the heartbeat-based protocol
697702
performed between reliable readers and writers are not tuned for fast-paced
698703
communications and they might cause significant delays in the "repair" of samples
699-
missed by a reader. In this cae, it might be necessary to update parameters in
704+
missed by a reader. In this case, it might be necessary to update parameters in
700705
`DataWriterQos::protocol::reliable_writer` and `DataReadeQos::protocol::reliable_reader`
701706
to make applications using this type of communication more responsive.
702707
@@ -1671,3 +1676,99 @@ using [`DDS_Subscriber_delete_datareader()`](https://community.rti.com/static/do
16711676
16721677
See [Topic Deletion](#topic-deletion) for information on how the Topic associated
16731678
with the DataReader will be disposed.
1679+
1680+
## RTI Connext DDS Documentation
1681+
1682+
RTI Connext DDS and other RTI products come with extensive documentation manuals
1683+
and API references to guide users through the many available features and configuration options.
1684+
1685+
All documentation is available online, and can be easily consulted using the
1686+
links found in the [Documentation section of the RTI Community portal](https://community.rti.com/documentation).
1687+
1688+
For quick reference, here's a list of useful documentation resources for
1689+
ROS 2/DDS users:
1690+
1691+
- **RTI Connext DDS** (6.0.1)
1692+
- [Getting Started Guide](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/getting_started/index.html)
1693+
- [Installation Guide](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/RTI_ConnextDDS_InstallationGuide.html)
1694+
- [Core Libraries User's Manual](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/RTI_ConnextDDS_CoreLibraries_UsersManual.html)
1695+
- [Core Libraries Release Notes](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/RTI_ConnextDDS_CoreLibraries_ReleaseNotes.html)
1696+
- [Core Libraries What's New](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/RTI_ConnextDDS_CoreLibraries_WhatsNew.html)
1697+
- [C API Reference](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_c/index.html)
1698+
- [C++11 API Reference](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/api/connext_dds/api_cpp2/index.html)
1699+
- [QoS Policy Reference Guide (cheat-sheet)](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/RTI_ConnextDDS_CoreLibraries_QoS_Reference_Guide.pdf)
1700+
- [Property Qos Policy Reference Guide (cheat-sheet)](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/property_qos_reference_guide/index.html)
1701+
- [Extensible Types Addendum](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/getting_started_extras/html_files/RTI_ConnextDDS_CoreLibraries_GettingStarted_ExtensibleAddendum/index.htm)
1702+
- [Migration Guide from 5.3.1 to 6.0.1](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/migration_guide/index.html)
1703+
- [Getting Started (video tutorials)](https://www.rti.com/gettingstarted)
1704+
- [RTI Tech Talks (YouTube)](https://www.youtube.com/channel/UChF68q4RQSEv-a-fmqMV9BA/videos)
1705+
- **RTI Connext DDS Micro** (3.0.3)
1706+
- [User's Manual](https://community.rti.com/static/documentation/connext-micro/3.0.3/doc/html/usersmanual/index.html)
1707+
- [Release Notes](https://community.rti.com/static/documentation/connext-micro/3.0.3/doc/html/release/index.html)
1708+
- [C API Reference](https://community.rti.com/static/documentation/connext-micro/3.0.3/doc/api_c/html/index.html)
1709+
- [C++ API Reference](https://community.rti.com/static/documentation/connext-micro/3.0.3/doc/api_cpp/html/index.html)
1710+
1711+
The portal also includes documentation for older versions of RTI Connext DDS,
1712+
like [RTI Connext DDS 5.3.1](https://community.rti.com/documentation/rti-connext-dds-531), and going as far back as [RTI Connext DDS 4.5c](https://community.rti.com/documentation/rti-dds-45c).
1713+
1714+
## Other RTI Connext DDS Resources
1715+
1716+
Beside [documentation resources](#rti-connext-dds-documentation), RTI Connext DDS
1717+
users have several other resources available at their disposal to receive
1718+
help in using RTI Connext DDS, and to discover other tools in the RTI Connext DDS
1719+
family that may prove useful during different phases of the development
1720+
of their applications.
1721+
1722+
### Free Trial
1723+
1724+
RTI offers all users the ability to request a [free 30-day trial license](https://www.rti.com/free-trial), which will grant them access to a fully-functional version of Connext DDS and all of its many companion tools, such as [Admin Console](https://www.rti.com/products/tools/admin-console), [Routing Service](https://www.rti.com/products/is/routing-service),
1725+
and the [Security Plugins](https://www.rti.com/products/connext-dds-secure).
1726+
1727+
University researchers, professors, and other non-commercial programs may be
1728+
eligible for a free license. Plaese visit the [University Program](https://www.rti.com/free-trial/university-program) page for details.
1729+
1730+
### RTI Community
1731+
1732+
The [RTI Community](https://community.rti.com) portal is designed to be the
1733+
first and main point of reference for any user of RTI Connext DDS and any other RTI-developed technology.
1734+
1735+
Users may find help by posting questions in one of the available [forums](https://community.rti.com/forum), or explore a list of useful [ROS 2-related resources](https://community.rti.com/ros),
1736+
such as technical articles, and webinar recordings.
1737+
1738+
The portal includes a [documentation archive](https://community.rti.com/documentation) for all versions of RTI products (current and old).
1739+
1740+
The portal also includes an extensive collection of [code examples](https://community.rti.com/examples), ["best practices"](https://community.rti.com/best-practices), ["HOWTOs"](https://community.rti.com/howto), and ["solutions"](https://community.rti.com/solutions) which users should
1741+
refer to for learning more about the use of RTI Connext DDS, and to help with
1742+
the troubleshooting of any issue.
1743+
1744+
Finally, RTI Community provides [links to the download and project pages](https://community.rti.com/content/page/downloads) of many helpful tools which are
1745+
free for use by RTI Connext DDS users, for example:
1746+
1747+
- [nano-client](https://github.com/rticommunity/nano-client)
1748+
- [nano-agent](https://github.com/rticommunity/nano-agent)
1749+
- [rticonnextdds-connector](https://github.com/rticommunity/rticonnextdds-connector)
1750+
- [rticonnextdds-examples](https://github.com/rticommunity/rticonnextdds-examples)
1751+
- [rticonnextdds-gateway](https://github.com/rticommunity/rticonnextdds-gateway)
1752+
- [rticonnextdds-usecases](https://github.com/rticommunity/rticonnextdds-usecases)
1753+
- [RTI DDS Performance Test](https://community.rti.com/downloads/rti-connext-dds-performance-test)
1754+
- [Wireshark for RTI Connext DDS](https://community.rti.com/downloads/rti-wireshark)
1755+
1756+
### RTI Labs
1757+
1758+
The [RTI Labs](https://www.rti.com/developers/rti-labs) portal offers early
1759+
access to new technologies developed by RTI which are still in [early experimental and pre-productization stages](https://www.rti.com/developers/rti-labs/experimental-product-faq).
1760+
1761+
The various projects listed on RTI Labs not only offer users an opportunity to
1762+
try new technologies, but they also allow anyone to provide feedback via the [RTI Community forums](https://community.rti.com/forum) and influence RTI's
1763+
future product roadmap.
1764+
1765+
Please refer to the [RTI Labs](https://www.rti.com/developers/rti-labs) page for
1766+
an always up-to-date list of all latest projects.
1767+
1768+
The following is a list of some projects which might be of particular interest
1769+
to ROS 2/DDS users:
1770+
1771+
- [RTI System Designer](https://www.rti.com/developers/rti-labs/manage-complexity-and-simplify-configuration-with-system-designer)
1772+
- [RTI Python API](https://www.rti.com/developers/rti-labs/python-api)
1773+
- [Cloud Discovery Service](https://www.rti.com/developers/rti-labs/discover-data-in-cloud-services-with-cloud-discovery-service)
1774+
- [Heap Analyzer](https://www.rti.com/developers/rti-labs/visualize-dynamic-memory-with-heap-analyzer)

0 commit comments

Comments
 (0)