Viam SDK
    Preparing search index...

    Variable SensorServiceConst

    SensorService: {
        methods: {
            doCommand: {
                I: typeof DoCommandRequest;
                kind: MethodKind.Unary;
                name: "DoCommand";
                O: typeof DoCommandResponse;
            };
            getGeometries: {
                I: typeof GetGeometriesRequest;
                kind: MethodKind.Unary;
                name: "GetGeometries";
                O: typeof GetGeometriesResponse;
            };
            getReadings: {
                I: typeof GetReadingsRequest;
                kind: MethodKind.Unary;
                name: "GetReadings";
                O: typeof GetReadingsResponse;
            };
            getStatus: {
                I: typeof commonApi.GetStatusRequest;
                kind: MethodKind.Unary;
                name: "GetStatus";
                O: typeof commonApi.GetStatusResponse;
            };
        };
        typeName: "viam.component.sensor.v1.SensorService";
    }

    SensorService services all generic sensors associated with a robot

    Type Declaration

    • Readonlymethods: {
          doCommand: {
              I: typeof DoCommandRequest;
              kind: MethodKind.Unary;
              name: "DoCommand";
              O: typeof DoCommandResponse;
          };
          getGeometries: {
              I: typeof GetGeometriesRequest;
              kind: MethodKind.Unary;
              name: "GetGeometries";
              O: typeof GetGeometriesResponse;
          };
          getReadings: {
              I: typeof GetReadingsRequest;
              kind: MethodKind.Unary;
              name: "GetReadings";
              O: typeof GetReadingsResponse;
          };
          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.component.sensor.v1.SensorService.DoCommand

      • ReadonlygetGeometries: {
            I: typeof GetGeometriesRequest;
            kind: MethodKind.Unary;
            name: "GetGeometries";
            O: typeof GetGeometriesResponse;
        }

        GetGeometries returns the geometries of the component in their current configuration

        from rpc viam.component.sensor.v1.SensorService.GetGeometries

      • ReadonlygetReadings: {
            I: typeof GetReadingsRequest;
            kind: MethodKind.Unary;
            name: "GetReadings";
            O: typeof GetReadingsResponse;
        }

        GetReadings returns the readings of a sensor of the underlying robot.

        from rpc viam.component.sensor.v1.SensorService.GetReadings

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

        GetStatus returns the status of the resource

        from rpc viam.component.sensor.v1.SensorService.GetStatus

    • ReadonlytypeName: "viam.component.sensor.v1.SensorService"

    from service viam.component.sensor.v1.SensorService