Getting Started

Compatibilidad

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

Instalación

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las habilidades Capgo a su herramienta de IA utilizando el siguiente comando:

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-device-info` plugin in my project.

Para una configuración manual, instale el paquete y sincronice los proyectos nativos:

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

Importar

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

Leer una instantánea

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 es basado en deltas. El primer sample nativo puede omitirlo; llamar getInfo() de nuevo más tarde o utilice el seguimiento para recibir el uso del CPU poblado después de la segunda muestra.

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

Comportamiento de seguimiento

• intervalMs por defecto 1000 milisegundos. Los valores por debajo 250 se redondean a 250.
• emitImmediately por defecto true.
• Establecer durationMs o sampleCount para detener la monitorización automáticamente.
• Llamada startMonitoring() reiniciar la sesión con las nuevas opciones mientras la monitorización está activa.
• Cada deviceInfoUpdate incluye un sequence, el timestamp de la startedAt , elapsedMs.

,

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

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

,

const state = await DeviceInfo.isMonitoring();

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

Configurar campos de sensores

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

Los campos de sensores son opcionales. Solo están presentes cuando el dispositivo, el sistema operativo y el entorno de la aplicación expone esa métrica.

Observaciones de plataforma

• iOS no requiere permisos para las métricas expuestas. Informa la disponibilidad de sensores de CoreMotion, pero no la temperatura de CPU o GPU en bruto.
• Android no requiere permisos para las métricas expuestas. Las temperaturas de CPU y GPU son lecturas de zona térmica de mejor esfuerzo.
• El soporte web es de mejor esfuerzo y informa arrays de sensores onboard vacíos porque los navegadores no exponen sensores de dispositivo nativos de manera consistente.

API referencia

Metodo	Devuelve	Notas
getInfo()	Promise<DeviceInfoSnapshot>	Lee una instantánea.
startMonitoring(options?)	Promise<StartMonitoringResult>	Inicia instantáneas periódicas, o reanuda una sesión activa con nuevas opciones.
stopMonitoring()	Promise<StopMonitoringResult>	Detiene la sesión activa.
isMonitoring()	Promise<MonitoringState>	Devuelve el estado de la sesión actual.
addListener('deviceInfoUpdate', listener)	Promise<PluginListenerHandle>	Registra un oyente de instantáneas periódicas.
removeAllListeners()	Promise<void>	Elimina cada oyente registrado en el plugin.
getPluginVersion()	Promise<PluginVersionResult>	Lee la versión nativa del plugin.

PluginListenerHandle está proporcionado por Capacitor y tiene remove() para eliminar ese oyente individual.

Tipos de instantáneas

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

Las tamaños son bytes, maxFrequencyHz es hertzios y los valores de temperatura son Celsius. usagePercent pueden ser null hasta que la plataforma tenga suficientes muestras para calcularlo.

Tipos de sensores

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

Los tiempos de lectura de sensores son milisegundos de epoch Unix. Las unidades comunes son Celsius, por ciento, hPa, lux y centímetros.

Tipos de monitoreo

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, y elapsedMs son milisegundos. sequence comienza en 1 para cada sesión de monitoreo.

Fuente de verdad

Esta referencia sigue a la publicación API en el plugin’s src/definitions.tsActualice esta página cuando esa fuente cambie.

Siga adelante desde Getting Started

Si estás utilizando Iniciación para el diagnóstico de dispositivos, conecta con @capgo/capacitor-device-info para el resumen, Usando @capgo/capacitor-device-info para la página de tutoriales, @capgo/capacitor-barometer para lecturas de presión enfocadas, y @capgo/capacitor-light-sensor para lecturas del sensor de luz enfocadas.