README.md

Robot Recorder NPM

A wrapper for gkjohnson/urdf-loaders to visualize ROS animations recorded with ipa-jfh/robot_recorder.

Examples

>> 3D animation >> 3D animation >> 3D animation

Installation

npm i urdf-animation

Usage

Run the examples locally

1. Download repo and go inside one example

   git clone https://github.com/ipa-jfh/urdf-animation
   cd urdf-animation/docs/mobile_robot_turtlebot3

2. Now either

   1. Open the index.html (this uses the bundled js files)
   2. Install npm packages and open includes.html

      npm install

   3. Install npm packages and run the webpack-dev-server

      npm install
      sudo npm i [email protected] -g --save-dev
      sudo npm i [email protected] -g
      npm start  

Create new page for your animation:

1. Create a new npm package

   mkdir my_animation && cd my_animation
   npm init 

2. In package.json add dependecy to urdf-animation like in example
3. Install dependecies

   npm install

4. Copy the template folder`s contest inside your package. E.g.:

   cp ./node_modules/urdf-animation/template/* .

5. Add your URDF and recorded animation and reference it in the config.js file
6. Further configer the config.js file to e.g. adjust camera and lights

=> Now everthing is set-up and you can run the animation (See ### Run the examples locally)