Mulai

Salin 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.

Instal

Anda dapat menggunakan Pengaturan AI yang Dibantu untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx 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 suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

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

Import

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

API Ringkasan

`isAvailable`

Periksa apakah sensor cahaya tersedia pada perangkat saat ini. Pastikan selalu memeriksa ketersediaan sensor sebelum mencobanya.

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

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

`start`

Mulai mendengarkan pembaruan sensor cahaya. Hal 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`

Hentikan mendengarkan pembaruan sensor cahaya. Hal ini akan menghentikan sensor dan menghemat baterai.

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

await LightSensor.stop();

`checkPermissions`

Periksa status izin saat ini untuk sensor pengambilan sampel tinggi. Pada Android 12+, izin HIGH_SAMPLING_RATE_SENSORS diperlukan untuk interval pembaruan sensor di bawah 200ms.

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

const status = await LightSensor.checkPermissions();

`requestPermissions`

Minta izin untuk sensor pengambilan sampel tinggi. Di 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 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 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 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’s src/definitions.ts. Jalankan ulang sinkronisasi ketika API publik berubah di atas.

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-light-sensor untuk kemampuan asli dalam Menggunakan @capgo/capacitor-light-sensor, API Ringkasan untuk detail implementasi dalam API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di Kunci API dan Perangkat untuk detail implementasi di Perangkat.