Getting Started

Installer

bun add @capgo/capacitor-device-info
bunx cap sync

Importer

import { DeviceInfo } from '@capgo/capacitor-device-info';

Lire une capture d'écran

const snapshot = await DeviceInfo.getInfo();

console.log(snapshot.cpu.cores);
console.log(snapshot.memory.usedPercent);
console.log(snapshot.storage.freeBytes);
console.log(snapshot.sensors?.pressureHpa);

cpu.usagePercent est basé sur delta. Le premier échantillon natif peut l'omettre ; appelez-le getInfo plus tard ou utilisez le suivi pour recevoir l'utilisation CPU remplie après le deuxième échantillon.

Mises à jour en flux

const handle = await DeviceInfo.addListener('deviceInfoUpdate', (sample) => {
  console.log(sample.sequence, sample.elapsedMs);
  console.log(sample.cpu.usagePercent);
  console.log(sample.sensors?.readings);
});

await DeviceInfo.startMonitoring({
  intervalMs: 1000,
  emitImmediately: true,
});

Arrêter les mises à jour

await DeviceInfo.stopMonitoring();
await handle.remove();

Vous pouvez également arrêter automatiquement :

await DeviceInfo.startMonitoring({
  intervalMs: 1000,
  durationMs: 60_000,
  sampleCount: 60,
});

Vérifiez l'état de suivi

const state = await DeviceInfo.isMonitoring();

if (state.monitoring) {
  console.log(state.samplesEmitted);
}

Champs de capteur à bord

const { sensors, cpu, gpu } = await DeviceInfo.getInfo();

console.log(cpu.temperatureCelsius);
console.log(gpu?.temperatureCelsius);
console.log(sensors?.batteryTemperatureCelsius);
console.log(sensors?.ambientTemperatureCelsius);
console.log(sensors?.relativeHumidityPercent);
console.log(sensors?.pressureHpa);
console.log(sensors?.illuminanceLux);
console.log(sensors?.proximityDistanceCm);
console.log(sensors?.availableSensors);

Les champs de capteur sont optionnels. Ils sont présents uniquement lorsque le dispositif, le système d'exploitation et le sandbox de l'application exposent ce métrique.

Remarques sur la plateforme

• iOS n'exige aucune autorisation pour les métriques exposées. Il signale la disponibilité des capteurs de mouvement CoreMotion, mais pas les températures CPU ou GPU brutes.
• Android n'exige aucune autorisation pour les métriques exposées. Les températures CPU et GPU sont des lectures de zone thermique de meilleure volonté.
• La prise en charge Web est de meilleure volonté et signale des tableaux de capteurs à bord vides car les navigateurs ne exposent pas les capteurs de dispositif natifs de manière cohérente.

Référence de type

DeviceInfoSnapshot

export interface DeviceInfoSnapshot {
  timestamp: number;
  platform: 'ios' | 'android' | 'web';
  cpu: CpuInfo;
  memory: MemoryInfo;
  storage: StorageInfo;
  gpu?: GpuInfo;
  thermalState?: ThermalState;
  lowPowerMode?: boolean;
  sensors?: OnboardSensorsInfo;
}

OnboardSensorsInfo

export interface OnboardSensorsInfo {
  availableSensors?: OnboardSensorDescriptor[];
  readings?: OnboardSensorReading[];
  batteryTemperatureCelsius?: number;
  ambientTemperatureCelsius?: number;
  relativeHumidityPercent?: number;
  pressureHpa?: number;
  illuminanceLux?: number;
  proximityDistanceCm?: number;
}

MonitoringOptions

export interface MonitoringOptions {
  intervalMs?: number;
  durationMs?: number;
  sampleCount?: number;
  emitImmediately?: boolean;
}

Source De Vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Continuez de Getting Started

Si vous utilisez Démarrage pour les diagnostics de dispositif, connectez-le à @capgo/capacitor-device-info pour une vue d'ensemble, Utiliser @capgo/capacitor-device-info pour un tutoriel, @capgo/capacitor-barometer pour des lectures de pression ciblées, et @capgo/capacitor-light-sensor pour des lectures de capteur de lumière ciblées.