始め方

互換性

@capgo/capacitor-device-info Capacitor 8 以上が必要です (@capacitor/core >=8.0.0).

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。 AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください。

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-info
npx cap sync

インポート

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

1つのスナップショットを読み取る

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 デリタ式です。最初のネイティブサンプルでは省略できます; 2回目のサンプル後にCPU使用率が充填された場合に再度呼び出すか、監視を使用して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 __CAPGO_KEEP_0__に設定 1000 ミリ秒。__CAPGO_KEEP_0__未満の値は 250 ミリ秒以下の値は 250.
• emitImmediately __CAPGO_KEEP_0__に設定 true.
• 監視を開始 durationMs または sampleCount 監視を自動的に停止する
• 監視中の「Calling」は、監視を再開して新しいオプションを使用します。 startMonitoring() 監視が有効な場合に「Calling」を呼び出すと、セッションが再起動されます。
• セッションが再起動されます。 deviceInfoUpdate 1を基準に含む sequence, セッションの 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);
}

センサーフィールドのオンボーディング

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

センサー フィールドはオプションです。デバイス、OS、そしてアプリのサンドボックスがそのメトリックを公開している場合にのみ表示されます。

プラットフォームに関する注意

• iOSでは、公開されたメトリックに必要な権限はありません。CoreMotion センサーの可用性を報告しますが、RAW CPU または GPU の温度は報告しません。
• Androidでは、公開されたメトリックに必要な権限はありません。CPU と GPU の温度はベストエフォートの熱帯域読み取りです。
• Web サポートはベストエフォートであり、ブラウザがネイティブデバイスセンサを一貫して公開していないため、空のオンボードセンサ配列を報告します。

API リファレンス

メソッド	戻り値	注意
getInfo()	Promise<DeviceInfoSnapshot>	1 つのスナップショットを読み取ります。
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;
}

サイズはバイトです maxFrequencyHz はヘルツ、温度値はセルシウスです。 usagePercent が可能です。 null は、プラットフォームがサンプルを計算するのに十分なサンプルを取得するまで続きます。

センサータイプ

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

センサーリーディングのタイムスタンプはUnixエポックミリ秒です。一般的な単位はセルシウス、パーセント、hPa、ルクス、センチメートルです。

監視タイプ

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その真実の源が変更されたら、このページを更新してください。

「始めから始める」から続けてください

Capacitorを使用している場合 「始めから始める」 デバイス診断の場合、デバイス情報と接続してください @capgo/capacitor-device-info 概要のために 使用する@capgo/capacitor-device-info チュートリアルページのために 使用する@capgo/capacitor-barometer 集中圧力読み取りのために 使用する@capgo/capacitor-light-sensor 集中光センサ読み取りのために