Getting Started

インストール

CapgoのAIアシストセットアップを使用してプラグインをインストールできます。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-light-sensor` plugin in my project.

Manual Setup を好む場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム固有の説明を参照してください。

bun add @capgo/capacitor-light-sensor
bunx cap sync

インポート

import { LightSensor } from '@capgo/capacitor-light-sensor';

API オーバービュー

isAvailable

現在のデバイス上の光センサが利用可能かどうかを確認します。 センサの利用可能性を確認する前に、常にセンサの利用可能性を確認してください。

import { LightSensor } from '@capgo/capacitor-light-sensor';

const { available } = await LightSensor.isAvailable();

start

光センサーの更新を開始する。 addListener この設定により、指定された間隔でセンサーの測定を開始します。

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.start({ updateInterval: 500 });

stop

コピー

import { LightSensor } from '@capgo/capacitor-light-sensor';

await LightSensor.stop();

checkPermissions

この設定により、センサーを停止し、バッテリーを節約します。

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.checkPermissions();

requestPermissions

高サンプリングレートセンサーの現在の許可状態を確認します。 Android 12+では、HIGH_SAMPLING_RATE_SENSORS許可が必要です センサーの更新間隔が200ms未満の場合。 コピー

import { LightSensor } from '@capgo/capacitor-light-sensor';

const status = await LightSensor.requestPermissions();

型式リファレンス

IsAvailableResult

センサーが利用可能であることを示す結果

export interface IsAvailableResult {
  /**
   * Whether the light sensor is available on this device.
   * Always false on iOS as the light sensor API is not available.
   *
   * @since 0.0.1
   */
  available: boolean;
}

StartOptions

コピー

export interface StartOptions {
  /**
   * The desired interval between sensor updates in milliseconds.
   * On Android 12+, there's a minimum interval of 200ms unless the app
   * has the HIGH_SAMPLING_RATE_SENSORS permission.
   *
   * @default 200
   * @since 0.0.1
   */
  updateInterval?: number;
}

LightSensorCallback

光センサー更新のためのコールバック関数

export type LightSensorCallback = (measurement: LightSensorMeasurement) => void;

PermissionStatus

許可の要求またはチェックの結果。

export interface PermissionStatus {
  /**
   * Whether the high sampling rate sensor permission is granted.
   * On Android 12+, this permission is required for update intervals below 200ms.
   *
   * @since 0.0.1
   */
  highSamplingRate: 'prompt' | 'prompt-with-rationale' | 'granted' | 'denied';
}

VersionResult

コピー

export interface VersionResult {
  /**
   * The current version of the plugin.
   *
   * @since 0.0.1
   */
  version: string;
}

LightSensorMeasurement

真実の源

export interface LightSensorMeasurement {
  /**
   * Ambient light level in lux (lx).
   *
   * @since 0.0.1
   */
  illuminance: number;

  /**
   * Timestamp of the measurement in seconds since epoch.
   *
   * @since 0.0.1
   */
  timestamp: number;
}

このページはプラグインから生成されています。

バージョン結果 src/definitions.ts. upstream の API が変更されたときに、再度 sync を実行してください。

Getting Started から続けてください。

あなたが「Getting Started」を使用している場合、ダッシュボードと __CAPGO_KEEP_0__ の操作を計画するには、__CAPGO_KEEP_0__ を接続してください。 Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-light-sensor Using @API/__CAPGO_KEEP_1__-light-sensor Using @capgo/capacitor-light-sensor for the native capability in Using @capgo/capacitor-light-sensor, API Overview for the implementation detail in API Overview, あなたが「Getting Started」を使用している場合、ダッシュボードと __CAPGO_KEEP_0__ の操作を計画するには、__CAPGO_KEEP_0__ を接続してください。 Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-light-sensor API キー API キーと デバイス デバイスの実装詳細