personalrobotics / roslibjs

PRL copy of the Standard ROS JavaScript Library to enable ROS2 actions

NOTE (April 2023): This PRL fork of roslibjs, and the corresponding PRL fork of rosbridge_suite, is to account for the fact that the official rosbridge_suite and official roslibjs do not currently work with ROS2 actions. This is a PR to address that, and it formed the basis for these two PRL forks. If ROS2 action support is added to both rosbridge_suite and roslibjs, then these two PRL forks can be removed (and any code that uses them, like the PRL feeding_web_interface, updated).

roslibjs

The Standard ROS JavaScript Library

For full documentation, see the ROS wiki or check out some working demos.

JSDoc can be found on the Robot Web Tools website.

This project is released as part of the Robot Web Tools effort.

Usage

Pre-built files can be found in either roslib.js or roslib.min.js.

Alternatively, you can use the current release via the JsDelivr CDN: (full) | (min)

Troubleshooting

1. Check that connection is established. You can listen to error and connection events to report them to console. See examples/simple.html for a complete example:

   ros.on('error', function(error) { console.log( error ); });
   ros.on('connection', function() { console.log('Connection made!'); });

2. Check that you have the websocket server is running on port 9090. Something like this should do:

   netstat -a | grep 9090

Dependencies

roslibjs has a number of dependencies. You will need to run:

npm install

Depending on your build environment.

Build

Checkout CONTRIBUTING.md for details on building.

License

roslibjs is released with a BSD license. For full terms and conditions, see the LICENSE file.

Authors

See the AUTHORS.md file for a full list of contributors.