Mulai

Copy sebuah prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-light-sensor`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/light-sensor/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Pasang

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

Impor

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

API Ringkasan

`isAvailable`

Periksa apakah sensor cahaya tersedia pada perangkat saat ini. Selalu periksa ketersediaan sensor sebelum mencoba menggunakannya.

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

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

`start`

Mulai mendengarkan pembaruan sensor cahaya. addListener Ini akan memulai pengukuran sensor pada interval yang ditentukan.

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

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

`stop`

Salin ke clipboard

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

await LightSensor.stop();

`checkPermissions`

Ini akan menghentikan sensor dan menghemat baterai.

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

const status = await LightSensor.checkPermissions();

`requestPermissions`

Periksa status izin saat ini untuk sensor pengambilan sampel tinggi.

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

const status = await LightSensor.requestPermissions();

Referensi Tipe

`IsAvailableResult`

Hasil menunjukkan apakah sensor tersedia.

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`

Opsi untuk memulai pengguna sensor cahaya.

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`

Fungsi panggilan balik untuk pembaruan sensor cahaya.

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

`PermissionStatus`

Hasil dari permintaan izin atau pengecekan.

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`

Informasi versi plugin.

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

`LightSensorMeasurement`

Satu pengukuran sensor cahaya.

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

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Re-run sinkronisasi ketika API publik berubah di atas.