Viam SDK
    Preparing search index...

    Variable GenericServiceConst

    GenericService: {
        methods: {
            doCommand: {
                I: typeof DoCommandRequest;
                kind: MethodKind.Unary;
                name: "DoCommand";
                O: typeof DoCommandResponse;
            };
            getStatus: {
                I: typeof commonApi.GetStatusRequest;
                kind: MethodKind.Unary;
                name: "GetStatus";
                O: typeof commonApi.GetStatusResponse;
            };
        };
        typeName: "viam.service.generic.v1.GenericService";
    }

    GenericService services all generic services associated with a robot

    Type Declaration

    • Readonlymethods: {
          doCommand: {
              I: typeof DoCommandRequest;
              kind: MethodKind.Unary;
              name: "DoCommand";
              O: typeof DoCommandResponse;
          };
          getStatus: {
              I: typeof commonApi.GetStatusRequest;
              kind: MethodKind.Unary;
              name: "GetStatus";
              O: typeof commonApi.GetStatusResponse;
          };
      }
      • ReadonlydoCommand: {
            I: typeof DoCommandRequest;
            kind: MethodKind.Unary;
            name: "DoCommand";
            O: typeof DoCommandResponse;
        }

        DoCommand sends/receives arbitrary commands

        from rpc viam.service.generic.v1.GenericService.DoCommand

      • ReadonlygetStatus: {
            I: typeof commonApi.GetStatusRequest;
            kind: MethodKind.Unary;
            name: "GetStatus";
            O: typeof commonApi.GetStatusResponse;
        }

        GetStatus returns the status of the resource

        from rpc viam.service.generic.v1.GenericService.GetStatus

    • ReadonlytypeName: "viam.service.generic.v1.GenericService"

    from service viam.service.generic.v1.GenericService

    Settings

    Member Visibility