@wandelbots/nova v1.1.0

@wandelbots/nova

The Wandelbots Nova client library provides convenient access to the Nova API from frontend JavaScript applications. In addition to typed methods for each API endpoint, we provide some higher level abstractions that manage the websocket connection state for tracking robot movement and handling jogging and Wandelscript program execution.

npm install @wandelbots/nova

Usage

The core of this package is the NovaClient, which represents a connection to a configured robot cell on a given Nova instance:

import { NovaClient } from "@wandelbots/nova"

const nova = new NovaClient({
  instanceUrl: "https://example.instance.wandelbots.io",
})

API calls

You can make calls to the REST API via nova.api, which contains a bunch of namespaced methods for each endpoint generated from the OpenAPI spec and documentation.

For example, to list the devices configured in your cell:

const devices = await nova.api.deviceConfig.listDevices()
// -> e.g. [{ type: 'controller', identifier: 'abb_irb1200_7', ... }, ...]

Documentation for the various API endpoints is available on your Nova instance at /api/v1/ui (public documentation site is in the works)

Contributing

To set up nova-js for development, first clone the repo and run:

npm install

Then you can run the tests against any Nova instance:

NOVA_INSTANCE_URL=https://example.instance.wandelbots.io npm run test