Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@foxglove/roslibjs

RobotWebTools3.3kBSD-2-Clause0.0.3

Fork of roslib

ROS, ros, roslib, roslibjs, robot

readme

roslibjs

CI

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 Robot Web Tools 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.

changelog

Change Log

1.1.0 (2020/02/26 22:07 +00:00)

  • #354 Provide optional name to visual component. (#354) (@J-Rojas)
  • #351 Add cbor-raw compression (#351) (@janpaul123)
  • #348 WS 3.3.1 > 7.2.1 (#348) (@MatthijsBurgh)
  • #340 Fix TypeError: this.ros.ActionClient is not a function (#340) (@Rayman)
  • #323 fixed reconnect_on_close value in Topic (#323) (@biw)
  • #317 Add WebSocket in WebWorker transport (#317) (@mvollrath)

1.0.1 (2019/02/08 03:58 +00:00)

  • #318 Fix CBOR native array decoding offset (#318) (@mvollrath)

1.0.0 (2019/01/16 12:54 +00:00)

  • #310 Update and normalize EventEmitter2 dependency (#310) (@mvollrath)
  • #306 Don't allow unsupported compression types (#306) (@mvollrath)
  • #304 Prevent multiple web socket connections being opened. (#304) (@achim-k)
  • #303 Add support for CBOR encoding (#303) (@mvollrath)
  • #294 Feature/pose math methods (#294) (@achim-k)
  • #293 Add origin in urdf joint. (#293) (@achim-k)
  • #286 update shim files to use window instead of global (#286) (@jorgenfb)
  • #282 Add the type of service when executing 'call_service' (#282) (@minggangw)
  • #281 add example for advertise_service and fix documentation (#281) (@T045T)

0.20.0 (2017/12/21 14:58 +00:00)

  • #277 Use https instead of http in examples and links (#277) (@jihoonl)
  • #276 change CDN link to the static.robotwebtools url (#276) (@minshallj)
  • #275 Start 0.20.0-SNAPSHOT (#275) (@jihoonl)
  • #273 Fix link to wiki in README (#273) (@okalachev)
  • #271 Add deprecation warning in bower.json description (#271) (@jihoonl)

0.19.0 (2017/10/30 05:24 +00:00)

  • #264 mark version 0.19.0, create pull request based changelog (#264) (@jihoonl)
  • #267 Added an option to resubscribe/readvertise topic on close event, And add dispose() in ActionClient, TFClient (#267) (@Faibk)
  • #262 add parent and child in urdf joint (#262) (@jihoonl)
  • #259 Update travis configuration (#259) (@jihoonl)
  • #251 Fix authors.md link in readme (@BogdanAlexandru)
  • #250 Support status level messages (@sevenbitbyte)
  • #249 Updating the licence so SPDX stops complaining (#249) (@cjds)
  • #248 build 'get actionlib servers #247' (@viktorku)
  • #247 get actionlib servers (@marcoarruda)
  • #245 Fix getTopics bug (@NickZ)
  • #240 Upgrade to EventEmitter 2.2.0 (@dantwinkler, @jbcpollak, @eadlam)
  • #234 New services clients (@marcoarruda)
  • #233 fix wss:// support (@aqiank)
  • #235 Change demo link (@janga1997)
  • #231 Updated all dependency libraries to the latest (@dantwinkler)
  • #229 Include build directory in NPM package (#229) (@cberner)
  • #224 add RTCPeerConnection as Ros transport library (#224) (@aisch)
  • #220 An action listener for all actions not just for goals created by client (@FuzzAU)
  • #214 Socket io support (@jihoonl, @haas85, @rctoris)

0.18.0 (2016/02/17 21:33 +00:00)

  • #205 Added repubServiceName parameter to TFClient. (@BennyRe)
  • #208 Update roslibjs to advertise Services (@chris-smith)
  • #204 Make the travis script more robust (@Rayman)
  • #202 Add options to omit the feedback, status or result channel of ActionClient. (@commaster90)
  • #196 Test more node versions in travis (@Rayman)
  • #201 Added getServiceType function (@pantor)
  • #200 Fixed missing parameter in documentation of getTopicType (@pantor)
  • #197 Added serverName option to TFClient (@BennyRe)
  • #194 Remove canvas dependency (@Rayman)
  • #195 Fix JSDoc (@Rayman)

0.17.0 (2015/09/01 13:24 +00:00)

  • #191 canvas version bump to use for both node version 0.10.x and 0.12.x (@jihoonl)
  • #190 replace xmlshim with xmldom (@Rayman)

0.16.0 (2015/08/14 17:34 +00:00)

  • #185 BSON Decoding of Binary Objects (@DLu)
  • #182 Update for backward compatibility (@dwlee)
  • #181 Update failed callback when rosservice is called (@dwlee)

0.15.0 (2015/04/10 18:10 +00:00)

  • #178 removed sudo from npm install and provides a check instead (@rctoris)
  • #176 remove the (unused) DOMParser shim (@Rayman)

0.14.0 (2015/03/27 12:46 +00:00)

  • #171 Restore tf2_web_republisher service functionality (@T045T)
  • #174 Prevents smoothing of decompressed PNG images (@rctoris)

node-0.13.0 (2015/03/09 13:50 +00:00)

  • #168 0.13.0 Release (@rctoris, @jihoonl, @T045T, @gyeates, @megawac, @Rayman, @rbonghi, @DLu, @dwlee, @jakobs, @b1willaert, @psoetens)
  • #167 Indigo devel (@b1willaert, @psoetens)
  • #161 Add Urdf features: multiple visuals and material linking (@jakobs)
  • #159 Add function that find service and topic as specific type (@dwlee)
  • #164 Added queue_length parameter to topic subscription message (@smamessier)
  • #158 Index components of roslib (@megawac)
  • #156 URDF Joint (@DLu)

node-0.12.0 (2015/02/05 02:04 +00:00)

  • #154 version bump on package and bower.json (@jihoonl)

0.12.0 (2015/02/04 16:43 +00:00)

  • #153 0.12.0 Release (@rctoris, @jihoonl, @T045T, @gyeates, @megawac, @Rayman, @rbonghi)

0.11.0 (2015/02/04 14:12 +00:00)

  • #151 0.11.0 Release (@rctoris, @jihoonl, @T045T, @gyeates, @megawac, @Rayman, @rbonghi)
  • #149 Update CHANGELOG.md (@rbonghi)
  • #148 Make registering as a subscriber or publisher an option for the streaming API (@gyeates)
  • #147 Allow unsubbing a particular listner without affecting others (@megawac)
  • #142 Notification on param set/delete completion (+tests) (@megawac)
  • #146 local build of tf2_web_republisher in travis (@rctoris)
  • #145 Simplify TFClient and allow unsubscribe by key (@megawac)

0.10.0 (2014/12/08 14:13 +00:00)

  • #141 Update object-assign shim (@megawac)

node-0.9.1 (2014/11/17 02:57 +00:00)

  • #136 rename roslibjs to roslib to match up with npm (@jihoonl)
  • #139 Fix building (externally) with browserify (@megawac)
  • #138 test the visual Urdf elements (@T045T)
  • #137 Simplify URDF implementations (@gyeates)
  • #134 Passing callback to subscribe should be optional (@gyeates)
  • #132 Refactor URDF model parser (@gyeates)

node-0.9.0 (2014/11/07 01:00 +00:00)

  • #130 update package xml as a prep for npm publish (@jihoonl)
  • #129 Update (simplify) installation instructions in Contributing.md (@megawac)
  • #125 Make Browserify compatible (@megawac)
  • #124 Make Topic streams pipeable (@gyeates)
  • #123 Topic.toStream (@gyeates)
  • #112 Improve test coverage (@gyeates)
  • #121 Add unsubscribe and unadvertise events to topic (@megawac)
  • #120 [Attempt] Install all the cario dependencies during npm install (@gyeates)
  • #115 Fixed quaternion default value issue. Added Test (@asisbot)
  • #118 add 'time-grunt' and improve the Gruntfile.js a bit (@Rayman)
  • #117 [wip] TCP connections to ROS bridge for node (@gyeates)
  • #119 Improve test reliability (@T045T)
  • #116 Grunt configuration (@gyeates)
  • #110 Alternative syntax for create Topics, Services, Params, etc (@gyeates)
  • #109 ImproveTopic support for multiple subscriptions (@gyeates)
  • #104 Full nodejs support (@gyeates)
  • #106 Fix typos from #105 (@megawac)
  • #105 Unsubscribe from topic (@megawac)
  • #103 Remove testing of invalid XML (@megawac)
  • #101 Refactor Karma testing and build configuration (@gyeates)

0.9.0 (2014/09/09 13:57 +00:00)

  • #99 fix the fibonacci_server example instructions (@Rayman)
  • #98 Update EventEmitter2 to 0.4.14 (@Rayman)

0.8.3 (2014/08/13 01:13 +00:00)

  • #95 TFClient.unsubscribe(): remove leading slash from frame ID (@T045T)
  • #92 Add a basic urdf test and verify that #75 isn't an issue (@RobotWebTools)
  • #94 Add queue_size to topic publisher (@RobotWebTools)
  • #90 SimpleActionServer Functionality (@lindzey)
  • #88 Add simple indicator to examples showing the status of websocket connection (@T045T)

0.8.0 (2014/06/11 13:40 +00:00)

  • #87 General Cleanup (@rctoris)
  • #84 fix unadvertising Topics and add some instructions (@T045T)
  • #79 Fix TFClient by removing, rather than adding, a leading '/' character in TFClient.processFeedback() (@T045T)

r7 (2014/05/13 18:18 +00:00)

  • #77 Removed sending value as a message field in GetParam service call (@mitchellwills)

node-0.8.2 (2014/04/04 05:10 +00:00)

  • #64 Adds latch parameter to Topics for publishing (@adamantivm)
  • #65 Update UrdfBox.js (@rbonghi)
  • #60 add phantomjs install (@jihoonl)
  • #57 checks for leading slash in frame ID (@rctoris)
  • #52 Fixed ros service call parameter order. (@Pro)
  • #51 Added error message from rosbridge to failedCallback (@Pro)
  • #49 adding some functions to resolve ros message type (@garaemon)
  • #48 Add service fail callback (@OTL)
  • #47 param now contains delete function (@rctoris)
  • #45 allowing to retrieve the list of active node names in ROS (@barraq, @rctoris)

r6 (2013/05/07 16:17 +00:00)

  • #43 r6 release (@rctoris, @baalexander)
  • #42 r6 release (@rctoris)
  • #41 Sets unlimited number of event listeners. (@baalexander)
  • #38 Fixes missing ID counter in ROS so multiple service calls can be made (@rctoris, @baalexander)

r5 (2013/04/15 16:48 +00:00)

  • #33 readme link fixed and homepage link added to authors (@rctoris)
  • #32 r6-devel started (@rctoris)
  • #31 r5 release (@rctoris, @baalexander)
  • #30 Misc. Changes (@rctoris)
  • #29 Ports build system to Grunt. Adds linter and fixes found issues. (@baalexander)

r4 (2013/04/02 19:56 +00:00)

  • #27 robotwebtools CDN added (@rctoris)
  • #25 README updated with new info (@rctoris)
  • #24 Adds unit test infrastructure and Travis CI integration (@baalexander)
  • #23 bug fixed in URDF visual pose conversion (@rctoris)

r3 (2013/03/29 18:59 +00:00)

  • #22 URDF XML Parser Added (@rctoris)

r2 (2013/03/27 17:05 +00:00)

  • #20 Math and message revisions and revision 2 (@rctoris)

r1 (2013/03/22 16:12 +00:00)

  • #17 roslib improvements (@rctoris)
  • #15 Bug fixes (@rctoris)
  • #13 Uses prototype for declaring member functions (@baalexander)
  • #7 final first pass of roslib (@rctoris)
  • #6 actionlib JS converted to new ROSLIB (@rctoris)
  • #5 first pass of core module (@rctoris)
  • #1 current developement versions of existing libraries added (@rctoris)