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
Updates documentation/tutorials to align with current rclnodejs tooling, API signatures, and supported ROS/Node.js versions.
**Changes:**
- Update Type Description Service tutorial to reflect ROS 2 Jazzy+ availability and matching version checks.
- Fix content-filtering tutorial example to store the subscription on the class instance for later updates.
- Refresh docs for message generation command, lifecycle context usage, and build prerequisites (Node.js + Python on Windows).
Fix: #1415
Copy file name to clipboardExpand all lines: docs/BUILDING.md
+3-7Lines changed: 3 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
1.Install ROS 2 from binary package.
6
6
7
-
ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from [ROS 2 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Ubuntu-Install-Debians.html)/[Windows](https://docs.ros.org/en/rolling/Installation/Windows-Install-Binary.html) to setup the environment (If you want to run your apps on a stable release of ROS 2, e.g. crystal-clemmys, please see the section `Running on Stable Release of ROS 2).
7
+
ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from [ROS 2 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Ubuntu-Install-Debians.html)/[Windows](https://docs.ros.org/en/rolling/Installation/Windows-Install-Binary.html) to setup the environment. Supported ROS 2 distributions: Rolling, Kilted, Jazzy, and Humble.
8
8
9
9
2.Build ROS 2 from scratch.
10
10
@@ -13,7 +13,7 @@ Alternatively, you can build ROS 2 from scratch. Please select the platform you
13
13
### Install `Node.js`
14
14
15
15
**Notice:**
16
-
`rclnodejs`should only be used with node versions between 10.23.1 - 19.x. The lowest LTS Node.js we used to verify the unit tests is `10.23.1`.
16
+
`rclnodejs`requires Node.js version >= 16.13.0.
17
17
18
18
I install Nodejs from either:
19
19
@@ -56,11 +56,7 @@ This `Node.js` module is built by [node-gyp](https://www.npmjs.com/package/node-
56
56
npm install
57
57
```
58
58
59
-
**Windows-specific**: make sure Python 2.x interpreter is first searched in your `PATH` before running the command. You can change it temporarily by:
60
-
61
-
```bash
62
-
set PATH=<path\to\python 2.x>;%PATH%
63
-
```
59
+
**Windows-specific**: make sure a Python 3.x interpreter is available in your `PATH` before running the command, as required by [node-gyp](https://github.com/nodejs/node-gyp#on-windows).
Copy file name to clipboardExpand all lines: docs/FAQ.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
@@ -20,10 +20,10 @@ ros2 pkg list
20
20
21
21
If the package containing your target message is not listed then install it.
22
22
23
-
Next, inspect the generated JavaScript message files by viewing the `./node_modules/rclnodejs/generated/` folder of your project for your target message. If you are unable to locate the message file then use the `generate-messages` script:
23
+
Next, inspect the generated JavaScript message files by viewing the `./node_modules/rclnodejs/generated/` folder of your project for your target message. If you are unable to locate the message file then use the `generate-ros-messages` script:
0 commit comments