You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/tutorials/programming_rcl_rclc/parameters/parameters.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ Note: micro-ROS parameter server is only supported on ROS2 galactic distribution
45
45
46
46
- Memory and executor requirements:
47
47
The variable `RCLC_PARAMETER_EXECUTOR_HANDLES_NUMBER` defines the RCLC executor handles required for a parameter server.
48
-
This needs to be taken into account when initializing the executor and on the colcon memory configuration of the `rmw-microxredds` package, which will need atleast 4 services and 1 publisher:
48
+
This needs to be taken into account when initializing the executor and on the colcon memory configuration of the `rmw-microxredds` package, which will need at least 4 services and 1 publisher:
49
49
50
50
```C
51
51
# colcon.meta example with minimum memory requirements to use parameter server
@@ -72,7 +72,7 @@ Note: micro-ROS parameter server is only supported on ROS2 galactic distribution
72
72
73
73
## <aname="parameters_callback"/>Callback
74
74
75
-
When adding the paramater server to the executor, a callback can be configured.
75
+
When adding the parameter server to the executor, a callback can be configured.
76
76
This callback will be executed after a parameter value is modified.
77
77
78
78
A pointer to the changed parameter is passed as first and only argument. Example:
Copy file name to clipboardExpand all lines: _docs/tutorials/programming_rcl_rclc/pub_sub/pub_sub.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,7 +73,7 @@ Starting from a code where RCL is initialized and a micro-ROS node is created, t
73
73
}
74
74
```
75
75
76
-
For a detail on the avaliable QoS options and the advantages and disadvantages between reliable and best effort modes, check the [QoS tutorial](../qos/).
76
+
For a detail on the available QoS options and the advantages and disadvantages between reliable and best effort modes, check the [QoS tutorial](../qos/).
77
77
78
78
## <a name="pub_publish"/>Publish a message
79
79
@@ -114,7 +114,7 @@ The suscriptor initialization is almost identical to the publisher one:
@@ -164,11 +164,11 @@ The suscriptor initialization is almost identical to the publisher one:
164
164
}
165
165
```
166
166
167
-
For a detail on the avaliable QoS options and the advantages and disadvantages between reliable and best effort modes, check the [QoS tutorial](../qos/).
167
+
For a detail on the available QoS options and the advantages and disadvantages between reliable and best effort modes, check the [QoS tutorial](../qos/).
168
168
169
169
### <a name="sub_callback"/>Callbacks
170
170
The executor is responsible to call the configured callback when a message is published.
171
-
The function will have the message as its only argument, containing the values sended by the publisher:
171
+
The function will have the message as its only argument, containing the values sent by the publisher:
Reliable communication implies a confirmation for each message sended. This mode can detect errors in the communication process at the cost of increasing the message latency and the resources usage.
11
+
Reliable communication implies a confirmation for each message sent. This mode can detect errors in the communication process at the cost of increasing the message latency and the resources usage.
12
12
13
-
This message confirmation proccess can increase blocking time on `rcl_publish` or executor spin calls as reliable publishers, services and clients will wait for acknowledgement for each sended message. `rmw-microxrcedds` offers an API to individually configure the acknowledgement timeout on them:
13
+
This message confirmation proccess can increase blocking time on `rcl_publish` or executor spin calls as reliable publishers, services and clients will wait for acknowledgement for each sent message. `rmw-microxrcedds` offers an API to individually configure the acknowledgement timeout on them:
14
14
15
15
```C
16
16
// Confirmation timeout in milliseconds
@@ -35,7 +35,7 @@ This message confirmation proccess can increase blocking time on `rcl_publish` o
35
35
36
36
## <a name="qos"/>Best Effort
37
37
38
-
In best effort mode no acknowledgement is needed, the messages sended are expected to be received. This method improves publication throughput and reduces resources usage but is vulnerable to communication errors.
38
+
In best effort mode no acknowledgement is needed, the messages sent are expected to be received. This method improves publication throughput and reduces resources usage but is vulnerable to communication errors.
Copy file name to clipboardExpand all lines: _docs/tutorials/programming_rcl_rclc/service/services.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -72,12 +72,12 @@ Starting from a code where RCL is initialized and a micro-ROS node is created, t
72
72
}
73
73
```
74
74
75
-
For a detail on the avaliable QoS options and the advantages and disadvantages between reliable and best effort modes, check the [QoS tutorial](../qos/).
75
+
For a detail on the available QoS options and the advantages and disadvantages between reliable and best effort modes, check the [QoS tutorial](../qos/).
76
76
77
77
### <a name="server_callback"/>Callback
78
78
79
79
Once a request arrives, the executor will call the configured callback with the request and response messages as arguments.
80
-
The request message contains the values sended by the client, the response_msg should be modified here as it will be delivered after the callback returns.
80
+
The request message contains the values sent by the client, the response_msg should be modified here as it will be delivered after the callback returns.
81
81
82
82
Using `AddTwoInts.srv` type definition as an example:
83
83
@@ -88,7 +88,7 @@ int64 b
88
88
int64 sum
89
89
```
90
90
91
-
The client request message will contain two integers `a` and `b`, and expectes the `sum` of them as a response:
91
+
The client request message will contain two integers `a` and `b`, and expects the `sum` of them as a response:
Note that it is neccesary to cast each message to the expected type
105
+
Note that it is necessary to cast each message to the expected type
106
106
107
107
Once the service and the executor are initialized, the service callback must be added to the executor in order to process incoming requests once the executor is spinning:
108
108
@@ -190,9 +190,9 @@ The service client initialization is almost identical to the server one:
190
190
191
191
### <a name="client_callback"/>Callback
192
192
The executor is responsible to call the configured callback when the service response arrives.
193
-
The function will have the response message as its only argument, containing the values sended by the server.
193
+
The function will have the response message as its only argument, containing the values sent by the server.
194
194
195
-
It is neccesary to cast the response message to the expected type. Example:
195
+
It is necessary to cast the response message to the expected type. Example:
0 commit comments