Panduan Memulai

Salin prompt setup yang berisi langkah install 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.

Instal

Anda bisa menggunakan AI-Assisted Setup kami untuk menginstal plugin ini. Tambahkan skill Capgo ke tool AI Anda dengan command berikut:

bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Lalu gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-light-sensor` plugin in my project.

Jika Anda lebih memilih Manual Setup, instal plugin dengan menjalankan perintah berikut dan ikuti petunjuk khusus platform di bawah ini:

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

Impor

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

Mulai cepat

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

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

Contoh: mulai

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

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

Contoh: stop

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

await LightSensor.stop();

Kesalahan umum

Izin: panggil checkPermissions() kemudian requestPermissions() saat dibutuhkan.
Listeners: hapus handle saat screen unmount.
Sumber kebenaran tunggal: percayai src/definitions.ts di repo GitHub.

Ringkasan API

`isAvailable`

Cek apakah light sensor tersedia di perangkat saat ini. Selalu cek ketersediaan sensor sebelum mencoba menggunakannya.

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

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

`start`

Mulai mendengarkan update sensor cahaya. Ini akan memulai pengukuran sensor pada interval yang ditentukan. Gunakan addListener untuk menerima data sensor.

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

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

`stop`

Berhenti mendengarkan update sensor cahaya. Ini akan menghentikan sensor dan menghemat baterai.

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

await LightSensor.stop();

`checkPermissions`

Cek status izin saat ini untuk sensor dengan sampling rate tinggi. Pada Android 12+, izin HIGH_SAMPLING_RATE_SENSORS diperlukan untuk interval update sensor di bawah 200ms.

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

const status = await LightSensor.checkPermissions();

`requestPermissions`

Meminta izin untuk sensor dengan sampling rate tinggi. Pada Android 12+, ini meminta izin HIGH_SAMPLING_RATE_SENSORS.

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

const status = await LightSensor.requestPermissions();

Referensi Tipe

`IsAvailableResult`

Hasil yang 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 listener 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 callback untuk update sensor cahaya.

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

`PermissionStatus`

Hasil dari permintaan atau pengecekan izin.

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 hasil 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 dibuat dari plugin src/definitions.ts. Jalankan ulang sync saat API publik berubah di upstream.

Lanjutkan dari Getting Started

Jika Anda menggunakan Panduan Memulai untuk merencanakan operasi dashboard dan API, hubungkan dengan Menggunakan @capgo/capacitor-light-sensor untuk kemampuan native di halaman Menggunakan @capgo/capacitor-light-sensor, Ringkasan API untuk detail implementasi di API Overview, Pendahuluan untuk detail implementasi di Introduction, Kunci API untuk detail implementasi di API Keys, dan Perangkat untuk detail implementasi di Devices.