mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-10-07 06:03:30 +00:00
687 lines
17 KiB
TypeScript
687 lines
17 KiB
TypeScript
/*
|
|
* Copyright (c) 2021 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACCELEROMETER
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.AccelerometerResponse
|
|
*/
|
|
export interface AccelerometerResponse {
|
|
/**
|
|
* X-coordinate
|
|
* @since 3
|
|
*/
|
|
x: number;
|
|
|
|
/**
|
|
* Y-coordinate
|
|
* @since 3
|
|
*/
|
|
y: number;
|
|
|
|
/**
|
|
* Z-coordinate
|
|
* @since 3
|
|
*/
|
|
z: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACCELEROMETER
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.ACCELEROMETER
|
|
*/
|
|
export interface subscribeAccelerometerOptions {
|
|
/**
|
|
* Execution frequency of the callback function for listening to acceleration sensor data.
|
|
* Available values are as follows:
|
|
* 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming.
|
|
* 2. ui: High frequency (60 ms per callback), which is applicable to UI updating.
|
|
* 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption.
|
|
* The default value is normal.
|
|
* @since 3
|
|
*/
|
|
interval: string;
|
|
|
|
/**
|
|
* Called when acceleration sensor data changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: AccelerometerResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.MagneticFieldResponse
|
|
*/
|
|
export interface CompassResponse {
|
|
/**
|
|
* Direction of the device (in degrees).
|
|
* @since 3
|
|
*/
|
|
direction: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.MAGNETIC_FIELD
|
|
*/
|
|
export interface SubscribeCompassOptions {
|
|
/**
|
|
* Called when compass sensor data changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: CompassResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.ProximityResponse
|
|
*/
|
|
export interface ProximityResponse {
|
|
/**
|
|
* Distance between a visible object and the device screen
|
|
* @since 3
|
|
*/
|
|
distance: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.PROXIMITY
|
|
*/
|
|
export interface SubscribeProximityOptions {
|
|
/**
|
|
* Called when distance sensor data changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: ProximityResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.LightResponse
|
|
*/
|
|
export interface LightResponse {
|
|
/**
|
|
* Light intensity, in lux.
|
|
* @since 3
|
|
*/
|
|
intensity: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.AMBIENT_LIGHT
|
|
*/
|
|
export interface SubscribeLightOptions {
|
|
/**
|
|
* Called when ambient light sensor data changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: LightResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACTIVITY_MOTION
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.PedometerResponse
|
|
*/
|
|
export interface StepCounterResponse {
|
|
/**
|
|
* Number of steps counted.
|
|
* Each time the device restarts, the value is recalculated from 0 in phone, tablet.
|
|
* @since 3
|
|
*/
|
|
steps: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACTIVITY_MOTION
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.PEDOMETER
|
|
*/
|
|
export interface SubscribeStepCounterOptions {
|
|
/**
|
|
* Called when step counter sensor data changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: StepCounterResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.BarometerResponse
|
|
*/
|
|
export interface BarometerResponse {
|
|
/**
|
|
* Pressure, in pascal.
|
|
* @since 3
|
|
*/
|
|
pressure: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.BAROMETER
|
|
*/
|
|
export interface SubscribeBarometerOptions {
|
|
/**
|
|
* Called when the barometer sensor data changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: BarometerResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.READ_HEALTH_DATA
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.HeartRateResponse
|
|
*/
|
|
export interface HeartRateResponse {
|
|
/**
|
|
* Heart rate.
|
|
* 255 indicates an invalid value in lite wearable.
|
|
* @since 3
|
|
*/
|
|
heartRate: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.READ_HEALTH_DATA
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.HEART_RATE
|
|
*/
|
|
export interface SubscribeHeartRateOptions {
|
|
/**
|
|
* Called when the heart rate sensor data changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: HeartRateResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.WearDetectionResponse
|
|
*/
|
|
export interface OnBodyStateResponse {
|
|
/**
|
|
* Whether the sensor is worn.
|
|
* @since 3
|
|
*/
|
|
value: boolean;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.WEAR_DETECTION
|
|
*/
|
|
export interface SubscribeOnBodyStateOptions {
|
|
/**
|
|
* Called when the wearing status changes.
|
|
* @since 3
|
|
*/
|
|
success: (data: OnBodyStateResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.WEAR_DETECTION
|
|
*/
|
|
export interface GetOnBodyStateOptions {
|
|
/**
|
|
* Called when the sensor wearing state is obtained
|
|
* @since 3
|
|
*/
|
|
success: (data: OnBodyStateResponse) => void;
|
|
|
|
/**
|
|
* Called when the sensor wearing state fails to be obtained
|
|
* @since 3
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
|
|
/**
|
|
* Called when the execution is completed
|
|
* @since 3
|
|
*/
|
|
complete?: () => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor.OrientationResponse
|
|
*/
|
|
export interface DeviceOrientationResponse {
|
|
/**
|
|
* alpha
|
|
* @since 6
|
|
*/
|
|
alpha: number;
|
|
|
|
/**
|
|
* beta
|
|
* @since 6
|
|
*/
|
|
beta: number;
|
|
|
|
/**
|
|
* gamma
|
|
* @since 6
|
|
*/
|
|
gamma: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.ORIENTATION
|
|
*/
|
|
export interface SubscribeDeviceOrientationOptions {
|
|
/**
|
|
* Execution frequency of the callback function for listening to device orientation sensor data.
|
|
* Available values are as follows:
|
|
* 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming.
|
|
* 2. ui: High frequency (60 ms per callback), which is applicable to UI updating.
|
|
* 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption.
|
|
* The default value is normal.
|
|
* @since 6
|
|
*/
|
|
interval: string;
|
|
|
|
/**
|
|
* Called when device orientation sensor data changes.
|
|
* @since 6
|
|
*/
|
|
success: (data: DeviceOrientationResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 6
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.GYROSCOPE
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#.GyroscopeResponse
|
|
*/
|
|
export interface GyroscopeResponse {
|
|
/**
|
|
* X-coordinate
|
|
* @since 6
|
|
*/
|
|
x: number;
|
|
|
|
/**
|
|
* Y-coordinate
|
|
* @since 6
|
|
*/
|
|
y: number;
|
|
|
|
/**
|
|
* Z-coordinate
|
|
* @since 6
|
|
*/
|
|
z: number;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.GYROSCOPE
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.GYROSCOPE
|
|
*/
|
|
export interface SubscribeGyroscopeOptions {
|
|
/**
|
|
* Execution frequency of the callback function for listening to gyroscope sensor data.
|
|
* Available values are as follows:
|
|
* 1. game: Extremely high frequency (20 ms per callback), which is applicable to gaming.
|
|
* 2. ui: High frequency (60 ms per callback), which is applicable to UI updating.
|
|
* 3. normal: Regular frequency (200 ms per callback), which is application to low power consumption.
|
|
* The default value is normal.
|
|
* @since 6
|
|
*/
|
|
interval: string;
|
|
|
|
/**
|
|
* Called when gyroscope sensor data changes.
|
|
* @since 6
|
|
*/
|
|
success: (data: GyroscopeResponse) => void;
|
|
|
|
/**
|
|
* Called when the listening fails.
|
|
* @since 6
|
|
*/
|
|
fail?: (data: string, code: number) => void;
|
|
}
|
|
|
|
/**
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor
|
|
*/
|
|
export default class Sensor {
|
|
/**
|
|
* Listens to acceleration sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACCELEROMETER
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.ACCELEROMETER
|
|
*/
|
|
static subscribeAccelerometer(options: subscribeAccelerometerOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to acceleration sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACCELEROMETER
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.ACCELEROMETER
|
|
*/
|
|
static unsubscribeAccelerometer(): void;
|
|
|
|
/**
|
|
* Listens to compass sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.MAGNETIC_FIELD
|
|
*/
|
|
static subscribeCompass(options: SubscribeCompassOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to compass sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.MAGNETIC_FIELD
|
|
*/
|
|
static unsubscribeCompass(): void;
|
|
|
|
/**
|
|
* Listens to distance sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.PROXIMITY
|
|
*/
|
|
static subscribeProximity(options: SubscribeProximityOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to distance sensor data.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.PROXIMITY
|
|
*/
|
|
static unsubscribeProximity(): void;
|
|
|
|
/**
|
|
* Listens to ambient light sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.AMBIENT_LIGHT
|
|
*/
|
|
static subscribeLight(options: SubscribeLightOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to ambient light sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.AMBIENT_LIGHT
|
|
*/
|
|
static unsubscribeLight(): void;
|
|
|
|
/**
|
|
* Listens to step counter sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACTIVITY_MOTION
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.PEDOMETER
|
|
*/
|
|
static subscribeStepCounter(options: SubscribeStepCounterOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to step counter sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.ACTIVITY_MOTION
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.PEDOMETER
|
|
*/
|
|
static unsubscribeStepCounter(): void;
|
|
|
|
/**
|
|
* Listens to barometer sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.BAROMETER
|
|
*/
|
|
static subscribeBarometer(options: SubscribeBarometerOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to barometer sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.BAROMETER
|
|
*/
|
|
static unsubscribeBarometer(): void;
|
|
|
|
/**
|
|
* Listens to changes of heart rate sensor data.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.READ_HEALTH_DATA
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.HEART_RATE
|
|
*/
|
|
static subscribeHeartRate(options: SubscribeHeartRateOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to heart rate sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.READ_HEALTH_DATA
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.HEART_RATE
|
|
*/
|
|
static unsubscribeHeartRate(): void;
|
|
|
|
/**
|
|
* Listens to whether a sensor is worn.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.WEAR_DETECTION
|
|
*/
|
|
static subscribeOnBodyState(options: SubscribeOnBodyStateOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to whether the sensor is worn.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.WEAR_DETECTION
|
|
*/
|
|
static unsubscribeOnBodyState(): void;
|
|
|
|
/**
|
|
* Obtains the sensor wearing state.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 3
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.WEAR_DETECTION
|
|
*/
|
|
static getOnBodyState(options: GetOnBodyStateOptions): void;
|
|
|
|
/**
|
|
* Listens to device orientation sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.ORIENTATION
|
|
*/
|
|
static subscribeDeviceOrientation(options: SubscribeDeviceOrientationOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to device orientation sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.ORIENTATION
|
|
*/
|
|
static unsubscribeDeviceOrientation(): void;
|
|
|
|
/**
|
|
* Listens to gyroscope sensor data changes.
|
|
* If this API is called multiple times, the last call takes effect.
|
|
* @param options Options.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.GYROSCOPE
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.GYROSCOPE
|
|
*/
|
|
static subscribeGyroscope(options: SubscribeGyroscopeOptions): void;
|
|
|
|
/**
|
|
* Cancels listening to gyroscope sensor data.
|
|
* @syscap SystemCapability.Sensors.Sensor
|
|
* @permission ohos.permission.GYROSCOPE
|
|
* @since 6
|
|
* @deprecated since 8
|
|
* @useinstead ohos.sensor/sensor#event:SensorId.GYROSCOPE
|
|
*/
|
|
static unsubscribeGyroscope(): void;
|
|
}
|