Class InputControllerClient

Type declaration

• Readonly methods: {
      doCommand: {
          I: typeof DoCommandRequest;
          O: typeof DoCommandResponse;
          kind: Unary;
          name: "DoCommand";
      };
      getControls: {
          I: typeof GetControlsRequest;
          O: typeof GetControlsResponse;
          kind: Unary;
          name: "GetControls";
      };
      getEvents: {
          I: typeof GetEventsRequest;
          O: typeof GetEventsResponse;
          kind: Unary;
          name: "GetEvents";
      };
      getGeometries: {
          I: typeof GetGeometriesRequest;
          O: typeof GetGeometriesResponse;
          kind: Unary;
          name: "GetGeometries";
      };
      streamEvents: {
          I: typeof StreamEventsRequest;
          O: typeof StreamEventsResponse;
          kind: ServerStreaming;
          name: "StreamEvents";
      };
      triggerEvent: {
          I: typeof TriggerEventRequest;
          O: typeof TriggerEventResponse;
          kind: Unary;
          name: "TriggerEvent";
      };
  }

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

    DoCommand sends/receives arbitrary commands

    Generated

    from rpc viam.component.inputcontroller.v1.InputControllerService.DoCommand

    • Readonly I: typeof DoCommandRequest

    • Readonly O: typeof DoCommandResponse

    • Readonly kind: Unary

    • Readonly name: "DoCommand"

  • Readonly getControls: {
        I: typeof GetControlsRequest;
        O: typeof GetControlsResponse;
        kind: Unary;
        name: "GetControls";
    }

    GetControls returns a list of GetControls provided by the Controller

    Generated

    from rpc viam.component.inputcontroller.v1.InputControllerService.GetControls

    • Readonly I: typeof GetControlsRequest

    • Readonly O: typeof GetControlsResponse

    • Readonly kind: Unary

    • Readonly name: "GetControls"

  • Readonly getEvents: {
        I: typeof GetEventsRequest;
        O: typeof GetEventsResponse;
        kind: Unary;
        name: "GetEvents";
    }

    GetEvents returns a list of events representing the last event on each control of a give Input Controller

    Generated

    from rpc viam.component.inputcontroller.v1.InputControllerService.GetEvents

    • Readonly I: typeof GetEventsRequest

    • Readonly O: typeof GetEventsResponse

    • Readonly kind: Unary

    • Readonly name: "GetEvents"

  • 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.inputcontroller.v1.InputControllerService.GetGeometries

    • Readonly I: typeof GetGeometriesRequest

    • Readonly O: typeof GetGeometriesResponse

    • Readonly kind: Unary

    • Readonly name: "GetGeometries"

  • Readonly streamEvents: {
        I: typeof StreamEventsRequest;
        O: typeof StreamEventsResponse;
        kind: ServerStreaming;
        name: "StreamEvents";
    }

    StreamEvents starts a stream of InputControllerEvents for the given controls (buttons/axes) on a robot's input controller

    Generated

    from rpc viam.component.inputcontroller.v1.InputControllerService.StreamEvents

    • Readonly I: typeof StreamEventsRequest

    • Readonly O: typeof StreamEventsResponse

    • Readonly kind: ServerStreaming

    • Readonly name: "StreamEvents"

  • Readonly triggerEvent: {
        I: typeof TriggerEventRequest;
        O: typeof TriggerEventResponse;
        kind: Unary;
        name: "TriggerEvent";
    }

    TriggerEvent, where supported, injects an InputControllerEvent into an input controller to (virtually) generate events like button presses or axis movements

    Generated

    from rpc viam.component.inputcontroller.v1.InputControllerService.TriggerEvent

    • Readonly I: typeof TriggerEventRequest

    • Readonly O: typeof TriggerEventResponse

    • Readonly kind: Unary

    • Readonly name: "TriggerEvent"

• Readonly typeName: "viam.component.inputcontroller.v1.InputControllerService"