Getting Started

互換性

@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使用率が充実した2回目のサンプルを受け取るために監視を使用します。 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() 監視が有効な場合は、セッションを再起動して新しいオプションを使用します。
• 毎回 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、そしてアプリケーションサンドボックスがそのメトリックを公開している場合にのみ表示されます。

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

• セクションのタイトル “Stop updates and remove listeners”
• Android では、公開メトリクスに必要な権限はありません。 CPU と GPU の温度は、ベストエフォートの熱帯域読み取りです。
• Web サポートはベストエフォートであり、ブラウザがnative デバイス センサを一貫して公開していないため、オンボード センサ配列が空になります。

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 Sizes are bytes,

is hertz, and temperature values are Celsius.

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プラグインを使用している場合 Capacitorプラグインの Capacitorプラグインの @capgo/capacitor-device-info Capacitorプラグインの @capgo/capacitor-device-info @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-device-info @capgo/capacitor-barometer for focused pressure readings, and @capgo/capacitor-light-sensor focused light センサーの読み取りを優先します。