はじめから始める

インストール

AI-Assisted Setupを使用してプラグインをインストールできます。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();

型参照

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」を使用してダッシュボードと__CAPGO_KEEP_0__の作業計画を立てている場合、__CAPGO_KEEP_0__を 「@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-light-sensor」 「@API/__CAPGO_KEEP_1__-light-sensor」で使用するネイティブ機能の説明 Using @capgo/capacitor-light-sensor for the native capability in Using @capgo/capacitor-light-sensor, 「API Overview」 「API Overview」 導入 導入の実装詳細のために API キー API キーの実装詳細のために、 デバイス デバイスの実装詳細のために