@wandelbots/isaacsim-api

v2.28.0

Published

2 days ago

API Client to interact with the Wandelbots Isaac Sim Extension API

0High
0Medium
0Low

Wandelbots npm OpenAPI Omniservice NVIDIA Omniverse NVIDIA IsaacSim

Wandelbots NOVA x NVIDIA Isaac Sim™ Extension - TypeScript/JavaScript API Client

Note: This extension requires our Wandelbots USD Schema extension as well.

This TypeScript/JavaScript client provides programmatic access to the Wandelbots NOVA x NVIDIA Isaac Sim™ extension API, enabling seamless connection between NVIDIA Isaac Sim™ and Wandelbots NOVA.

Wandelbots NOVA simplifies the programming of industrial robots and cobots from multiple brands. Users can easily configure various robot models and teach them through an intuitive interface or by leveraging their preferred programming languages via APIs.

Start programming your favorite Robot brands like ABB, FANUC, KUKA, Universal Robots and Yaskawa in an Omniverse simulation scene, benefitting from its realistic behaviour.

Getting Started

The extension is designed to simplify the connection between robots running on Wandelbots NOVA and NVIDIA Omniverse™ (Isaac Sim™). To get started, follow these steps:

Create an account in the Wandelbots Developer Portal
Set up a Wandelbots NOVA instance, either in the cloud or using a physical setup. Check the documentation for more info.
Set up virtual robots and connect them to NVIDIA Isaac Sim™ using the Wandelbots NOVA extension.
Build your robotic cell environment using the Assets starter package provided via the Wandelbots Developer Portal downloads section.

Important: In order to use the extension of Wandelbots NOVA to NVIDIA Isaac Sim™ a subscription to Wandelbots NOVA is required. Visit wandelbots.com for more information how you can subscribe to Wandelbots NOVA.

Requirements

Node.js >= 16.0.0
TypeScript >= 4.0.0 (for TypeScript projects)

Installation

npm

npm install @wandelbots/isaacsim-api

yarn

yarn add @wandelbots/isaacsim-api

pnpm

pnpm add @wandelbots/isaacsim-api

Usage

TypeScript

import { Configuration, DefaultApi } from "@wandelbots/isaacsim-api";

const configuration = new Configuration({
  basePath: "https://your-nova-instance.com/api/v2",
  accessToken: "your-api-token",
});

const api = new DefaultApi(configuration);

// Example: Get motion group state
async function getMotionGroupState() {
  try {
    const response = await api.getMotionGroupState();
    console.log("Motion group state:", response.data);
  } catch (error) {
    console.error("Error:", error);
  }
}

JavaScript

const { Configuration, DefaultApi } = require("@wandelbots/isaacsim-api");

const configuration = new Configuration({
  basePath: "https://your-nova-instance.com/api/v2",
  accessToken: "your-api-token",
});

const api = new DefaultApi(configuration);

// Example: Get motion group state
async function getMotionGroupState() {
  try {
    const response = await api.getMotionGroupState();
    console.log("Motion group state:", response.data);
  } catch (error) {
    console.error("Error:", error);
  }
}

Documentation

License

This project is licensed under the Apache 2.0 License - see the LICENSE for details.