Basics

Robots run by the Management Console are executed using the Java API. The Java API allows you to send requests to a RoboServer that instructs it to execute a particular robot. This is a classic client-server setup in which Management Console acts as the client and RoboServer as the server.

By using the API, any Java based application can become a client to RoboServer. In addition to running robots that store data in a database, you can also have the robots return data directly back to the client application. Here are some examples:

The basic section of this guide will introduce the core classes, and how to use them for executing robots. We will also describe how to provide input to robots, and control their execution on RoboServer.

The Java API is a jar file, and it is located in /API/robosuite-java-api/lib/robosuite-api.jar inside the Kapow Katalyst installation folder, see important folders for details. All examples in this guide can also be found in /API/robosuite-java-api/examples. Located next to the Java API are 5 additional jar files which comprise the external dependencies of the API. Most basic API tasks such as executing robots can be done without using any of these 3rd party libraries, while some advanced features do require the usage of one or more of these 3rd party libraries. The examples in this guide will specify when such libraries are required.