Class ServoClient

constructor

• new ServoClient(
      client: RobotClient,
      name: string,
      options?: Options,
  ): ServoClient

  Parameters

  • client: RobotClient
  • name: string
  • options: Options = {}

  Returns ServoClient

callOptions

Readonlyname

doCommand

• doCommand(command: Struct, callOptions?: CallOptions): Promise<JsonValue>

  Send/Receive arbitrary commands to the resource.

  Parameters

  • command: Struct

    The command to execute.
  • callOptions: CallOptions = ...

  Returns Promise<JsonValue>

  Example

  const result = await resource.doCommand({
    name: 'myCommand',
    args: { key: 'value' },
  });
  Copy

getPosition

• getPosition(extra?: {}, callOptions?: CallOptions): Promise<number>

  Return the current set angle of the servo in degrees.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<number>

  Example

  const servo = new VIAM.ServoClient(machine, 'my_servo');
  
  // Get the current set angle of the servo
  const pos = await servo.getPosition();
  Copy

  For more information, see Servo API.

isMoving

• isMoving(callOptions?: CallOptions): Promise<boolean>

  Return true if the servo is in motion.

  Parameters

  • callOptions: CallOptions = ...

  Returns Promise<boolean>

  Example

  const servo = new VIAM.ServoClient(machine, 'my_servo');
  
  const moving = await servo.isMoving();
  console.log('Moving:', moving);
  Copy

  For more information, see Servo API.

move

• move(angleDeg: number, extra?: {}, callOptions?: CallOptions): Promise<void>

  Move the servo by a given angle in degrees.

  Parameters

  • angleDeg: number
  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

  Example

  const servo = new VIAM.ServoClient(machine, 'my_servo');
  
  // Move the servo from its origin to the desired angle of 10 degrees
  await servo.move(10);
  
  // Move the servo from its origin to the desired angle of 90 degrees
  await servo.move(90);
  Copy

  For more information, see Servo API.

stop

• stop(extra?: {}, callOptions?: CallOptions): Promise<void>

  Stop the servo.

  Parameters

  • extra: {} = {}
  • callOptions: CallOptions = ...

  Returns Promise<void>

  Example

  const servo = new VIAM.ServoClient(machine, 'my_servo');
  
  // Move the servo from its origin to the desired angle of 10 degrees
  await servo.move(10);
  
  // Stop the servo. It is assumed that the servo stops moving immediately
  await servo.stop();
  Copy

  For more information, see Servo API.