roslib/README.md

The standard ROS Javascript Library

roslibjs [![Build Status](https://api.travis-ci.org/RobotWebTools/roslibjs.png)](https://travis-ci.org/RobotWebTools/roslibjs)
========

#### The Standard ROS JavaScript Library
For full documentation, see [the ROS wiki](http://wiki.ros.org/roslibjs) or check out some [working demos](http://robotwebtools.org/demos.html).

[JSDoc](http://robotwebtools.org/jsdoc/roslibjs/current/) can be found on the Robot Web Tools website.

This project is released as part of the [Robot Web Tools](http://robotwebtools.org/) effort.

### Usage
Pre-built files can be found in either [roslib.js](build/roslib.js) or [roslib.min.js](build/roslib.min.js).

Alternatively, you can use the current release via the Robot Web Tools CDN: ([full](https://static.robotwebtools.org/roslibjs/current/roslib.js)) | ([min](https://static.robotwebtools.org/roslibjs/current/roslib.min.js))

### 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!'); });

1. 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](CONTRIBUTING.md) for details on building.

### License
roslibjs is released with a BSD license. For full terms and conditions, see the [LICENSE](LICENSE) file.

### Authors
See the [AUTHORS.md](AUTHORS.md) file for a full list of contributors.