Getting Started

Compatibilità

@capgo/capacitor-device-info richiede Capacitor 8 o successivo (@capacitor/core >=8.0.0).

Installare

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo competenze al tuo strumento AI utilizzando il seguente comando:

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

Poi utilizza il seguente prompt:

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

Per una configurazione manuale, installa il pacchetto e sincronizza i progetti nativi:

npm install @capgo/capacitor-device-info
npx cap sync

Importa

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

Leggi un snapshot

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 è basato sul delta. La prima campionatura nativa può ometterlo; chiama getInfo() di nuovo in seguito o utilizza il monitoraggio per ricevere l'uso del processore popolato dopo la seconda campionatura.

Aggiorna in streaming

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

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

console.log(session.intervalMs, session.startedAt);

Comportamento del monitoraggio

• intervalMs predefinito su 1000 millisecondi. I valori sotto 250 millisecondi sono limitati a 250.
• emitImmediately predefinito su true.
• Imposta durationMs or sampleCount fermare la monitorizzazione automatica.
• Calling startMonitoring() Mentre la monitorizzazione è attiva, il sessione viene riavviata con le nuove opzioni.
• Chiamare deviceInfoUpdate include un indice a partire da 1 sequencela sessione startedAt timestamp, e elapsedMs.

, il timestamp della sessione, e

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

// Or remove every listener registered on this plugin:
await DeviceInfo.removeAllListeners();

Verifica lo stato di monitoraggio

const state = await DeviceInfo.isMonitoring();

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

Abilita i campi dei sensori

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);

I campi dei sensori sono facoltativi. Sono presenti solo quando il dispositivo, il sistema operativo e il sandbox dell'app espongono quel metrica.

Note sulla piattaforma

• L'iOS non richiede alcun permesso per le metriche esposte. Riferisce la disponibilità dei sensori CoreMotion ma non la temperatura CPU o GPU reale.
• L'Android non richiede alcuna autorizzazione per le metriche esposte. Le temperature del processore e della GPU sono letture di zona termica con sforzo.
• Il supporto web è a sforzo massimo e segnala array di sensori a bordo vuoti perché i browser non espongono i sensori di dispositivo nativi in modo coerente.

Riferimento a API

Metodo	Restituisce	Note
getInfo()	Promise<DeviceInfoSnapshot>	Legge un snapshot.
startMonitoring(options?)	Promise<StartMonitoringResult>	Avvia snapshot periodici, o riavvia una sessione attiva con nuove opzioni.
stopMonitoring()	Promise<StopMonitoringResult>	Sospende la sessione attiva.
isMonitoring()	Promise<MonitoringState>	Restituisce lo stato della sessione corrente.
addListener('deviceInfoUpdate', listener)	Promise<PluginListenerHandle>	Registra un ascoltatore di snapshot periodici.
removeAllListeners()	Promise<void>	Elimina ogni ascoltatore registrato sul plugin.
getPluginVersion()	Promise<PluginVersionResult>	Legge la versione nativa del plugin.

PluginListenerHandle è fornito da Capacitor e ha remove() per l'eliminazione di quel singolo ascoltatore.

Tipi di snapshot

interface CpuInfo {
  cores: number;
  activeCores?: number;
  architecture?: string;
  model?: string;
  usagePercent?: number | null;
  maxFrequencyHz?: number;
  temperatureCelsius?: number;
}

interface MemoryInfo {
  totalBytes?: number;
  freeBytes?: number;
  usedBytes?: number;
  usedPercent?: number;
  appUsedBytes?: number;
  appLimitBytes?: number;
  lowMemory?: boolean;
  pressure?: 'normal' | 'warning' | 'critical' | 'unknown';
}

interface StorageInfo {
  totalBytes?: number;
  freeBytes?: number;
  usedBytes?: number;
  usedPercent?: number;
}

interface GpuInfo {
  api?: 'metal' | 'opengl' | 'webgl' | 'unknown';
  vendor?: string;
  renderer?: string;
  version?: string;
  maxTextureSize?: number;
  temperatureCelsius?: number;
}

type ThermalState = 'nominal' | 'fair' | 'serious' | 'critical' | 'unknown';

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

Sono misure in byte, maxFrequencyHz sono hertz, e i valori di temperatura sono in Celsius. usagePercent possono essere null fino a quando la piattaforma non ha abbastanza campioni per calcolarlo.

Tipi di sensore

interface OnboardSensorDescriptor {
  type: string;
  name?: string;
  vendor?: string;
  platformType?: number;
  maximumRange?: number;
  resolution?: number;
  powerMilliamp?: number;
  minDelayMicroseconds?: number;
  wakeUp?: boolean;
}

interface OnboardSensorReading {
  type: string;
  unit: string;
  value: number;
  name?: string;
  timestamp?: number;
}

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

I timestampi dei dati sensoriali sono in millisecondi di epoca Unix. Le unità comuni sono Celsius, percento, hPa, luce e centimetri.

Tipi di monitoraggio

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

interface StartMonitoringResult {
  monitoring: boolean;
  intervalMs: number;
  startedAt: number;
}

interface StopMonitoringResult {
  monitoring: boolean;
}

interface MonitoringState {
  monitoring: boolean;
  intervalMs?: number;
  startedAt?: number;
  samplesEmitted?: number;
}

interface DeviceInfoUpdate extends DeviceInfoSnapshot {
  sequence: number;
  startedAt: number;
  elapsedMs: number;
}

interface PluginVersionResult {
  version: string;
}

startedAt, timestamp, e elapsedMs sono millisecondi. sequence Inizia a 1 per ogni sessione di monitoraggio.

Fonte di verità

Questa riferimento segue le informazioni pubbliche API nel plugin’s src/definitions.tsAggiorna questa pagina quando cambiano quelle fonti.

Keep going from Getting Started

Se stai utilizzando Getting Started per i diagnostici di dispositivo, collegalo con @capgo/capacitor-informazioni-di-dispositivo per l'overview Utilizza @capgo/capacitor-device-info per la pagina tutorial @capgo/capacitor-barometro per pressioni focalizzate e @capgo/capacitor-sensore di luce per letture focalizzate del sensore di luce.