Class DiscoveryClient

A gRPC-web client for a Vision service.

Implements

Constructors

Properties

callOptions: CallOptions = ...
client: PromiseClient<{
    methods: {
        discoverResources: {
            I: typeof DiscoverResourcesRequest;
            O: typeof DiscoverResourcesResponse;
            kind: Unary;
            name: "DiscoverResources";
        };
        doCommand: {
            I: typeof DoCommandRequest;
            O: typeof DoCommandResponse;
            kind: Unary;
            name: "DoCommand";
        };
    };
    typeName: "viam.service.discovery.v1.DiscoveryService";
}>

Type declaration

  • Readonly methods: {
        discoverResources: {
            I: typeof DiscoverResourcesRequest;
            O: typeof DiscoverResourcesResponse;
            kind: Unary;
            name: "DiscoverResources";
        };
        doCommand: {
            I: typeof DoCommandRequest;
            O: typeof DoCommandResponse;
            kind: Unary;
            name: "DoCommand";
        };
    }
    • Readonly discoverResources: {
          I: typeof DiscoverResourcesRequest;
          O: typeof DiscoverResourcesResponse;
          kind: Unary;
          name: "DiscoverResources";
      }

      DiscoverResources returns the list of all discovered viam resources connected to the viam-server machine.

      Generated

      from rpc viam.service.discovery.v1.DiscoveryService.DiscoverResources

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

      DoCommand sends/receives arbitrary commands

      Generated

      from rpc viam.service.discovery.v1.DiscoveryService.DoCommand

  • Readonly typeName: "viam.service.discovery.v1.DiscoveryService"
name: string
options: Options

Methods

  • Send/Receive arbitrary commands to the resource.

    Parameters

    • command: Struct

      The command to execute.

    • callOptions: CallOptions = ...

    Returns Promise<JsonValue>