Class ServoClient

Type declaration

• Readonly methods: {
      doCommand: {
          I: typeof DoCommandRequest;
          O: typeof DoCommandResponse;
          kind: Unary;
          name: "DoCommand";
      };
      getGeometries: {
          I: typeof GetGeometriesRequest;
          O: typeof GetGeometriesResponse;
          kind: Unary;
          name: "GetGeometries";
      };
      getPosition: {
          I: typeof servoApi.GetPositionRequest;
          O: typeof servoApi.GetPositionResponse;
          kind: Unary;
          name: "GetPosition";
      };
      isMoving: {
          I: typeof servoApi.IsMovingRequest;
          O: typeof servoApi.IsMovingResponse;
          kind: Unary;
          name: "IsMoving";
      };
      move: {
          I: typeof servoApi.MoveRequest;
          O: typeof servoApi.MoveResponse;
          kind: Unary;
          name: "Move";
      };
      stop: {
          I: typeof servoApi.StopRequest;
          O: typeof servoApi.StopResponse;
          kind: Unary;
          name: "Stop";
      };
  }

  • Readonly doCommand: {
        I: typeof DoCommandRequest;
        O: typeof DoCommandResponse;
        kind: Unary;
        name: "DoCommand";
    }

    DoCommand sends/receives arbitrary commands

    Generated

    from rpc viam.component.servo.v1.ServoService.DoCommand

    • Readonly I: typeof DoCommandRequest

    • Readonly O: typeof DoCommandResponse

    • Readonly kind: Unary

    • Readonly name: "DoCommand"

  • Readonly getGeometries: {
        I: typeof GetGeometriesRequest;
        O: typeof GetGeometriesResponse;
        kind: Unary;
        name: "GetGeometries";
    }

    GetGeometries returns the geometries of the component in their current configuration

    Generated

    from rpc viam.component.servo.v1.ServoService.GetGeometries

    • Readonly I: typeof GetGeometriesRequest

    • Readonly O: typeof GetGeometriesResponse

    • Readonly kind: Unary

    • Readonly name: "GetGeometries"

  • Readonly getPosition: {
        I: typeof servoApi.GetPositionRequest;
        O: typeof servoApi.GetPositionResponse;
        kind: Unary;
        name: "GetPosition";
    }

    GetPosition returns the current set angle (degrees) of the servo of the underlying robot.

    Generated

    from rpc viam.component.servo.v1.ServoService.GetPosition

    • Readonly I: typeof servoApi.GetPositionRequest

    • Readonly O: typeof servoApi.GetPositionResponse

    • Readonly kind: Unary

    • Readonly name: "GetPosition"

  • Readonly isMoving: {
        I: typeof servoApi.IsMovingRequest;
        O: typeof servoApi.IsMovingResponse;
        kind: Unary;
        name: "IsMoving";
    }

    IsMoving reports if a component is in motion

    Generated

    from rpc viam.component.servo.v1.ServoService.IsMoving

    • Readonly I: typeof servoApi.IsMovingRequest

    • Readonly O: typeof servoApi.IsMovingResponse

    • Readonly kind: Unary

    • Readonly name: "IsMoving"

  • Readonly move: {
        I: typeof servoApi.MoveRequest;
        O: typeof servoApi.MoveResponse;
        kind: Unary;
        name: "Move";
    }

    Move requests the servo of the underlying robot to move. This will block until done or a new operation cancels this one

    Generated

    from rpc viam.component.servo.v1.ServoService.Move

    • Readonly I: typeof servoApi.MoveRequest

    • Readonly O: typeof servoApi.MoveResponse

    • Readonly kind: Unary

    • Readonly name: "Move"

  • Readonly stop: {
        I: typeof servoApi.StopRequest;
        O: typeof servoApi.StopResponse;
        kind: Unary;
        name: "Stop";
    }

    Stop stops a robot's servo

    Generated

    from rpc viam.component.servo.v1.ServoService.Stop

    • Readonly I: typeof servoApi.StopRequest

    • Readonly O: typeof servoApi.StopResponse

    • Readonly kind: Unary

    • Readonly name: "Stop"

• Readonly typeName: "viam.component.servo.v1.ServoService"