Interface Servo

Represents a physical servo.

interface Servo {
    doCommand(command): Promise<JsonValue>;
    getPosition(extra?): Promise<number>;
    isMoving(): Promise<boolean>;
    move(angleDeg, extra?): Promise<void>;
    stop(extra?): Promise<void>;
}

Hierarchy (view full)

Resource
- Servo

Implemented by

ServoClient

Index

Methods

doCommand getPosition isMoving move stop

Methods

doCommand

doCommand(command): Promise<JsonValue>
Send/Receive arbitrary commands to the resource.
Parameters
- command: Struct
  The command to execute.
Returns Promise<JsonValue>
Inherited from Resource.doCommand

getPosition

getPosition(extra?): Promise<number>
Return the current set angle of the servo in degrees.
Parameters
- Optional extra: Struct
Returns Promise<number>

isMoving

isMoving(): Promise<boolean>
Return true if the servo is in motion.

Returns Promise<boolean>

move

move(angleDeg, extra?): Promise<void>
Move the servo by a given angle in degrees.
Parameters
- angleDeg: number
- Optional extra: Struct
Returns Promise<void>

stop

stop(extra?): Promise<void>
Stop the servo.
Parameters
- Optional extra: Struct
Returns Promise<void>

Generated using TypeDoc