Ctrl+K
We have now released v0.3.0! Please use the latest version for the best experience.
Ctrl+K

Interacting with an articulation

Interacting with an articulation#

This tutorial shows how to interact with an articulated robot in the simulation. It is a continuation of the Interacting with a rigid object tutorial, where we learned how to interact with a rigid object. On top of setting the root state, we will see how to set the joint state and apply commands to the articulated robot.

The Code#

The tutorial corresponds to the run_articulation.py script in the orbit/source/standalone/tutorials/01_assets directory.

Code for run_articulation.py
  1# Copyright (c) 2022-2024, The ORBIT Project Developers.
  2# All rights reserved.
  3#
  4# SPDX-License-Identifier: BSD-3-Clause
  5
  6"""This script demonstrates how to spawn a cart-pole and interact with it.
  7
  8.. code-block:: bash
  9
 10    # Usage
 11    ./orbit.sh -p source/standalone/tutorials/01_assets/run_articulation.py
 12
 13"""
 14
 15"""Launch Isaac Sim Simulator first."""
 16
 17
 18import argparse
 19
 20from omni.isaac.orbit.app import AppLauncher
 21
 22# add argparse arguments
 23parser = argparse.ArgumentParser(description="Tutorial on spawning and interacting with an articulation.")
 24# append AppLauncher cli args
 25AppLauncher.add_app_launcher_args(parser)
 26# parse the arguments
 27args_cli = parser.parse_args()
 28
 29# launch omniverse app
 30app_launcher = AppLauncher(args_cli)
 31simulation_app = app_launcher.app
 32
 33"""Rest everything follows."""
 34
 35import torch
 36
 37import omni.isaac.core.utils.prims as prim_utils
 38
 39import omni.isaac.orbit.sim as sim_utils
 40from omni.isaac.orbit.assets import Articulation
 41from omni.isaac.orbit.sim import SimulationContext
 42
 43##
 44# Pre-defined configs
 45##
 46from omni.isaac.orbit_assets import CARTPOLE_CFG  # isort:skip
 47
 48
 49def design_scene() -> tuple[dict, list[list[float]]]:
 50    """Designs the scene."""
 51    # Ground-plane
 52    cfg = sim_utils.GroundPlaneCfg()
 53    cfg.func("/World/defaultGroundPlane", cfg)
 54    # Lights
 55    cfg = sim_utils.DomeLightCfg(intensity=3000.0, color=(0.75, 0.75, 0.75))
 56    cfg.func("/World/Light", cfg)
 57
 58    # Create separate groups called "Origin1", "Origin2", "Origin3"
 59    # Each group will have a robot in it
 60    origins = [[0.0, 0.0, 0.0], [-1.0, 0.0, 0.0]]
 61    # Origin 1
 62    prim_utils.create_prim("/World/Origin1", "Xform", translation=origins[0])
 63    # Origin 2
 64    prim_utils.create_prim("/World/Origin2", "Xform", translation=origins[1])
 65
 66    # Articulation
 67    cartpole_cfg = CARTPOLE_CFG.copy()
 68    cartpole_cfg.prim_path = "/World/Origin.*/Robot"
 69    cartpole = Articulation(cfg=cartpole_cfg)
 70
 71    # return the scene information
 72    scene_entities = {"cartpole": cartpole}
 73    return scene_entities, origins
 74
 75
 76def run_simulator(sim: sim_utils.SimulationContext, entities: dict[str, Articulation], origins: torch.Tensor):
 77    """Runs the simulation loop."""
 78    # Extract scene entities
 79    # note: we only do this here for readability. In general, it is better to access the entities directly from
 80    #   the dictionary. This dictionary is replaced by the InteractiveScene class in the next tutorial.
 81    robot = entities["cartpole"]
 82    # Define simulation stepping
 83    sim_dt = sim.get_physics_dt()
 84    count = 0
 85    # Simulation loop
 86    while simulation_app.is_running():
 87        # Reset
 88        if count % 500 == 0:
 89            # reset counter
 90            count = 0
 91            # reset the scene entities
 92            # root state
 93            # we offset the root state by the origin since the states are written in simulation world frame
 94            # if this is not done, then the robots will be spawned at the (0, 0, 0) of the simulation world
 95            root_state = robot.data.default_root_state.clone()
 96            root_state[:, :3] += origins
 97            robot.write_root_state_to_sim(root_state)
 98            # set joint positions with some noise
 99            joint_pos, joint_vel = robot.data.default_joint_pos.clone(), robot.data.default_joint_vel.clone()
100            joint_pos += torch.rand_like(joint_pos) * 0.1
101            robot.write_joint_state_to_sim(joint_pos, joint_vel)
102            # clear internal buffers
103            robot.reset()
104            print("[INFO]: Resetting robot state...")
105        # Apply random action
106        # -- generate random joint efforts
107        efforts = torch.randn_like(robot.data.joint_pos) * 5.0
108        # -- apply action to the robot
109        robot.set_joint_effort_target(efforts)
110        # -- write data to sim
111        robot.write_data_to_sim()
112        # Perform step
113        sim.step()
114        # Increment counter
115        count += 1
116        # Update buffers
117        robot.update(sim_dt)
118
119
120def main():
121    """Main function."""
122    # Load kit helper
123    sim_cfg = sim_utils.SimulationCfg(device="cpu", use_gpu_pipeline=False)
124    sim = SimulationContext(sim_cfg)
125    # Set main camera
126    sim.set_camera_view([2.5, 0.0, 4.0], [0.0, 0.0, 2.0])
127    # Design scene
128    scene_entities, scene_origins = design_scene()
129    scene_origins = torch.tensor(scene_origins, device=sim.device)
130    # Play the simulator
131    sim.reset()
132    # Now we are ready!
133    print("[INFO]: Setup complete...")
134    # Run the simulator
135    run_simulator(sim, scene_entities, scene_origins)
136
137
138if __name__ == "__main__":
139    # run the main function
140    main()
141    # close sim app
142    simulation_app.close()

The Code Explained#

Designing the scene#

Similar to the previous tutorial, we populate the scene with a ground plane and a distant light. Instead of spawning rigid objects, we now spawn a cart-pole articulation from its USD file. The cart-pole is a simple robot consisting of a cart and a pole attached to it. The cart is free to move along the x-axis, and the pole is free to rotate about the cart. The USD file for the cart-pole contains the robot’s geometry, joints, and other physical properties.

For the cart-pole, we use its pre-defined configuration object, which is an instance of the assets.ArticulationCfg class. This class contains information about the articulation’s spawning strategy, default initial state, actuator models for different joints, and other meta-information. A deeper-dive into how to create this configuration object is provided in the Writing an Asset Configuration tutorial.

As seen in the previous tutorial, we can spawn the articulation into the scene in a similar fashion by creating an instance of the assets.Articulation class by passing the configuration object to its constructor.

    # Create separate groups called "Origin1", "Origin2", "Origin3"
    # Each group will have a robot in it
    origins = [[0.0, 0.0, 0.0], [-1.0, 0.0, 0.0]]
    # Origin 1
    prim_utils.create_prim("/World/Origin1", "Xform", translation=origins[0])
    # Origin 2
    prim_utils.create_prim("/World/Origin2", "Xform", translation=origins[1])

    # Articulation
    cartpole_cfg = CARTPOLE_CFG.copy()
    cartpole_cfg.prim_path = "/World/Origin.*/Robot"
    cartpole = Articulation(cfg=cartpole_cfg)

Running the simulation loop#

Continuing from the previous tutorial, we reset the simulation at regular intervals, set commands to the articulation, step the simulation, and update the articulation’s internal buffers.

Resetting the simulation#

Similar to a rigid object, an articulation also has a root state. This state corresponds to the root body in the articulation tree. On top of the root state, an articulation also has joint states. These states correspond to the joint positions and velocities.

To reset the articulation, we first set the root state by calling the Articulation.write_root_state_to_sim() method. Similarly, we set the joint states by calling the Articulation.write_joint_state_to_sim() method. Finally, we call the Articulation.reset() method to reset any internal buffers and caches.

            # reset the scene entities
            # root state
            # we offset the root state by the origin since the states are written in simulation world frame
            # if this is not done, then the robots will be spawned at the (0, 0, 0) of the simulation world
            root_state = robot.data.default_root_state.clone()
            root_state[:, :3] += origins
            robot.write_root_state_to_sim(root_state)
            # set joint positions with some noise
            joint_pos, joint_vel = robot.data.default_joint_pos.clone(), robot.data.default_joint_vel.clone()
            joint_pos += torch.rand_like(joint_pos) * 0.1
            robot.write_joint_state_to_sim(joint_pos, joint_vel)
            # clear internal buffers
            robot.reset()

Stepping the simulation#

Applying commands to the articulation involves two steps:

  1. Setting the joint targets: This sets the desired joint position, velocity, or effort targets for the articulation.

  2. Writing the data to the simulation: Based on the articulation’s configuration, this step handles any actuation conversions and writes the converted values to the PhysX buffer.

In this tutorial, we control the articulation using joint effort commands. For this to work, we need to set the articulation’s stiffness and damping parameters to zero. This is done a-priori inside the cart-pole’s pre-defined configuration object.

At every step, we randomly sample joint efforts and set them to the articulation by calling the Articulation.set_joint_effort_target() method. After setting the targets, we call the Articulation.write_data_to_sim() method to write the data to the PhysX buffer. Finally, we step the simulation.

        # Apply random action
        # -- generate random joint efforts
        efforts = torch.randn_like(robot.data.joint_pos) * 5.0
        # -- apply action to the robot
        robot.set_joint_effort_target(efforts)
        # -- write data to sim
        robot.write_data_to_sim()

Updating the state#

Every articulation class contains a assets.ArticulationData object. This stores the state of the articulation. To update the state inside the buffer, we call the assets.Articulation.update() method.

        # Update buffers
        robot.update(sim_dt)

The Code Execution#

To run the code and see the results, let’s run the script from the terminal:

./orbit.sh -p source/standalone/tutorials/01_assets/run_articulation.py

This command should open a stage with a ground plane, lights, and two cart-poles that are moving around randomly. To stop the simulation, you can either close the window, press the STOP button in the UI, or press Ctrl+C in the terminal.

In this tutorial, we learned how to create and interact with a simple articulation. We saw how to set the state of an articulation (its root and joint state) and how to apply commands to it. We also saw how to update its buffers to read the latest state from the simulation.

In addition to this tutorial, we also provide a few other scripts that spawn different robots.These are included in the orbit/source/standalone/demos directory. You can run these scripts as:

# Spawn many different single-arm manipulators
./orbit.sh -p source/standalone/demos/arms.py

# Spawn many different quadrupeds
./orbit.sh -p source/standalone/demos/quadrupeds.py
Contents