Class NavigationClient

A gRPC-web client for a Navigation service.

Implements

  • Navigation

Constructors

Properties

callOptions: CallOptions = ...
client: PromiseClient<{
    methods: {
        addWaypoint: {
            I: typeof AddWaypointRequest;
            O: typeof AddWaypointResponse;
            kind: Unary;
            name: "AddWaypoint";
        };
        doCommand: {
            I: typeof DoCommandRequest;
            O: typeof DoCommandResponse;
            kind: Unary;
            name: "DoCommand";
        };
        getLocation: {
            I: typeof navigationApi.GetLocationRequest;
            O: typeof navigationApi.GetLocationResponse;
            kind: Unary;
            name: "GetLocation";
        };
        getMode: {
            I: typeof GetModeRequest;
            O: typeof GetModeResponse;
            kind: Unary;
            name: "GetMode";
        };
        getObstacles: {
            I: typeof GetObstaclesRequest;
            O: typeof GetObstaclesResponse;
            kind: Unary;
            name: "GetObstacles";
        };
        getPaths: {
            I: typeof GetPathsRequest;
            O: typeof GetPathsResponse;
            kind: Unary;
            name: "GetPaths";
        };
        getProperties: {
            I: typeof navigationApi.GetPropertiesRequest;
            O: typeof navigationApi.GetPropertiesResponse;
            kind: Unary;
            name: "GetProperties";
        };
        getWaypoints: {
            I: typeof GetWaypointsRequest;
            O: typeof GetWaypointsResponse;
            kind: Unary;
            name: "GetWaypoints";
        };
        removeWaypoint: {
            I: typeof RemoveWaypointRequest;
            O: typeof RemoveWaypointResponse;
            kind: Unary;
            name: "RemoveWaypoint";
        };
        setMode: {
            I: typeof SetModeRequest;
            O: typeof SetModeResponse;
            kind: Unary;
            name: "SetMode";
        };
    };
    typeName: "viam.service.navigation.v1.NavigationService";
}>

Type declaration

name: string
options: Options

Methods

  • Parameters

    Returns Promise<void>

  • Parameters

    • command: Struct
    • callOptions: CallOptions = ...

    Returns Promise<JsonValue>

  • Parameters

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

      Returns Promise<navigationApi.Mode>

    • Parameters

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

        Returns Promise<commonApi.GeoGeometry[]>

      • Parameters

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

          Returns Promise<navigationApi.Path[]>

        • Parameters

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

            Returns Promise<void>

          • Parameters

            Returns Promise<void>