Skip to content

Commit 24b3de4

Browse files
authored
Update RMW configuration (#369)
Signed-off-by: Pablo Garrido <pablogs9@gmail.com>
1 parent 923839c commit 24b3de4

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

  • _docs/tutorials/advanced/microxrcedds_rmw_configuration

_docs/tutorials/advanced/microxrcedds_rmw_configuration/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,16 @@ It is achieved by splitting the raw buffer into chunks, each of which contains a
3636
The size of the best-effort and reliable stream can be configured by two sets of CMake flags.
3737

3838
* `UCLIENT_UDP_TRANSPORT_MTU`, `UCLIENT_TCP_TRANSPORT_MTU` and `UCLIENT_SERIAL_TRANSPORT_MTU` (depending on the transport selected): these flags control the size of the best-effort stream buffer which matches with the size of each chunk of the reliable stream.
39-
* `RMW_UXRCE_MAX_HISTORY`: sets the number of slots for the reliable streams.
39+
* `RMW_UXRCE_STREAM_HISTORY`: sets the number of slots for the reliable streams.
4040

4141
The size of the stream sets indirectly the maximum message size (MMS) of the micro-ROS application.
42-
This MMS is (`UCLIENT_<XXX>_TRANSPORT_MTU` - 12 B) for best-effort messages and (`UCLIENT_<XXX>_TRANSPORT_MTU` * (`RMW_UXRCE_MAX_HISTORY` - 12 B)) in the case of reliable messages.
42+
This MMS is (`UCLIENT_<XXX>_TRANSPORT_MTU` - 12 B) for best-effort messages and (`UCLIENT_<XXX>_TRANSPORT_MTU` * (`RMW_UXRCE_STREAM_HISTORY` - 12 B)) in the case of reliable messages.
4343

4444
The use of best-effort or reliable stream is handled by the `rmw_qos_reliability_policy_t` set in the `rmw_qos_profile_t` for a particular publisher or subscription.
4545
In the case of `RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT` best-effort streams are used and for `RMW_QOS_POLICY_RELIABILITY_RELIABLE` reliable streams are used instead.
4646

47+
More details about the micro-ROS middleware can be found in the [Micro XRCE-DDS documentation](https://micro-xrce-dds.docs.eprosima.com/).
48+
4749
### rmw-microxrcedds
4850

4951
rmw-microxrcedds uses static memory for allocating the resources associated with the `rcl` and `rclc` entities.

0 commit comments

Comments
 (0)