@capgo/capacitor-device-info

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-device-info in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-device-info to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Production-ready Capacitor plugin for device diagnostics, support screens, QA tools, and in-app performance dashboards. Read CPU, memory, GPU, storage, thermal, low-power-mode, and onboard sensor data from iOS, Android, and Web with one snapshot call or a live interval stream.

Features

• One API for instant snapshots and live monitoring streams.
• No runtime permissions for the metrics currently exposed.
• Built for support/debug dashboards: identify low memory, storage pressure, low power mode, thermal state, GPU renderer, and hardware sensor availability.
• Listener-first streaming for charts: deviceInfoUpdate emits CPU, memory, storage, GPU, thermal, and sensor snapshots on a configurable interval.
• Auto-stop streams by durationMs or sampleCount.
• Onboard sensor catalog with common readings when hardware exposes them: battery temperature, ambient temperature, relative humidity, pressure, light, and proximity.
• Native implementations: Metal, Mach, and CoreMotion availability on iOS; ActivityManager, StatFs, /proc, OpenGL ES, SensorManager, and thermal zones on Android.

What You Can Read

Sensor Coverage

Sensor data is onboard-only. This plugin does not call weather services or fetch outside temperature/humidity from the network.

Common Use Cases

• Add a diagnostics panel to support tickets.
• Stream device metrics into an in-app performance graph.
• Detect low-memory or low-storage conditions before heavy work.
• Show hardware/GPU details when debugging device-specific rendering bugs.
• Log thermal and low-power state around slow sessions.
• Discover available sensors before enabling sensor-heavy features.

Compatibility

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

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

Usage

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

const snapshot = await DeviceInfo.getInfo();
console.log(snapshot.cpu.cores, snapshot.memory.usedPercent);

const handle = await DeviceInfo.addListener('deviceInfoUpdate', (sample) => {
  console.log(sample.sequence, sample.cpu.usagePercent, sample.memory.usedPercent);
});

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

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

CPU usage is calculated from deltas, so the first native sample may omit cpu.usagePercent. Periodic monitoring fills it after the second sample when the platform exposes CPU ticks.

Platform Notes

• iOS requires no permissions for the metrics exposed here. GPU data comes from Metal, CPU and memory data comes from Mach APIs, and sensor availability comes from CoreMotion checks. iOS public APIs do not expose raw CPU/GPU temperature.
• Android requires no permissions. GPU data is queried from a short-lived OpenGL ES context and then cached. CPU/GPU temperatures are best-effort thermal-zone reads and may be omitted on restricted devices.
• Web support is best effort. Browser APIs expose CPU cores, storage quota, JS heap on Chromium, and WebGL GPU strings when allowed.

Example App

The example-app/ folder links to the plugin with file:.. and includes an interval listener chart.

cd example-app
npm install
npm run start

API

• getInfo()
• startMonitoring(...)
• stopMonitoring()
• isMonitoring()
• addListener('deviceInfoUpdate', ...)
• removeAllListeners()
• getPluginVersion()
• Interfaces
• Type Aliases

Capacitor plugin contract for reading device CPU, memory, GPU, storage, and onboard sensor metrics.

getInfo()

getInfo() => Promise<DeviceInfoSnapshot>

Read one CPU, memory, GPU, storage, thermal, and onboard sensor snapshot.

Returns: Promise<DeviceInfoSnapshot>

Since: 8.0.0

startMonitoring(...)

startMonitoring(options?: MonitoringOptions | undefined) => Promise<StartMonitoringResult>

Start periodic device snapshots.

Listen to deviceInfoUpdate to receive samples. Calling this while monitoring is already active restarts monitoring with the new options.

Returns: Promise<StartMonitoringResult>

Since: 8.0.0

stopMonitoring()

stopMonitoring() => Promise<StopMonitoringResult>

Stop periodic device snapshots.

Returns: Promise<StopMonitoringResult>

Since: 8.0.0

isMonitoring()

isMonitoring() => Promise<MonitoringState>

Return current periodic monitoring state.

Returns: Promise<MonitoringState>

Since: 8.0.0

addListener('deviceInfoUpdate', ...)

addListener(eventName: 'deviceInfoUpdate', listenerFunc: (event: DeviceInfoUpdate) => void) => Promise<PluginListenerHandle>

Listen for periodic device snapshots.

Returns: Promise<PluginListenerHandle>

Since: 8.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners that have been registered on the plugin.

Since: 8.0.0

getPluginVersion()

getPluginVersion() => Promise<PluginVersionResult>

Get the native Capacitor plugin version.

Returns: Promise<PluginVersionResult>

Since: 8.0.0

Interfaces

DeviceInfoSnapshot

Instant device snapshot returned by {@link DeviceInfoPlugin.getInfo}.

CpuInfo

CPU snapshot for the current device.

All frequency values are reported in hertz. usagePercent is null when a platform needs at least two samples to calculate CPU usage.

MemoryInfo

Memory snapshot for the current device and app process.

All size values are reported in bytes.

StorageInfo

Storage snapshot for the app data volume.

All size values are reported in bytes.

GpuInfo

GPU snapshot for the primary graphics device.

OnboardSensorsInfo

Onboard sensors snapshot.

This only reports hardware sensors exposed by the device or operating system. It does not fetch weather data or any external temperature/humidity source.

OnboardSensorDescriptor

Description of an onboard hardware sensor exposed by the platform.

OnboardSensorReading

Instant onboard sensor reading.

StartMonitoringResult

Result returned when monitoring starts.

MonitoringOptions

Options used to start periodic device snapshots.

StopMonitoringResult

Result returned by {@link DeviceInfoPlugin.stopMonitoring}.

MonitoringState

Current monitoring state.

PluginListenerHandle

DeviceInfoUpdate

Periodic event payload emitted while monitoring is active.

PluginVersionResult

Plugin version payload.

Type Aliases

ThermalState

Thermal state reported by the platform.

'nominal' | 'fair' | 'serious' | 'critical' | 'unknown'