https://github.com/robotwebtools/roslibjs
The Standard ROS JavaScript Library
https://github.com/robotwebtools/roslibjs
Last synced: 24 days ago
JSON representation
The Standard ROS JavaScript Library
- Host: GitHub
- URL: https://github.com/robotwebtools/roslibjs
- Owner: RobotWebTools
- License: other
- Created: 2013-03-15T00:50:47.000Z (about 12 years ago)
- Default Branch: develop
- Last Pushed: 2025-05-05T04:18:07.000Z (about 1 month ago)
- Last Synced: 2025-05-05T18:14:03.871Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://robotwebtools.github.io/roslibjs
- Size: 5.13 MB
- Stars: 733
- Watchers: 49
- Forks: 396
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# roslibjs
[](https://github.com/RobotWebTools/roslibjs/actions/workflows/main.yml)
## The Standard ROS JavaScript Library
For full documentation see the [ROS wiki](http://wiki.ros.org/roslibjs).
[JSDoc](https://robotwebtools.github.io/roslibjs) can be found on the Robot Web Tools website.
This project is released as part of the [Robot Web Tools](https://robotwebtools.github.io/) effort.
## Usage
Install roslibjs with any NPM-compatible package manager via, for example,
```bash
npm install roslib
```
~Pre-built files can be found in either [roslib.js](build/roslib.js) or [roslib.min.js](build/roslib.min.js).~
As we are updating to v2, we don't provide pre-built files anymore in the repo.
Alternatively, you can use the v1 release via the [JsDelivr](https://www.jsdelivr.com/) CDN: ([full](https://cdn.jsdelivr.net/npm/roslib@1/build/roslib.js)) | ([min](https://cdn.jsdelivr.net/npm/roslib@1/build/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:
```js
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:
```bash
netstat -a | grep 9090
```
## Dependencies
roslibjs has a number of dependencies. You will need to run:
```bash
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.