开始
复制一个包含安装步骤和完整 Markdown 指南的设置提示。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-device-info`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/device-info/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
@capgo/capacitor-device-info 需要 Capacitor 8 或更高版本(@capacitor/core >=8.0.0).
您可以使用我们的AI辅助设置来安装插件。将Capgo技能添加到您的AI工具中,使用以下命令:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下提示:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-device-info` plugin in my project.对于手动设置,请安装包并同步本机项目:
npm install @capgo/capacitor-device-infonpx cap syncimport { DeviceInfo } from '@capgo/capacitor-device-info';读取一个快照
读取一个快照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 基于差异的。第一次原生样本可以省略它;稍后再次调用或使用监控接收第二个样本后的CPU使用率。 getInfo() 实时更新
监控行为
默认为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);毫秒。以下值
复制到剪贴板intervalMs默认值1000实时更新250毫秒数被限制在250.emitImmediately默认值为true.- 设置
durationMs或sampleCount或 - 停止自动监控。
startMonitoring()调用 - Every
deviceInfoUpdate每sequence包括一个以 1 为基数的startedAt, 会话的elapsedMs.
await DeviceInfo.stopMonitoring();await handle.remove();
// Or remove every listener registered on this plugin:await DeviceInfo.removeAllListeners();查看监控状态
Section titled “查看监控状态”const state = await DeviceInfo.isMonitoring();
if (state.monitoring) { console.log(state.samplesEmitted);}设备信息板块
Section titled “设备信息板块”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);传感器字段是可选的。它们仅在设备、操作系统和应用程序沙盒暴露该指标时才会出现。
- iOS 不需要权限来暴露指标。它报告了 CoreMotion 传感器可用性,但没有原始 CPU 或 GPU 温度。
- Android 不需要权限来暴露指标。CPU 和 GPU 温度是最佳努力的热区读取。
- Web 支持是最佳努力,并报告空载入的传感器数组,因为浏览器不一致地暴露本机设备传感器。
API 参考
标题:API 参考| 方法 | 返回 | 注意 |
|---|---|---|
getInfo() | Promise<DeviceInfoSnapshot> | 读取一个快照。 |
startMonitoring(options?) | Promise<StartMonitoringResult> | 启动周期快照,或者重新启动一个活跃的会话。 |
stopMonitoring() | Promise<StopMonitoringResult> | 停止活跃的会话。 |
isMonitoring() | Promise<MonitoringState> | 返回当前会话状态。 |
addListener('deviceInfoUpdate', listener) | Promise<PluginListenerHandle> | 注册周期快照监听器。 |
removeAllListeners() | Promise<void> | 移除该插件注册的所有监听器。 |
getPluginVersion() | Promise<PluginVersionResult> | 读取本机插件版本。 |
PluginListenerHandle 由 Capacitor 提供,具有 remove() 用于移除单个监听器的功能。
快照类型
标题:快照类型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;}context maxFrequencyHz 频率值为赫兹,温度值为摄氏度。 usagePercent 大小以字节为单位, null 是赫兹,温度值以摄氏度为单位。
可以是
Sensor typesinterface 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;}传感器读数的时间戳是Unix时间戳毫秒。常见单位是摄氏度,百分比,百帕,光度,厘米。
监控类型
监控类型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, 和 elapsedMs 是毫秒。 sequence 开始于 1 每次监控会话
真实来源
真实来源本参考文档遵循了公共API在插件中 src/definitions.ts当源文件发生变化时,请更新此页面。
继续从Getting Started
标题为“继续从Getting Started”如果您正在使用 设备诊断的Getting Started 连接它到 @capgo/capacitor-设备信息 查看概览 使用@capgo/capacitor-device-info 查看教程页面 @capgo/capacitor-气压计 为了专注的压力读数, 和 @capgo/capacitor-光感器 为了专注的光感器读数.