はじめから始める

インストール

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-light-sensor` plugin in my project.

Manual Setupを使用する場合は、以下のコマンドを実行してください。プラットフォーム固有の指示に従ってください。

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

Import

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

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

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

const status = await LightSensor.checkPermissions();

requestPermissions

高サンプリングレートセンサーの許可を求めます。 Android 12+では、HIGH_SAMPLING_RATE_SENSORS パーミッションを要求します。

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

const status = await LightSensor.requestPermissions();

Type Reference

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

1 つの光センサーメジャメント。

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パブリック API がアップストリームで変更されたときは、再度同期を実行してください。

続きましょう：Getting Started

あなたが使用しているプラグインが Getting Started ダッシュボードと API の計画と実行を支援する場合、 Using @capgo/capacitor-light-sensor Using @capgo/capacitor-light-sensor API Overview for the implementation detail in API Overview, 導入 導入の実装詳細については API キー API キーの実装詳細については デバイス デバイスの実装詳細については