API References

The official name is Dr.Dart-API, but Dr. is omitted for convenience.

Dart-API is provided to develop module of Dart-Platform and control robot from Dart-IDE. Dart-API can be found in the below site.

Dart-API : https://apis.drdart.io

What is API?

API stands for Application Programming Interface. API refers to an interface created to control the functions provided by the operating system (Windows, Linux) or programming language (Javascript, C++) so that application programs can use them.

Benefits of API

APIs facilitate integration, allowing these platforms and apps to connect in real time.
APIs enable applications and system components to connect on internal networks and the Internet.
Dart-API includes all of the APIs enclosed in the Project package file. When you want to call any APIs, write down the command in the Code Editor panel, and you don't need to add any API file.

You can find a list of APIs included in Dart-API on the below site:

Dart-API: dart-api | Dart-API Doc (drdart.io)

Or

The DART-API file on your project in Dart-IDE instructs you how to use each API. Please follow the flow to open the Dart-API file. Open your project ‣ Open your Module file ‣ Open Module package (xxx.xxx.xxx) ‣ Click to open "libs" file ‣ Choose "dart-api" file ‣ Select "dart-api.ts" file.

What is Dart-API?

Dart-API is a library containing all of the APIs. Each Dart-SDK version will have a corresponding Dart-API version. Call any API whenever you want to use it.
After creating a new project and selecting the SDK version, there will be a Dart-API in the library file that you can use in that SDK's version.

Document - Guides- SDK-Guide - SDK Tutorial - Dart-API

Information about Dart-API's permissions

The permission information file locates at the beginning of each API. It informs users about the type of permission the API belongs to @system/@user; below are specific examples for each permission type.

type of permission

description

1

@system

@system APIs are the APIs that can have a significant impact on the system and robot motion. They are unusable in the general module.

2

@user

@user APIs are the remaining APIs that include many functions.

Later, when you develop modules for Dart-Platform, you can only use those APIs with a note of @user.

e.g. @system

TYPESCRIPT

    /**
     * Request to get authority.
     *
     * @param force Whether get an authority by force.
     * @return Return true if system was requested successfully, otherwise false.
     *
     * @api-version 1
     * @system
     */
    requestAuthority(force: boolean): boolean

e.g. @user

TYPESCRIPT

    /**
     * Get Current Pose
     *
     * @param eSpaceType ROBOT_SPACE(Joint: 0, Task: 1)
     * @return Promise<SixNumArray> get current joint/task pose (J1, J2, J3, J4, J5, J6)/(X, Y, Z, A, B, C)
     *
     * @api-version 1
     * @user
     */
    getCurrentPos(eSpaceType: ROBOT_SPACE): Promise<SixNumArray>