Primeros pasos

Instalar

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

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

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando los siguientes comandos y sigue las instrucciones específicas para cada plataforma a continuación:

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importar

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

Inicio rápido

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

await CapacitorAccelerometer.startMeasurementUpdates();
await CapacitorAccelerometer.addListener('measurement', ({ x, y, z }) => {
  detectShake(x, y, z);
});

Ejemplo: permiso web

En la web, solicita acceso al movimiento mediante requestPermissions() antes de esperar muestras distintas de cero.

Errores comunes

• Ceros en la web: antes del primer evento de movimiento, getMeasurement() devuelve ceros.
• Detener el streaming: stopMeasurementUpdates() al salir de la pantalla.
• Unidades: usa la convención de ejes documentada del plugin para la lógica de tu juego.

Resumen de API

getMeasurement

Obtén la muestra de acelerómetro más reciente grabada por la capa nativa.

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

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

isAvailable

Comprueba 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

Comienza a transmitir actualizaciones del acelerómetro a la capa de JavaScript.

Llama addListener con el measurement evento para recibir las actualizaciones.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Detén el streaming de actualizaciones del acelerómetro iniciado con startMeasurementUpdates.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

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

En plataformas sin permisos explícitos, esto devuelve granted.

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

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

requestPermissions

Solicita permiso para acceder a los datos de movimiento si la plataforma lo permite.

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

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

Referencia de tipos

GetMeasurementResult

Alias para la medición más reciente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Resultado devuelto por isAvailable.

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

PermissionStatus

Información de permisos devuelta por checkPermissions y requestPermissions.

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 startMeasurementUpdates 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 del estado de permisos que incluye limited para plataformas que pueden limitar el acceso al movimiento.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Estados de permisos de plataforma compatibles con Capacitor.

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

Fuente de verdad

Esta página se genera a partir del src/definitions.ts. Vuelve a ejecutar el sync cuando el API público cambie en el upstream.

Continúa desde Primeros pasos

Si estás usando Primeros pasos para planificar el dashboard y las operaciones de API, conéctalo con Uso de @capgo/capacitor-accelerometer para la capacidad nativa en Uso de @capgo/capacitor-accelerometer, Resumen de API para el detalle de implementación en Resumen de API Overview, Introducción para el detalle de implementación en Introducción, Claves de API para el detalle de implementación en Claves de API, y Dispositivos para el detalle de implementación en Dispositivos.