Getting Started

Instalar

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Luego utilice el siguiente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-accelerometer` plugin in my project.

Si prefiere la configuración manual, instale el plugin ejecutando los siguientes comandos y siga las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importar

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

API Resumen

getMeasurement

Obtenga la muestra de acelerómetro más reciente que se registró por la capa nativa.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

const result = await CapacitorAccelerometer.getMeasurement();
console.log(result);

isAvailable

Verifique si el dispositivo actual incluye un sensor de acelerómetro.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

const result = await CapacitorAccelerometer.isAvailable();
console.log(result);

startMeasurementUpdates

Comience a transmitir actualizaciones de acelerómetro a la capa de JavaScript.

Llame con el measurement evento para recibir las actualizaciones.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Stop streaming accelerometer updates started via .

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Devuelve el estado actual de permiso para acceder a datos de movimiento.

En plataformas sin permisos explícitos, esto resuelve a granted.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

const result = await CapacitorAccelerometer.checkPermissions();
console.log(result);

requestPermissions

Solicita permiso para acceder a datos de movimiento si está soportado por la plataforma.

import { CapacitorAccelerometer } from '@capgo/capacitor-accelerometer';

const result = await CapacitorAccelerometer.requestPermissions();
console.log(result);

Tipo de Referencia

GetMeasurementResult

Alias para la medición más reciente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Resultado devuelto por .

export interface IsAvailableResult {
  /**
   * Whether an accelerometer sensor is available on the device.
   *
   * @since 1.0.0
   */
  isAvailable: boolean;
}

PermissionStatus

Información de permiso devuelta por y .

export interface PermissionStatus {
  /**
   * The permission state for accessing motion data on the current platform.
   *
   * @since 1.0.0
   */
  accelerometer: AccelerometerPermissionState;
}

MeasurementEvent

Payload del evento emitido cuando está activo.

export type MeasurementEvent = Measurement;

Measurement

Los valores de aceleración en los ejes x, y y z reportados por los sensores de movimiento del dispositivo.

export interface Measurement {
  /**
   * The acceleration on the x-axis in G's.
   *
   * @since 1.0.0
   */
  x: number;

  /**
   * The acceleration on the y-axis in G's.
   *
   * @since 1.0.0
   */
  y: number;

  /**
   * The acceleration on the z-axis in G's.
   *
   * @since 1.0.0
   */
  z: number;
}

AccelerometerPermissionState

Unión de estado de permiso incluyendo limited para plataformas que pueden ralentizar el acceso a la movimiento.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Estados de permiso de plataforma soportados por Capacitor.

export type PermissionState = 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';

Fuente de Verdad

Esta página se genera a partir del plugin’s src/definitions.tsRe-ejecuta la sincronización cuando cambia el API público en la fuente.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola y las operaciones de API, conecta con Usando @capgo/capacitor-acelerómetro para la capacidad nativa en Usando @capgo/capacitor-acelerómetro, API Overview para el detalle de implementación en API Overview, Introducción para los detalles de implementación en Introducción, API Claves para los detalles de implementación en API Claves, y Dispositivos Para los detalles de implementación en dispositivos.