Skip to content

Commit fda315a

Browse files
committed
Additional README sections
Signed-off-by: Andrea Sorbini <[email protected]>
1 parent 4720d77 commit fda315a

File tree

1 file changed

+39
-7
lines changed

1 file changed

+39
-7
lines changed

README.md

+39-7
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,11 @@ For any questions or direct feedback, feel free to reach out to [email protected]
3535
- [RMW_CONNEXT_UDP_INTERFACE](#rmw_connext_udp_interface)
3636
- [RMW_CONNEXT_USE_DEFAULT_PUBLISH_MODE](#rmw_connext_use_default_publish_mode)
3737
- [DDS Quality of Service Configuration](#dds-quality-of-service-configuration)
38-
- [Customize QoS via XML](#customize-qos-via-xml)
39-
- [Customize DomainParticipant QoS](#customize-domainparticipant-qos)
40-
- [Customize DataWriter and DataReader QoS](#customize-datawriter-and-datareader-qos)
38+
- [Customizing QoS via XML](#customizing-qos-via-xml)
39+
- [Loading Custom QoS Profiles](#loading-custom-qos-profiles)
40+
- [DomainParticipant QoS](#domainparticipant-qos)
41+
- [DataWriter and DataReader QoS](#datawriter-and-datareader-qos)
42+
- [Configuring QoS Using Only XML Files](#configuring-qos-using-only-xml-files)
4143
- [Built-in ROS 2 QoS Profiles](#built-in-ros-2-qos-profiles)
4244
- [DDS Entities Created by the RMW Layer](#dds-entities-created-by-the-rmw-layer)
4345
- [DomainParticipantFactory](#domainparticipantfactory)
@@ -715,7 +717,7 @@ QoS configuration applicable to `rmw_connextdds`.
715717
Since RTI Connext DDS Micro does not support external QoS configuration, most of
716718
these customizations are not yet available to users of `rmw_connextddsmicro`.
717719
718-
### Customize QoS via XML
720+
### Customizing QoS via XML
719721
720722
`rmw_connextdds` supports the specification of most of its initialization parameters,
721723
[including Quality of Service configuration](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/html_files/RTI_ConnextDDS_CoreLibraries_UsersManual/index.htm#UsersManual/XMLConfiguration.htm),
@@ -869,7 +871,11 @@ Connext 6.x).
869871
870872
You might also be interested in learning more about [topic filters](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/html_files/RTI_ConnextDDS_CoreLibraries_UsersManual/index.htm#UsersManual/Topic_Filters.htm), and [how to overwrite default QoS values](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/html_files/RTI_ConnextDDS_CoreLibraries_UsersManual/index.htm#UsersManual/Overwriting_Default_QoS_Values.htm?Highlight=is_default_qos).
871873
872-
### Customize DomainParticipant QoS
874+
### Loading Custom QoS Profiles
875+
876+
TODO
877+
878+
### DomainParticipant QoS
873879
874880
`rmw_connextdds` will create a single DomainParticipant for each ROS context, which
875881
will be shared by all Nodes associated with that context (typically all Nodes created
@@ -903,7 +909,7 @@ in [ros2_qos_profiles.xml](rmw_connextdds/resource/xml/ros2_qos_profiles.xml),
903909
for example, `ros2::rmw_connextdds.base_participant`. See [Built-in ROS 2 QoS Profiles](#built-in-ros-2-qos-profiles) for more information about these QoS profiles
904910
and how to use them.
905911
906-
### Customize DataWriter and DataReader QoS
912+
### DataWriter and DataReader QoS
907913
908914
`rmw_connextdds` will include the topic name when querying for the default QoS values
909915
used by a new DDS endpoint. This allows users to take advantage of [topic filters](https://community.rti.com/static/documentation/connext-dds/6.0.1/doc/manuals/connext_dds/html_files/RTI_ConnextDDS_CoreLibraries_UsersManual/index.htm#UsersManual/Topic_Filters.htm)
@@ -981,6 +987,28 @@ about some useful QoS profiles contained in file [ros2_qos_profiles.xml](rmw_con
981987
endpoints and to replicate several of the QoS optimizations applied by
982988
`rmw_connextdds`.
983989
990+
### Configuring QoS Using Only XML Files
991+
992+
If you want to completely disable all QoS customizations applied by
993+
`rmw_connextdds` in code, and rely only on QoS configurations specified in
994+
XML files, you should set the following envirionment variable:
995+
996+
- [`RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY=never`](#rmw_connext_participant_qos_override_policy)
997+
- [`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY=never`](#rmw_connext_endpoint_qos_override_policy)
998+
- [`RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS=y`](#rmw_connext_disable_large_data_optimizations)
999+
- [`RMW_CONNEXT_USE_DEFAULT_PUBLISH_MODE=y`](#rmw_connext_use_default_publish_mode)
1000+
1001+
For example:
1002+
1003+
```sh
1004+
RMW_IMPLEMENTATION=rmw_connextdds \
1005+
RMW_CONNEXT_PARTICIPANT_QOS_OVERRIDE_POLICY=never \
1006+
RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY=never \
1007+
RMW_CONNEXT_DISABLE_LARGE_DATA_OPTIMIZATIONS=y \
1008+
RMW_CONNEXT_USE_DEFAULT_PUBLISH_MODE=y \
1009+
ros2 run demo_nodes_cpp talker
1010+
```
1011+
9841012
### Built-in ROS 2 QoS Profiles
9851013
9861014
#### ros2_qos_profiles.xml
@@ -1163,6 +1191,10 @@ discovery.
11631191
This is achieved by increasing the period at which Heartbeats are sent by the
11641192
built-in DDS discovery writers.
11651193
1194+
#### USER_QOS_PROFILES.example.xml
1195+
1196+
TODO
1197+
11661198
## DDS Entities Created by the RMW Layer
11671199
11681200
When an application uses the ROS 2 API to perform operations such as initializing
@@ -1630,7 +1662,7 @@ will perform the following operations:
16301662
- This operation is only available in `rmw_connextdds`, and it allows for "topic filters"
16311663
to be taken into consideration when determining the default QoS.
16321664
- Since XML-based configuration is not available with RTI Connext DDS Micro,
1633-
`rmw_connextddsmicro` will fall back to [`DDS_Subscriber_get_default_datawriter_qos()`]().
1665+
`rmw_connextddsmicro` will fall back to [`DDS_Subscriber_get_default_datareader_qos()`](https://community.rti.com/static/documentation/connext-micro/3.0.3/doc/api_c/html/group__DDSSubscriberModule.html#gab34681872803713ab97a63be91794fbd).
16341666
- In the case of `rmw_connextdds`:
16351667
- Based on [`RMW_CONNEXT_ENDPOINT_QOS_OVERRIDE_POLICY`](#rmw_connext_endpoint_qos_override_policy),
16361668
apply the ROS 2 QoS profile on top of the default QoS policy, and overwrite

0 commit comments

Comments
 (0)