Guida rapida

Installazione

Puoi usare il nostro Setup assistito dall'AI per installare il plugin. Aggiungi le skill Capgo al tuo tool AI con il comando seguente:

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

Poi usa questo prompt:

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

Se preferisci il Setup manuale, installa il plugin eseguendo i comandi seguenti e segui le istruzioni specifiche per piattaforma qui sotto:

bun add @capgo/capacitor-accelerometer
bunx cap sync

Importa

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

Avvio rapido

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

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

Esempio: permesso web

Sul web, richiedi l'accesso al movimento tramite requestPermissions() prima di aspettarti campioni diversi da zero.

Errori comuni

• Web zero: prima del primo evento di movimento, getMeasurement() restituisce zeri.
• Interrompi lo streaming: stopMeasurementUpdates() uscendo dalla schermata.
• Unità: usa la convenzione degli assi documentata nel plugin per la matematica del tuo gioco.

API Panoramica

getMeasurement

Ottieni l'ultimo campione dell'accelerometro registrato dal layer nativo.

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

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

isAvailable

Verifica se il dispositivo in uso dispone di un accelerometro.

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

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

startMeasurementUpdates

Avvia lo streaming degli aggiornamenti dell'accelerometro verso il layer JavaScript.

Esegui addListener con il measurement evento per ricevere gli aggiornamenti.

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

await CapacitorAccelerometer.startMeasurementUpdates();

stopMeasurementUpdates

Stop streaming accelerometer updates started via startMeasurementUpdates.

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

await CapacitorAccelerometer.stopMeasurementUpdates();

checkPermissions

Restituisce lo stato attuale dei permessi per l'accesso ai dati di movimento.

Sulle piattaforme senza permessi espliciti, questo equivale a granted.

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

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

requestPermissions

Richiede il permesso di accedere ai dati di movimento, se la piattaforma lo supporta.

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

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

Riferimento ai tipi

GetMeasurementResult

Alias per la misurazione più recente.

export type GetMeasurementResult = Measurement;

IsAvailableResult

Risultato restituito da isAvailable.

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

PermissionStatus

Informazioni sui permessi restituite da checkPermissions e requestPermissions.

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

MeasurementEvent

Payload dell'evento emesso quando startMeasurementUpdates è attivo.

export type MeasurementEvent = Measurement;

Measurement

I valori di accelerazione sugli assi x, y e z riportati dai sensori di movimento 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

Unione degli stati di permesso, tra cui: limited per le piattaforme che possono limitare l'accesso al movimento.

export type AccelerometerPermissionState = PermissionState | 'limited';

PermissionState

Stati dei permessi di piattaforma supportati da Capacitor.

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

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Guida rapida per pianificare dashboard e operazioni API, collegalo a Utilizzo di @capgo/capacitor-accelerometer per la funzionalità nativa con @capgo/capacitor-accelerometer, API Panoramica per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli implementativi nell'Introduzione, Chiavi API per i dettagli implementativi in API Keys, e Dispositivi per i dettagli implementativi in Dispositivi.