roslibjs

The Standard ROS JavaScript Library

JSDoc can be found on the Robot Web Tools website.

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

Usage

Install roslibjs with any NPM-compatible package manager via, for example,

npm install roslib
Copy

Troubleshooting

1. Check that connection is established. You can listen to error and connection events to report them to console.

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

   Try running npm run examples for some complete examples!

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

   netstat -a | grep 9090
   Copy

Dependencies

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

npm install
Copy

Depending on your build environment.

Development

roslibjs tries to keep the development process simple by storing all relevant tasks as scripts in the package.json file. Some useful ones are as follows:

Building

npm run build
Copy

Testing

npm run test
Copy

Linting

npm run lint
Copy

License

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

Authors

See the contributors section of the package.json file for a full list of contributors.