Interface Base

Represents a physical base of a robot.

Hierarchy

Implemented by

Properties

doCommand

Methods

getProperties isMoving moveStraight setPower setVelocity spin stop

Properties

doCommand

doCommand: ((command: StructType) => Promise<StructType>)

Type declaration

Methods

getProperties

isMoving

  • Return true if the base is in motion.

    Parameters

    Returns Promise<boolean>

moveStraight

  • Move a base in a straight line by a given distance at a given speed. This method blocks until completed or cancelled.

    Parameters

    • distanceMm: number

      Distance to move, in millimeters.

    • mmPerSec: number

      Movement speed, in millimeters per second.

    • Optional extra: StructType

    Returns Promise<void>

setPower

setVelocity

spin

  • Spin a base by a given angle at a given angular speed. This method blocks until completed or cancelled.

    Parameters

    • angleDeg: number

      Degrees to spin.

    • degsPerSec: number

      Angular speed, in degrees per second.

    • Optional extra: StructType

    Returns Promise<void>

stop

  • Stop a base

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc