ProtoTwin API
    Preparing search index...

    Interface IRobotProgram

    Interface for robot programs that can be executed by the robot controller.

    interface IRobotProgram {
        get name(): string;
        execute(controller: RobotControllerComponent): Future<void>;
    }

    Implemented by

    Index

    Accessors

    Methods

    Accessors

    • get name(): string

      The unique name that identifies the program.

      Returns string

    Methods

    • Executes the program.

      Parameters

      Returns Future<void>

      The future that is resolved once the program has been executed.

      This function is called by the robot controller when it wants to execute the program.