Documentation

A small API you can actually run.

The included ArmAPIDemo library manages an isolated illustration state in memory. It exposes named poses, gripper state, a revision counter, and subscriptions. It does not make network requests, run a planner, or connect to equipment.

The homepage and robot playground use this library to update an SVG illustration. Animation belongs to the page, not to the state library. A method return means the local state has changed; it is not a measurement or confirmation of physical motion.

Load the local script.

Include the library before your own JavaScript, then create a model. All assets below are included with the site. No package installation, account, or API key is required.

<script src="/assets/js/armapi-demo.js"></script>
<script>
  const arm = ArmAPIDemo.create();
  console.log(arm.getState());
  arm.moveTo('reach');
  arm.grip(true);
</script>

Open the browser developer console to inspect the logged state. Each call to create() returns a separate model. It does not connect to or control the illustration already on this page unless your code explicitly renders that model.

Know the starting state.

{
  mode: 'local-demo',
  pose: 'home',
  joints: { shoulder: -20, elbow: 86, wrist: 68 },
  gripper: 'open',
  revision: 0
}

The angles are local drawing values in degrees. They are not a physical robot definition. The values intentionally differ from the coordinate and unit conventions you would specify for a real integration.

Two demos, two different interfaces.

The robot illustration uses the public local state API. The virtual claw uses page-level controls for aiming, dropping, and resetting a practice round. The claw is not another ArmAPIDemo model, and the robot library does not expose a claw or reward method.

The playground explains both interfaces. The cabinet has deterministic capture regions and no persistent results, real prizes, purchases, or inventory.

Choose your next step.

Use the API reference for method parameters, return values, and errors. The code examples show subscriptions, validation handling, and independent models. For conceptual architecture beyond this library, start with Robot Arm API.

Download the local JavaScript library. Version 1.0.0 is included in this site package.