Class ServoClient

A gRPC-web client for the Servo component.

Hierarchy

ServoClient

Implements

Servo

Index

Constructors

Properties

client name options

Accessors

Methods

doCommand getPosition isMoving move stop

Constructors

constructor

new ServoClient(client: RobotClient, name: string, options?: Options): ServoClient
Parameters
- client: RobotClient
- name: string
- options: Options = {}
Returns ServoClient

Properties

`Private` client

client: ServoServiceClient

`Private` `Readonly` name

name: string

`Private` `Readonly` options

options: Options

Accessors

`Private` servoService

get servoService(): ServoServiceClient
Returns ServoServiceClient

Methods

doCommand

doCommand(command: StructType): Promise<StructType>
Send/Receive arbitrary commands to the resource.
Parameters
- command: StructType
  
  The command to execute.
Returns Promise<StructType>

Implementation of Servo.doCommand

getPosition

getPosition(extra?: StructType): Promise<number>
Return the current set angle of the servo in degrees.
Parameters
- extra: StructType = {}
Returns Promise<number>

Implementation of Servo.getPosition

isMoving

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

Returns Promise<boolean>

Implementation of Servo.isMoving

move

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

Implementation of Servo.move

stop

stop(extra?: {}): Promise<void>
Stop the servo.
Parameters
- extra: {} = {}
Returns Promise<void>

Implementation of Servo.stop

Generated using TypeDoc