Class MovementSensorClient

A gRPC-web client for the MovementSensor component.

Implements

Constructors

Properties

callOptions: CallOptions = ...
client: PromiseClient<{
    methods: {
        doCommand: {
            I: typeof DoCommandRequest;
            O: typeof DoCommandResponse;
            kind: Unary;
            name: "DoCommand";
        };
        getAccuracy: {
            I: typeof GetAccuracyRequest;
            O: typeof GetAccuracyResponse;
            kind: Unary;
            name: "GetAccuracy";
        };
        getAngularVelocity: {
            I: typeof GetAngularVelocityRequest;
            O: typeof GetAngularVelocityResponse;
            kind: Unary;
            name: "GetAngularVelocity";
        };
        getCompassHeading: {
            I: typeof GetCompassHeadingRequest;
            O: typeof GetCompassHeadingResponse;
            kind: Unary;
            name: "GetCompassHeading";
        };
        getGeometries: {
            I: typeof GetGeometriesRequest;
            O: typeof GetGeometriesResponse;
            kind: Unary;
            name: "GetGeometries";
        };
        getLinearAcceleration: {
            I: typeof GetLinearAccelerationRequest;
            O: typeof GetLinearAccelerationResponse;
            kind: Unary;
            name: "GetLinearAcceleration";
        };
        getLinearVelocity: {
            I: typeof GetLinearVelocityRequest;
            O: typeof GetLinearVelocityResponse;
            kind: Unary;
            name: "GetLinearVelocity";
        };
        getOrientation: {
            I: typeof GetOrientationRequest;
            O: typeof GetOrientationResponse;
            kind: Unary;
            name: "GetOrientation";
        };
        getPosition: {
            I: typeof movementSensorApi.GetPositionRequest;
            O: typeof movementSensorApi.GetPositionResponse;
            kind: Unary;
            name: "GetPosition";
        };
        getProperties: {
            I: typeof movementSensorApi.GetPropertiesRequest;
            O: typeof movementSensorApi.GetPropertiesResponse;
            kind: Unary;
            name: "GetProperties";
        };
        getReadings: {
            I: typeof commonApi.GetReadingsRequest;
            O: typeof commonApi.GetReadingsResponse;
            kind: Unary;
            name: "GetReadings";
        };
    };
    typeName: "viam.component.movementsensor.v1.MovementSensorService";
}>

Type declaration

name: string
options: Options

Methods

  • Send/Receive arbitrary commands to the resource.

    Parameters

    • command: Struct

      The command to execute.

    • callOptions: CallOptions = ...

    Returns Promise<JsonValue>

  • Get the compass heading, which is a number from 0-359 where 0 is North, 90 is East, 180 is South, and 270 is West

    Parameters

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

      Returns Promise<number>

    • Return the readings of a sensor.

      Parameters

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

        Returns Promise<Record<string, JsonValue>>

      Generated using TypeDoc