Getting Started

설치

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

고속 샘플링 센서에 대한 현재 권한 상태를 확인하세요. 안드로이드 12 이상에서 HIGH_SAMPLING_RATE_SENSORS 권한이 필요합니다. 200ms 이하의 센서 업데이트 간격을 사용할 때.

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

Callback function for light sensor updates.

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

한 번의 조명 센서 측정.

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이 upstream에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속

이 플러그인을 사용하여 Getting Started 계획 대시보드 및 API 운영을 위해 Using @capgo/capacitor-light-sensor Using @capgo/capacitor-light-sensor API 개요 API 개요 소개 소개에 대한 구현 세부 정보를 위해 API 키 API 키에 대한 구현 세부 정보를 위해, 그리고 장치 장치에 대한 구현 세부 정보를 위해