@ohos.sensor (传感器)

sensor模块提供了获取传感器数据的能力,包括获取传感器属性列表,订阅传感器数据,以及一些通用的传感器算法。

说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import sensor from '@ohos.sensor';

sensor.on9+

ACCELEROMETER9+

on(type: SensorId.ACCELEROMETER, callback: Callback<AccelerometerResponse>,options?: Options): void

订阅加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ACCELEROMETER 传感器类型,该值固定为SensorId.ACCELEROMETER。
callback Callback<AccelerometerResponse> 回调函数,异步上报的传感器数据固定为AccelerometerResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.ACCELEROMETER, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ACCELEROMETER_UNCALIBRATED9+

on(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback<AccelerometerUncalibratedResponse>,options?: Options): void

订阅未校准加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ACCELEROMETER_UNCALIBRATED 传感器类型,该值固定为SensorId.ACCELEROMETER_UNCALIBRATED。
callback Callback<AccelerometerUncalibratedResponse> 回调函数,异步上报的传感器数据固定为AccelerometerUncalibratedResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('X-coordinate bias: ' + data.biasX);
        console.info('Y-coordinate bias: ' + data.biasY);
        console.info('Z-coordinate bias: ' + data.biasZ);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

AMBIENT_LIGHT9+

on(type: SensorId.AMBIENT_LIGHT, callback: Callback<LightResponse>, options?: Options): void

订阅环境光传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.AMBIENT_LIGHT 传感器类型,该值固定为SensorId.AMBIENT_LIGHT。
callback Callback<LightResponse> 回调函数,异步上报的传感器数据固定为LightResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.AMBIENT_LIGHT, function (data) {
        console.info('The ambient light intensity: ' + data.intensity);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

AMBIENT_TEMPERATURE9+

on(type: SensorId.AMBIENT_TEMPERATURE, callback: Callback<AmbientTemperatureResponse>,options?: Options): void

订阅温度传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.AMBIENT_TEMPERATURE 传感器类型,该值固定为SensorId.AMBIENT_TEMPERATURE。
callback Callback<AmbientTemperatureResponse> 回调函数,异步上报的传感器数据固定为AmbientTemperatureResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, function (data) {
        console.info('Temperature: ' + data.temperature);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

BAROMETER9+

on(type: SensorId.BAROMETER, callback: Callback<BarometerResponse>, options?: Options): void

订阅气压计传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.BAROMETER 传感器类型,该值固定为SensorId.BAROMETER。
callback Callback<BarometerResponse> 回调函数,异步上报的传感器数据固定为BarometerResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.BAROMETER, function (data) {
        console.info('Atmospheric pressure: ' + data.pressure);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GRAVITY9+

on(type: SensorId.GRAVITY, callback: Callback<GravityResponse>,options?: Options): void

订阅重力传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GRAVITY 传感器类型,该值固定为SensorId.GRAVITY。
callback Callback<GravityResponse> 回调函数,异步上报的传感器数据固定为GravityResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.GRAVITY, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GYROSCOPE9+

on(type: SensorId.GYROSCOPE, callback: Callback<GyroscopeResponse>,options?: Options): void

订阅校准的陀螺仪传感器数据。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GYROSCOPE 传感器类型,该值固定为SensorId.GYROSCOPE。
callback Callback<GyroscopeResponse> 回调函数,异步上报的传感器数据固定为GyroscopeResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.GYROSCOPE, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GYROSCOPE_UNCALIBRATED9+

on(type: SensorId.GYROSCOPE_UNCALIBRATED, callback: Callback<GyroscopeUncalibratedResponse>, options?: Options): void

订阅未校准陀螺仪传感器数据

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GYROSCOPE_UNCALIBRATED 传感器类型,该值固定为SensorId.GYROSCOPE_UNCALIBRATED。
callback Callback<GyroscopeUncalibratedResponse> 回调函数,异步上报的传感器数据固定为GyroscopeUncalibratedResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('X-coordinate bias: ' + data.biasX);
        console.info('Y-coordinate bias: ' + data.biasY);
        console.info('Z-coordinate bias: ' + data.biasZ);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HALL9+

on(type: SensorId.HALL, callback: Callback<HallResponse>, options?: Options): void

订阅霍尔传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HALL 传感器类型,该值固定为SensorId.HALL。
callback Callback<HallResponse> 回调函数,异步上报的传感器数据固定为HallResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.HALL, function (data) {
        console.info('Hall status: ' + data.status);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HEART_RATE9+

on(type: SensorId.HEART_RATE, callback: Callback<HeartRateResponse>,options?: Options): void

订阅心率传感器数据。

需要权限:ohos.permission.READ_HEALTH_DATA

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HEART_RATE 传感器类型,该值固定为SensorId.HEART_RATE。
callback Callback<HeartRateResponse> 回调函数,异步上报的传感器数据固定为HeartRateResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.HEART_RATE, function (data) {
        console.info('Heart rate: ' + data.heartRate);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HUMIDITY9+

on(type: SensorId.HUMIDITY, callback: Callback<HumidityResponse>,options?: Options): void

订阅湿度传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HUMIDITY 传感器类型,该值固定为SensorId.HUMIDITY。
callback Callback<HumidityResponse> 回调函数,异步上报的传感器数据固定为HumidityResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.HUMIDITY, function (data) {
        console.info('Humidity: ' + data.humidity);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

LINEAR_ACCELEROMETER9+

on(type: SensorId.LINEAR_ACCELEROMETER, callback: Callback<LinearAccelerometerResponse>, options?: Options): void

订阅线性加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.LINEAR_ACCELEROMETER 传感器类型,该值固定为SensorId.LINEAR_ACCELEROMETER。
callback Callback<LinearAccelerometerResponse> 回调函数,异步上报的传感器数据固定为LinearAccelerometerResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

MAGNETIC_FIELD9+

on(type: SensorId.MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>,options?: Options): void

订阅地磁传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.MAGNETIC_FIELD 传感器类型,该值固定为SensorId.MAGNETIC_FIELD。
callback Callback<MagneticFieldResponse> 回调函数,异步上报的传感器数据固定为MagneticFieldResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.MAGNETIC_FIELD, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

MAGNETIC_FIELD_UNCALIBRATED9+

on(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback: Callback<MagneticFieldUncalibratedResponse>, options?: Options): void

订阅未校准地磁传感器数据

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.MAGNETIC_FIELD_UNCALIBRATED 传感器类型,该值固定为SensorId.MAGNETIC_FIELD_UNCALIBRATED。
callback Callback<MagneticFieldUncalibratedResponse> 回调函数,异步上报的传感器数据固定为MagneticFieldUncalibratedResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('X-coordinate bias: ' + data.biasX);
        console.info('Y-coordinate bias: ' + data.biasY);
        console.info('Z-coordinate bias: ' + data.biasZ);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ORIENTATION9+

on(type: SensorId.ORIENTATION, callback: Callback<OrientationResponse>,options?: Options): void

订阅方向传感器数据。

系统能力:SystemCapability.Sensors.Sensor

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

参数:

参数名 类型 必填 说明
type SensorId.ORIENTATION 传感器类型,该值固定为SensorId.ORIENTATION。
callback Callback<OrientationResponse> 回调函数,异步上报的传感器数据固定为OrientationResponse。
options Options 设置上报频率,默认值为200000000ns。

示例:

try {
    sensor.on(sensor.SensorId.ORIENTATION, function (data) {
        console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
        console.info('The device rotates at an angle around the X axis: ' + data.beta);
        console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PEDOMETER9+

on(type: SensorId.PEDOMETER, callback: Callback<PedometerResponse>, options?: Options): void

订阅计步器传感器数据。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

参数:

参数名 类型 必填 说明
type SensorId.PEDOMETER 传感器类型,该值固定为SensorId.PEDOMETER。
callback Callback<PedometerResponse> 回调函数,异步上报的传感器数据固定为PedometerResponse。
options Options 设置上报频率,默认值为200000000ns。

示例:

try {
    sensor.on(sensor.SensorId.PEDOMETER, function (data) {
        console.info('Step count: ' + data.steps);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PEDOMETER_DETECTION9+

on(type: SensorId.PEDOMETER_DETECTION, callback: Callback<PedometerDetectionResponse>, options?: Options): void

订阅计步检测器传感器数据。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PEDOMETER_DETECTION 传感器类型,该值固定为SensorId.PEDOMETER_DETECTION。
callback Callback<PedometerDetectionResponse> 回调函数,异步上报的传感器数据固定为PedometerDetectionResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.PEDOMETER_DETECTION, function (data) {
        console.info('Pedometer scalar: ' + data.scalar);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PROXIMITY9+

on(type: SensorId.PROXIMITY, callback: Callback<ProximityResponse>, options?: Options): void

订阅接近光传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PROXIMITY 传感器类型,该值固定为SensorId.PROXIMITY。
callback Callback<ProximityResponse> 回调函数,异步上报的传感器数据固定为ProximityResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.PROXIMITY, function (data) {
        console.info('Distance: ' + data.distance);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ROTATION_VECTOR9+

on(type: SensorId.ROTATION_VECTOR, callback: Callback<RotationVectorResponse>, options?: Options): void

订阅旋转矢量传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ROTATION_VECTOR 传感器类型,该值固定为SensorId.ROTATION_VECTOR。
callback Callback<RotationVectorResponse> 回调函数,异步上报的传感器数据固定为RotationVectorResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.ROTATION_VECTOR, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('Scalar quantity: ' + data.w);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

SIGNIFICANT_MOTION9+

on(type: SensorId.SIGNIFICANT_MOTION, callback: Callback<SignificantMotionResponse>, options?: Options): void

订阅大幅动作检测传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.SIGNIFICANT_MOTION 传感器类型,该值固定为SensorId.SIGNIFICANT_MOTION。
callback Callback<SignificantMotionResponse> 回调函数,异步上报的传感器数据固定为SignificantMotionResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, function (data) {
        console.info('Scalar data: ' + data.scalar);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

WEAR_DETECTION9+

on(type: SensorId.WEAR_DETECTION, callback: Callback<WearDetectionResponse>, options?: Options): void

订阅佩戴检测传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.WEAR_DETECTION 传感器类型,该值固定为SensorId.WEAR_DETECTION。
callback Callback<WearDetectionResponse> 回调函数,异步上报的传感器数据固定为WearDetectionResponse。
options Options 设置上报频率,默认值为200000000ns。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.on(sensor.SensorId.WEAR_DETECTION, function (data) {
        console.info('Wear status: ' + data.value);
    }, { interval: 10000000 });
} catch (err) {
    console.error('On fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

sensor.once9+

ACCELEROMETER9+

once(type: SensorId.ACCELEROMETER, callback: Callback<AccelerometerResponse>): void

获取一次加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ACCELEROMETER 传感器类型,该值固定为SensorId.ACCELEROMETER。
callback Callback<AccelerometerResponse> 回调函数,异步上报的传感器数据固定为AccelerometerResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.ACCELEROMETER, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ACCELEROMETER_UNCALIBRATED9+

once(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback: Callback<AccelerometerUncalibratedResponse>): void

获取一次未校准加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ACCELEROMETER_UNCALIBRATED 传感器类型,该值固定为SensorId.ACCELEROMETER_UNCALIBRATED。
callback Callback<AccelerometerUncalibratedResponse> 回调函数,异步上报的传感器数据固定为AccelerometerUncalibratedResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('X-coordinate bias: ' + data.biasX);
        console.info('Y-coordinate bias: ' + data.biasY);
        console.info('Z-coordinate bias: ' + data.biasZ);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

AMBIENT_LIGHT9+

once(type: SensorId.AMBIENT_LIGHT, callback: Callback<LightResponse>): void

获取一次环境光传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.AMBIENT_LIGHT 传感器类型,该值固定为SensorId.AMBIENT_LIGHT。
callback Callback<LightResponse> 回调函数,异步上报的传感器数据固定为LightResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.AMBIENT_LIGHT, function (data) {
        console.info('The ambient light intensity: ' + data.intensity);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

AMBIENT_TEMPERATURE9+

once(type: SensorId.AMBIENT_TEMPERATURE, callback: Callback<AmbientTemperatureResponse>): void

获取一次温度传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.AMBIENT_TEMPERATURE 传感器类型,该值固定为SensorId.AMBIENT_TEMPERATURE。
callback Callback<AmbientTemperatureResponse> 回调函数,异步上报的传感器数据固定为AmbientTemperatureResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.AMBIENT_TEMPERATURE, function (data) {
        console.info('Temperature: ' + data.temperature);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

BAROMETER9+

once(type: SensorId.BAROMETER, callback: Callback<BarometerResponse>): void

获取一次气压计传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.BAROMETER 传感器类型,该值固定为SensorId.BAROMETER。
callback Callback<BarometerResponse> 回调函数,异步上报的传感器数据固定为BarometerResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function (data) {
        console.info('Atmospheric pressure: ' + data.pressure);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GRAVITY9+

once(type: SensorId.GRAVITY, callback: Callback<GravityResponse>): void

获取一次重力传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GRAVITY 传感器类型,该值固定为SensorId.GRAVITY。
callback Callback<GravityResponse> 回调函数,异步上报的传感器数据固定为GravityResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.GRAVITY, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GYROSCOPE9+

once(type: SensorId.GYROSCOPE, callback: Callback<GyroscopeResponse>): void

获取一次陀螺仪传感器数据。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GYROSCOPE 传感器类型,该值固定为SensorId.GYROSCOPE。
callback Callback<GyroscopeResponse> 回调函数,异步上报的传感器数据固定为GyroscopeResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.GYROSCOPE, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GYROSCOPE_UNCALIBRATED9+

once(type: SensorId.GYROSCOPE_UNCALIBRATED, callback: Callback<GyroscopeUncalibratedResponse>): void

获取一次未校准陀螺仪传感器数据。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GYROSCOPE_UNCALIBRATED 传感器类型,该值固定为SensorId.GYROSCOPE_UNCALIBRATED。
callback Callback<GyroscopeUncalibratedResponse> 回调函数,异步上报的传感器数据固定为GyroscopeUncalibratedResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.GYROSCOPE_UNCALIBRATED, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('X-coordinate bias: ' + data.biasX);
        console.info('Y-coordinate bias: ' + data.biasY);
        console.info('Z-coordinate bias: ' + data.biasZ);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HALL9+

once(type: SensorId.HALL, callback: Callback<HallResponse>): void

获取霍尔传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HALL 传感器类型,该值固定为SensorId.HALL。
callback Callback<HallResponse> 回调函数,异步上报的传感器数据固定为HallResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.HALL, function (data) {
        console.info('Status: ' + data.status);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HEART_RATE9+

once(type: SensorId.HEART_RATE, callback: Callback<HeartRateResponse>): void

获取一次心率传感器数据。

需要权限:ohos.permission.READ_HEALTH_DATA

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HEART_RATE 传感器类型,该值固定为SensorId.HEART_RATE。
callback Callback<HeartRateResponse> 回调函数,异步上报的传感器数据固定为HeartRateResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.HEART_RATE, function (data) {
        console.info('Heart rate: ' + data.heartRate);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HUMIDITY9+

once(type: SensorId.HUMIDITY, callback: Callback<HumidityResponse>): void

获取一次湿度传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HUMIDITY 传感器类型,该值固定为SensorId.HUMIDITY。
callback Callback<HumidityResponse> 回调函数,异步上报的传感器数据固定为HumidityResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.HUMIDITY, function (data) {
        console.info('Humidity: ' + data.humidity);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

LINEAR_ACCELEROMETER9+

once(type: SensorId.LINEAR_ACCELEROMETER, callback: Callback<LinearAccelerometerResponse>): void

获取一次线性加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.LINEAR_ACCELEROMETER 传感器类型,该值固定为SensorId.LINEAR_ACCELEROMETER。
callback Callback<LinearAccelerometerResponse> 回调函数,异步上报的传感器数据固定为LinearAccelerometerResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.LINEAR_ACCELEROMETER, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

MAGNETIC_FIELD9+

once(type: SensorId.MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>): void

获取一次磁场传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.MAGNETIC_FIELD 传感器类型,该值固定为SensorId.MAGNETIC_FIELD。
callback Callback<MagneticFieldResponse> 回调函数,异步上报的传感器数据固定为MagneticFieldResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.MAGNETIC_FIELD, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

MAGNETIC_FIELD_UNCALIBRATED9+

once(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback: Callback<MagneticFieldUncalibratedResponse>): void

获取一次未经校准的磁场传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.MAGNETIC_FIELD_UNCALIBRATED 传感器类型,该值固定为SensorId.MAGNETIC_FIELD_UNCALIBRATED。
callback Callback<MagneticFieldUncalibratedResponse> 回调函数,异步上报的传感器数据固定为MagneticFieldUncalibratedResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('X-coordinate bias: ' + data.biasX);
        console.info('Y-coordinate bias: ' + data.biasY);
        console.info('Z-coordinate bias: ' + data.biasZ);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ORIENTATION9+

once(type: SensorId.ORIENTATION, callback: Callback<OrientationResponse>): void

获取一次方向传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ORIENTATION 传感器类型,该值固定为SensorId.ORIENTATION。
callback Callback<OrientationResponse> 回调函数,异步上报的传感器数据固定为OrientationResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.ORIENTATION, function (data) {
        console.info('The device rotates at an angle around the X axis: ' + data.beta);
        console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
        console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PEDOMETER9+

once(type: SensorId.PEDOMETER, callback: Callback<PedometerResponse>): void

获取一次计步器传感器数据。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PEDOMETER 传感器类型,该值固定为SensorId.PEDOMETER。
callback Callback<PedometerResponse> 回调函数,异步上报的传感器数据固定为PedometerResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.PEDOMETER, function (data) {
        console.info('Step count: ' + data.steps);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PEDOMETER_DETECTION9+

once(type: SensorId.PEDOMETER_DETECTION, callback: Callback<PedometerDetectionResponse>): void

获取一次计步检测器传感器数据。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PEDOMETER_DETECTION 传感器类型,该值固定为SensorId.PEDOMETER_DETECTION。
callback Callback<PedometerDetectionResponse> 回调函数,异步上报的传感器数据固定为PedometerDetectionResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.PEDOMETER_DETECTION, function (data) {
        console.info('Scalar data: ' + data.scalar);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PROXIMITY9+

once(type: SensorId.PROXIMITY, callback: Callback<ProximityResponse>): void

获取一次接近光传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PROXIMITY 传感器类型,该值固定为SensorId.PROXIMITY。
callback Callback<ProximityResponse> 回调函数,异步上报的传感器数据固定为ProximityResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.PROXIMITY, function (data) {
        console.info('Distance: ' + data.distance);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ROTATION_VECTOR9+

once(type: SensorId.ROTATION_VECTOR, callback: Callback<RotationVectorResponse>): void

获取一次旋转矢量传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ROTATION_VECTOR 传感器类型,该值固定为SensorId.ROTATION_VECTOR。
callback Callback<RotationVectorResponse> 回调函数,异步上报的传感器数据固定为RotationVectorResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.ROTATION_VECTOR, function (data) {
        console.info('X-coordinate component: ' + data.x);
        console.info('Y-coordinate component: ' + data.y);
        console.info('Z-coordinate component: ' + data.z);
        console.info('Scalar quantity: ' + data.w);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

SIGNIFICANT_MOTION9+

once(type: SensorId.SIGNIFICANT_MOTION, callback: Callback<SignificantMotionResponse>): void

获取一次大幅动作检测传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.SIGNIFICANT_MOTION 传感器类型,该值固定为SensorId.SIGNIFICANT_MOTION。
callback Callback<SignificantMotionResponse> 回调函数,异步上报的传感器数据固定为SignificantMotionResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.SIGNIFICANT_MOTION, function (data) {
        console.info('Scalar data: ' + data.scalar);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

WEAR_DETECTION9+

once(type: SensorId.WEAR_DETECTION, callback: Callback<WearDetectionResponse>): void

获取一次佩戴检测传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.WEAR_DETECTION 传感器类型,该值固定为SensorId.WEAR_DETECTION。
callback Callback<WearDetectionResponse> 回调函数,异步上报的传感器数据固定为WearDetectionResponse。

错误码

以下错误码的详细介绍请参见 ohos.sensor(传感器)错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.once(sensor.SensorId.WEAR_DETECTION, function (data) {
        console.info("Wear status: " + data.value);
    });
} catch (err) {
    console.error('Once fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

sensor.off9+

ACCELEROMETER9+

off(type: SensorId.ACCELEROMETER, callback?: Callback<AccelerometerResponse>): void

取消订阅加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ACCELEROMETER 传感器类型,该值固定为SensorId.ACCELEROMETER。
callback Callback<AccelerometerResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.ACCELEROMETER, callback1);
    sensor.on(sensor.SensorId.ACCELEROMETER, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.ACCELEROMETER, callback1);
    // 取消SensorId.ACCELEROMETER类型的所有回调
    sensor.off(sensor.SensorId.ACCELEROMETER);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ACCELEROMETER_UNCALIBRATED9+

off(type: SensorId.ACCELEROMETER_UNCALIBRATED, callback?: Callback<AccelerometerUncalibratedResponse>): void

取消订阅未校准加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ACCELEROMETER_UNCALIBRATED 传感器类型,该值固定为SensorId.ACCELEROMETER_UNCALIBRATED。
callback Callback<AccelerometerUncalibratedResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, callback1);
    sensor.on(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.ACCELEROMETER_UNCALIBRATED, callback1);
    // 取消注册SensorId.ACCELEROMETER_UNCALIBRATED类型的所有回调
    sensor.off(sensor.SensorId.ACCELEROMETER_UNCALIBRATED);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

AMBIENT_LIGHT9+

off(type: SensorId.AMBIENT_LIGHT, callback?: Callback<LightResponse>): void

取消订阅环境光传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.AMBIENT_LIGHT 传感器类型,该值固定为SensorId.AMBIENT_LIGHT。
callback Callback<LightResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.AMBIENT_LIGHT, callback1);
    sensor.on(sensor.SensorId.AMBIENT_LIGHT, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.AMBIENT_LIGHT, callback1);
    // 取消注册SensorId.AMBIENT_LIGHT的所有回调
    sensor.off(sensor.SensorId.AMBIENT_LIGHT);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

AMBIENT_TEMPERATURE9+

off(type: SensorId.AMBIENT_TEMPERATURE, callback?: Callback<AmbientTemperatureResponse>): void

取消订阅温度传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.AMBIENT_TEMPERATURE 传感器类型,该值固定为SensorId.AMBIENT_TEMPERATURE。
callback Callback<AmbientTemperatureResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, callback1);
    sensor.on(sensor.SensorId.AMBIENT_TEMPERATURE, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.AMBIENT_TEMPERATURE, callback1);
    // 取消注册SensorId.AMBIENT_TEMPERATURE的所有回调
    sensor.off(sensor.SensorId.AMBIENT_TEMPERATURE);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

BAROMETER9+

off(type: SensorId.BAROMETER, callback?: Callback<BarometerResponse>): void

取消订阅气压计传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.BAROMETER 传感器类型,该值固定为SensorId.BAROMETER。
callback Callback<BarometerResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.BAROMETER, callback1);
    sensor.on(sensor.SensorId.BAROMETER, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.BAROMETER, callback1);
    // 取消注册SensorId.BAROMETER的所有回调
    sensor.off(sensor.SensorId.BAROMETER);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GRAVITY9+

off(type: SensorId.GRAVITY, callback?: Callback<GravityResponse>): void

取消订阅重力传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GRAVITY 传感器类型,该值固定为SensorId.GRAVITY。
callback Callback<GravityResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.GRAVITY, callback1);
    sensor.on(sensor.SensorId.GRAVITY, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.GRAVITY, callback1);
    // 取消注册SensorId.GRAVITY的所有回调
    sensor.off(sensor.SensorId.GRAVITY);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GYROSCOPE9+

off(type: SensorId.GYROSCOPE, callback?: Callback<GyroscopeResponse>): void

取消订阅陀螺仪传感器数据。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GYROSCOPE 传感器类型,该值固定为SensorId.GYROSCOPE。
callback Callback<GyroscopeResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.GYROSCOPE, callback1);
    sensor.on(sensor.SensorId.GYROSCOPE, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.GYROSCOPE, callback1);
    // 取消注册SensorId.GYROSCOPE的所有回调
    sensor.off(sensor.SensorId.GYROSCOPE);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

GYROSCOPE_UNCALIBRATED9+

off(type: SensorId.GYROSCOPE_UNCALIBRATED, callback?: Callback<GyroscopeUncalibratedResponse>): void

取消订阅未校准陀螺仪传感器数据。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.GYROSCOPE_UNCALIBRATED 传感器类型,该值固定为SensorId.GYROSCOPE_UNCALIBRATED。
callback Callback<GyroscopeUncalibratedResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, callback1);
    sensor.on(sensor.SensorId.GYROSCOPE_UNCALIBRATED, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.GYROSCOPE_UNCALIBRATED, callback1);
    // 取消注册SensorId.GYROSCOPE_UNCALIBRATED的所有回调
    sensor.off(sensor.SensorId.GYROSCOPE_UNCALIBRATED);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HALL9+

off(type: SensorId.HALL, callback?: Callback<HallResponse>): void

取消订阅霍尔传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HALL 传感器类型,该值固定为SensorId.HALL。
callback Callback<HallResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.HALL, callback1);
    sensor.on(sensor.SensorId.HALL, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.HALL, callback1);
    // 取消注册SensorId.HALL的所有回调
    sensor.off(sensor.SensorId.HALL);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HEART_RATE9+

off(type: SensorId.HEART_RATE, callback?: Callback<HeartRateResponse>): void

取消订阅心率传感器数据。

需要权限:ohos.permission.READ_HEALTH_DATA

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HEART_RATE 传感器类型,该值固定为SensorId.HEART_RATE。
callback Callback<HeartRateResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.HEART_RATE, callback1);
    sensor.on(sensor.SensorId.HEART_RATE, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.HEART_RATE, callback1);
    // 取消注册SensorId.HEART_RATE的所有回调
    sensor.off(sensor.SensorId.HEART_RATE);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

HUMIDITY9+

off(type: SensorId.HUMIDITY, callback?: Callback<HumidityResponse>): void

取消订阅湿度传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.HUMIDITY 传感器类型,该值固定为SensorId.HUMIDITY。
callback Callback<HumidityResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.HUMIDITY, callback1);
    sensor.on(sensor.SensorId.HUMIDITY, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.HUMIDITY, callback1);
    // 取消注册SensorId.HUMIDITY的所有回调
    sensor.off(sensor.SensorId.HUMIDITY);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

LINEAR_ACCELEROMETER9+

off(type: SensorId.LINEAR_ACCELEROMETER, callback?: Callback<LinearAccelerometerResponse>): void

取消订阅线性加速度传感器数据。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.LINEAR_ACCELEROMETER 传感器类型,该值固定为SensorId.LINEAR_ACCELERATION。
callback Callback<LinearAccelerometerResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, callback1);
    sensor.on(sensor.SensorId.LINEAR_ACCELEROMETER, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.LINEAR_ACCELEROMETER, callback1);
    // 取消注册SensorId.LINEAR_ACCELEROMETER的所有回调
    sensor.off(sensor.SensorId.LINEAR_ACCELEROMETER);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

MAGNETIC_FIELD9+

off(type: SensorId.MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse>): void

取消订阅磁场传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.MAGNETIC_FIELD 传感器类型,该值固定为SensorId.MAGNETIC_FIELD。
callback Callback<MagneticFieldResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.MAGNETIC_FIELD, callback1);
    sensor.on(sensor.SensorId.MAGNETIC_FIELD, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.MAGNETIC_FIELD, callback1);
    // 取消注册SensorId.MAGNETIC_FIELD的所有回调
    sensor.off(sensor.SensorId.MAGNETIC_FIELD);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

MAGNETIC_FIELD_UNCALIBRATED9+

off(type: SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback<MagneticFieldUncalibratedResponse>): void

取消订阅未校准的磁场传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.MAGNETIC_FIELD_UNCALIBRATED 传感器类型,该值固定为SensorId.MAGNETIC_FIELD_UNCALIBRATED。
callback Callback<MagneticFieldUncalibratedResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback1);
    sensor.on(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED, callback1);
    // 取消注册SensorId.MAGNETIC_FIELD_UNCALIBRATED的所有回调
    sensor.off(sensor.SensorId.MAGNETIC_FIELD_UNCALIBRATED);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ORIENTATION9+

off(type: SensorId.ORIENTATION, callback?: Callback<OrientationResponse>): void

取消订阅方向传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ORIENTATION 传感器类型,该值固定为SensorId.ORIENTATION。
callback Callback<OrientationResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.ORIENTATION, callback1);
    sensor.on(sensor.SensorId.ORIENTATION, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.ORIENTATION, callback1);
    // 取消注册SensorId.ORIENTATION的所有回调
    sensor.off(sensor.SensorId.ORIENTATION);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PEDOMETER9+

off(type: SensorId.PEDOMETER, callback?: Callback<PedometerResponse>): void

取消订阅计步器传感器数据。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PEDOMETER 传感器类型,该值固定为SensorId.PEDOMETER。
callback Callback<PedometerResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.PEDOMETER, callback1);
    sensor.on(sensor.SensorId.PEDOMETER, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.PEDOMETER, callback1);
    // 取消注册SensorId.PEDOMETER的所有回调
    sensor.off(sensor.SensorId.PEDOMETER);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PEDOMETER_DETECTION9+

off(type: SensorId.PEDOMETER_DETECTION, callback?: Callback<PedometerDetectionResponse>): void

取消订阅计步检测器传感器数据。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PEDOMETER_DETECTION 传感器类型,该值固定为SensorId.PEDOMETER_DETECTION。
callback Callback<PedometerDetectionResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.PEDOMETER_DETECTION, callback1);
    sensor.on(sensor.SensorId.PEDOMETER_DETECTION, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.PEDOMETER_DETECTION, callback1);
    // 取消注册SensorId.PEDOMETER_DETECTION的所有回调
    sensor.off(sensor.SensorId.PEDOMETER_DETECTION);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

PROXIMITY9+

off(type: SensorId.PROXIMITY, callback?: Callback<ProximityResponse>): void

取消订阅接近光传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.PROXIMITY 传感器类型,该值固定为SensorId.PROXIMITY。
callback Callback<ProximityResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.PROXIMITY, callback1);
    sensor.on(sensor.SensorId.PROXIMITY, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.PROXIMITY, callback1);
    // 取消注册SensorId.PROXIMITY的所有回调
    sensor.off(sensor.SensorId.PROXIMITY);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

ROTATION_VECTOR9+

off(type: SensorId.ROTATION_VECTOR, callback?: Callback<RotationVectorResponse>): void

取消订阅旋转矢量传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.ROTATION_VECTOR 传感器类型,该值固定为SensorId.ROTATION_VECTOR。
callback Callback<RotationVectorResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.ROTATION_VECTOR, callback1);
    sensor.on(sensor.SensorId.ROTATION_VECTOR, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.ROTATION_VECTOR, callback1);
    // 取消注册SensorId.ROTATION_VECTOR的所有回调
    sensor.off(sensor.SensorId.ROTATION_VECTOR);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

SIGNIFICANT_MOTION9+

off(type: SensorId.SIGNIFICANT_MOTION, callback?: Callback<SignificantMotionResponse>): void

取消大幅动作检测传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.SIGNIFICANT_MOTION 传感器类型,该值固定为SensorId.SIGNIFICANT_MOTION。
callback Callback<SignificantMotionResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, callback1);
    sensor.on(sensor.SensorId.SIGNIFICANT_MOTION, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.SIGNIFICANT_MOTION, callback1);
    // 取消注册SensorId.SIGNIFICANT_MOTION的所有回调
    sensor.off(sensor.SensorId.SIGNIFICANT_MOTION);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

WEAR_DETECTION9+

off(type: SensorId.WEAR_DETECTION, callback?: Callback<WearDetectionResponse>): void

取消订阅佩戴检测传感器数据。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId.WEAR_DETECTION 传感器类型,该值固定为SensorId.WEAR_DETECTION。
callback Callback<WearDetectionResponse> 需要取消订阅的回调函数,若无此参数,则取消订阅当前类型的所有回调函数。

示例:

function callback1(data) {
    console.info('Callback1 data: ' + JSON.stringify(data));
}
function callback2(data) {
    console.info('Callback2 data: ' + JSON.stringify(data));
}
try {
    sensor.on(sensor.SensorId.WEAR_DETECTION, callback1);
    sensor.on(sensor.SensorId.WEAR_DETECTION, callback2);
    // 仅取消callback1的注册
    sensor.off(sensor.SensorId.WEAR_DETECTION, callback1);
    // 取消注册SensorId.WEAR_DETECTION的所有回调
    sensor.off(sensor.SensorId.WEAR_DETECTION);
} catch (err) {
    console.error('Off fail, errCode: ' + err.code + ' ,msg: ' + err.message);
}

sensor.getGeomagneticInfo9+

getGeomagneticInfo(locationOptions: LocationOptions, timeMillis: number, callback: AsyncCallback<GeomagneticResponse>): void

获取某时刻地球上特定位置的地磁场信息。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
locationOptions LocationOptions 地理位置,包括经度、纬度和海拔高度。
timeMillis number 获取磁偏角的时间,unix时间戳,单位毫秒。
callback AsyncCallback<GeomagneticResponse> 回调函数,返回地磁场信息。

错误码

以下错误码的详细介绍请参见 sensor.getGeomagneticInfo错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.getGeomagneticInfo({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000, function (err, data) {
        if (err) {
            console.error('Get geomagneticInfo failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        console.info("GeomagneticInfo x" + data.x);
        console.info("GeomagneticInfo y" + data.y);
        console.info("GeomagneticInfo z" + data.z);
        console.info("GeomagneticInfo geomagneticDip" + data.geomagneticDip);
        console.info("GeomagneticInfo deflectionAngle" + data.deflectionAngle);
        console.info("GeomagneticInfo levelIntensity" + data.levelIntensity);
        console.info("GeomagneticInfo totalIntensity" + data.totalIntensity);
    });
} catch (err) {
    console.error('Get geomagneticInfo failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getGeomagneticInfo9+

getGeomagneticInfo(locationOptions: LocationOptions, timeMillis: number): Promise<GeomagneticResponse>

获取某时刻地球上特定位置的地磁场信息。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
locationOptions LocationOptions 地理位置,包括经度、纬度和海拔高度。
timeMillis number 获取磁偏角的时间,unix时间戳,单位毫秒。

返回值:

类型 说明
Promise<GeomagneticResponse> Promise对象,返回地磁场信息。

错误码

以下错误码的详细介绍请参见 sensor.getGeomagneticInfo错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    const promise = sensor.getGeomagneticInfo({ latitude: 80, longitude: 0, altitude: 0 }, 1580486400000);
    promise.then((data) => {
        console.info("GeomagneticInfo x" + data.x);
        console.info("GeomagneticInfo y" + data.y);
        console.info("GeomagneticInfo z" + data.z);
        console.info("GeomagneticInfo geomagneticDip" + data.geomagneticDip);
        console.info("GeomagneticInfo deflectionAngle" + data.deflectionAngle);
        console.info("GeomagneticInfo levelIntensity" + data.levelIntensity);
        console.info("GeomagneticInfo totalIntensity" + data.totalIntensity);
    }, (err)=>{
        console.error('Get geomagneticInfo failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get geomagneticInfo. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getDeviceAltitude9+

getDeviceAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallback<number>): void

根据气压值获取海拔高度。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
seaPressure number 海平面气压值,单位为hPa。
currentPressure number 指定的气压值,单位为hPa。
callback AsyncCallback<number> 回调函数,返回指定的气压值对应的海拔高度,单位为米。

错误码

以下错误码的详细介绍请参见 sensor.getDeviceAltitude错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let seaPressure = 1013.2;
    let currentPressure = 1500.0;
    sensor.getDeviceAltitude(seaPressure, currentPressure, function (err, data) {
        if (err) {
            console.error('Get altitude failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        console.info('altitude: ' + data);
    });
} catch (err) {
    console.error('Get altitude failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getDeviceAltitude9+

getDeviceAltitude(seaPressure: number, currentPressure: number): Promise<number>

根据气压值获取海拔高度。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
seaPressure number 海平面气压值,单位为hPa。
currentPressure number 指定的气压值,单位为hPa。

返回值:

类型 说明
Promise<number> Promise对象,返回指定的气压值对应的海拔高度,单位为米。

错误码

以下错误码的详细介绍请参见 sensor.getDeviceAltitude错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let seaPressure = 1013.2;
    let currentPressure = 1500.0;
    const promise = sensor.getDeviceAltitude(seaPressure, currentPressure);
    promise.then((data) => {
        console.info('sensor_getDeviceAltitude_Promise success', data);
    }, (err) => {
        console.error('Get altitude failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get altitude failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getInclination9+

getInclination(inclinationMatrix: Array<number>, callback: AsyncCallback<number>): void

根据倾斜矩阵计算地磁倾角。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inclinationMatrix Array<number> 倾斜矩阵。
callback AsyncCallback<number> 回调函数,返回地磁倾角,单位为弧度。

错误码

以下错误码的详细介绍请参见 sensor.getInclination错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    // inclinationMatrix可以为3*3,或者4*4
    let inclinationMatrix = [
        1, 0, 0,
        0, 1, 0,
        0, 0, 1
    ]
    sensor.getInclination(inclinationMatrix, function (err, data) {
        if (err) {
            console.error('Get inclination failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        console.info('Inclination: ' + data);
    })
} catch (err) {
    console.error('Get inclination failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getInclination9+

getInclination(inclinationMatrix: Array<number>): Promise<number>

根据倾斜矩阵计算地磁倾角。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inclinationMatrix Array<number> 倾斜矩阵。

返回值:

类型 说明
Promise<number> Promise对象,返回地磁倾斜角,单位为弧度。

错误码

以下错误码的详细介绍请参见 sensor.getInclination错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    // inclinationMatrix可以为3*3,或者4*4
    let inclinationMatrix = [
        1, 0, 0,
        0, 1, 0,
        0, 0, 1
    ]
    const promise = sensor.getInclination(inclinationMatrix);
    promise.then((data) => {
        console.info('Inclination: ' + data);
    }, (err) => {
        console.error('Get inclination failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get inclination failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getAngleVariation9+

getAngleVariation(currentRotationMatrix: Array<number>, preRotationMatrix: Array<number>, callback: AsyncCallback<Array<number>>): void

计算两个旋转矩阵之间的角度变化。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
currentRotationMatrix Array<number> 当前旋转矩阵。
preRotationMatrix Array<number> 相对旋转矩阵。
callback AsyncCallback<Array<number>> 回调函数,返回绕z、x、y轴方向的旋转角度。

错误码

以下错误码的详细介绍请参见 sensor.getAngleVariation错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    // 旋转矩阵可以为3*3,或者4*4
    let currentRotationMatrix = [
        1, 0, 0,
        0, 1, 0,
        0, 0, 1
    ];
    let preRotationMatrix = [
        1, 0, 0,
        0, 0.87, -0.50,
        0, 0.50, 0.87
    ];
    sensor.getAngleVariation(currentRotationMatrix, preRotationMatrix, function (err, data) {
        if (err) {
            console.error('Get angle variation failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        if (data.length < 3) {
            console.error("Get angle variation failed, length" + data.length);
        }
        console.info("Z: " + data[0]);
        console.info("X: " + data[1]);
        console.info("Y  : " + data[2]);
    })
} catch (err) {
    console.error('Get angle variation failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getAngleVariation9+

getAngleVariation(currentRotationMatrix: Array<number>, preRotationMatrix: Array<number>): Promise<Array<number>>

得到两个旋转矩阵之间的角度变化。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
currentRotationMatrix Array<number> 当前旋转矩阵。
preRotationMatrix Array<number> 相对旋转矩阵

返回值:

类型 说明
Promise<Array<number>> Promise对象,返回绕z、x、y轴方向的旋转角度。

错误码

以下错误码的详细介绍请参见 sensor.getAngleVariation错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    // 旋转矩阵可以为3*3,或者4*4
    let currentRotationMatrix = [
        1, 0, 0,
        0, 1, 0,
        0, 0, 1
    ];
    let preRotationMatrix = [
        1, 0, 0,
        0, 0.87, -0.50,
        0, 0.50, 0.87
    ];
    const promise = sensor.getAngleVariation(currentRotationMatrix, preRotationMatrix);
    promise.then((data) => {
        if (data.length < 3) {
            console.error("Get angle variation failed, length" + data.length);
        }
        console.info("Z: " + data[0]);
        console.info("X: " + data[1]);
        console.info("Y  : " + data[2]);
    }, (err) => {
        console.error('Get angle variation failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get angle variation failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getRotationMatrix9+

getRotationMatrix(rotationVector: Array<number>, callback: AsyncCallback<Array<number>>): void

根据旋转矢量获取旋转矩阵。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 旋转矢量。
callback AsyncCallback<Array<number>> 回调函数,返回3*3旋转矩阵。

错误码

以下错误码的详细介绍请参见 sensor.getRotationMatrix错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
    sensor.getRotationMatrix(rotationVector, function (err, data) {
        if (err) {
            console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + data[i]);
        }
    })
} catch (err) {
    console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getRotationMatrix9+

getRotationMatrix(rotationVector: Array<number>): Promise<Array<number>>

根据旋转矢量获取旋转矩阵。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 旋转矢量。

返回值:

类型 说明
Promise<Array<number>> Promise对象,返回旋转矩阵。

错误码

以下错误码的详细介绍请参见 sensor.getRotationMatrix错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
    const promise = sensor.getRotationMatrix(rotationVector);
    promise.then((data) => {
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + data[i]);
        }
    }, (err) => {
        console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.transformRotationMatrix9+

transformRotationMatrix(inRotationVector: Array<number>, coordinates: CoordinatesOptions, callback: AsyncCallback<Array<number>>): void

根据指定坐标系映射旋转矩阵。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inRotationVector Array<number> 旋转矩阵。
coordinates CoordinatesOptions 指定坐标系方向。
callback AsyncCallback<Array<number>> 回调函数,返回映射后的旋转矩阵。

错误码

以下错误码的详细介绍请参见 sensor.transformRotationMatrix错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let rotationMatrix = [
        1, 0, 0,
        0, 0.87, -0.50,
        0, 0.50, 0.87
    ];
    sensor.transformRotationMatrix(rotationMatrix, { x: 1, y: 3 }, function (err, data) {
        if (err) {
            console.error('Transform rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + '] = ' + data[i]);
        }
    })
} catch (err) {
    console.error('Transform rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.transformRotationMatrix9+

transformRotationMatrix(inRotationVector: Array<number>, coordinates: CoordinatesOptions): Promise<Array<number>>

根据指定坐标系映射旋转矩阵。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inRotationVector Array<number> 旋转矩阵。
coordinates CoordinatesOptions 指定坐标系方向。

返回值:

类型 说明
Promise<Array<number>> Promise对象,返回转换后的旋转矩阵。

错误码

以下错误码的详细介绍请参见 sensor.transformRotationMatrix错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let rotationMatrix = [
        1, 0, 0,
        0, 0.87, -0.50,
        0, 0.50, 0.87
    ];
    const promise = sensor.transformRotationMatrix(rotationMatrix, { x: 1, y: 3 });
    promise.then((data) => {
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + data[i]);
        }
    }, (err) => {
        console.error('Transform rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Transform rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getQuaternion9+

getQuaternion(rotationVector: Array<number>, callback: AsyncCallback<Array<number>>): void

根据旋转向量计算归一化四元数。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 旋转矢量。
callback AsyncCallback<Array<number>> 回调函数,返回归一化四元数。

错误码

以下错误码的详细介绍请参见 sensor.getQuaternion错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
    sensor.getQuaternion(rotationVector, function (err, data) {
        if (err) {
            console.error('Get quaternion failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + data[i]);
        }
    })
} catch (err) {
    console.error('Get quaternion failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getQuaternion9+

getQuaternion(rotationVector: Array<number>): Promise<Array<number>>

根据旋转向量计算归一化四元数。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 旋转矢量。

返回值:

类型 说明
Promise<Array<number>> Promise,对象返归一化回四元数。

错误码

以下错误码的详细介绍请参见 sensor.getQuaternion错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let rotationVector = [0.20046076, 0.21907, 0.73978853, 0.60376877];
    const promise = sensor.getQuaternion(rotationVector);
    promise.then((data) => {
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + data[i]);
        }
    }, (err) => {
        console.error('Get quaternion failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get quaternion failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getOrientation9+

getOrientation(rotationMatrix: Array<number>, callback: AsyncCallback<Array<number>>): void

根据旋转矩阵计算设备方向。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationMatrix Array<number> 旋转矩阵。
callback AsyncCallback<Array<number>> 回调函数,返回围绕z、x、y轴方向的旋转角度。

错误码

以下错误码的详细介绍请参见 sensor.getOrientation错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let preRotationMatrix = [
        1, 0, 0,
        0, 0.87, -0.50,
        0, 0.50, 0.87
    ];
    sensor.getOrientation(preRotationMatrix, function (err, data) {
        if (err) {
            console.error('Get orientation failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        if (data.length < 3) {
            console.error("Get orientation failed, length" + data.length);
        }
        console.info("Z: " + data[0]);
        console.info("X: " + data[1]);
        console.info("Y  : " + data[2]);
    })
} catch (err) {
    console.error('Get orientation failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getOrientation9+

getOrientation(rotationMatrix: Array<number>): Promise<Array<number>>

根据旋转矩阵计算设备的方向。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationMatrix Array<number> 旋转矩阵。

返回值:

类型 说明
Promise<Array<number>> Promise对象,返回围绕z、x、y轴方向的旋转角度。

错误码

以下错误码的详细介绍请参见 sensor.getOrientation错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let preRotationMatrix = [
        1, 0, 0,
        0, 0.87, -0.50,
        0, 0.50, 0.87
    ];
    const promise = sensor.getOrientation(preRotationMatrix);
    promise.then((data) => {
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + data[i]);
        }
    }, (err) => {
        console.error('getOrientation failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('getOrientation failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getRotationMatrix9+

getRotationMatrix(gravity: Array<number>, geomagnetic: Array<number>, callback: AsyncCallback<RotationMatrixResponse>): void

根据重力矢量和地磁矢量计算旋转矩阵。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
gravity Array<number> 重力矢量。
geomagnetic Array<number> 地磁矢量。
callback AsyncCallback<RotationMatrixResponse> 回调函数,返回旋转矩阵。

错误码

以下错误码的详细介绍请参见 sensor.getRotationMatrix错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let gravity = [-0.27775216, 0.5351276, 9.788099];
    let geomagnetic = [210.87253, -78.6096, -111.44444];
    sensor.getRotationMatrix(gravity, geomagnetic, function (err, data) {
        if (err) {
            console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        console.info('RotationMatrix' + JSON.stringify(data));
    })
} catch (err) {
    console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getRotationMatrix9+

getRotationMatrix(gravity: Array<number>, geomagnetic: Array<number>): Promise<RotationMatrixResponse>

根据重力矢量和地磁矢量计算旋转矩阵。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
gravity Array<number> 重力向量。
geomagnetic Array<number> 地磁矢量。

返回值:

类型 说明
Promise<RotationMatrixResponse> Promise对象,返回旋转矩阵。

错误码

以下错误码的详细介绍请参见 sensor.getRotationMatrix错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    let gravity = [-0.27775216, 0.5351276, 9.788099];
    let geomagnetic = [210.87253, -78.6096, -111.44444];
    const promise = sensor.getRotationMatrix(gravity, geomagnetic);
    promise.then((data) => {
        console.info('RotationMatrix' + JSON.stringify(data));
    }, (err) => {
        console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get rotationMatrix failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getSensorList9+

getSensorList(callback: AsyncCallback<Array<Sensor>>): void

获取设备上的所有传感器信息。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
callback AsyncCallback<Array<Sensor>> 回调函数,返回传感器属性列表。

错误码

以下错误码的详细介绍请参见 sensor.getSensorList错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.getSensorList((err, data) => {
        if (err) {
            console.error('Get sensorList failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + JSON.stringify(data[i]));
        }
    });
} catch (err) {
    console.error('Get sensorList failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getSensorList9+

getSensorList(): Promise<Array<Sensor>>

获取设备上的所有传感器信息。

系统能力:SystemCapability.Sensors.Sensor

返回值:

参数名 类型 必填 说明
promise Promise<Array<Sensor>> Promise对象,返回传感器属性列表。

错误码

以下错误码的详细介绍请参见 sensor.getSensorList错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.getSensorList().then((data) => {
        for (var i = 0; i < data.length; i++) {
            console.info('data[' + i + ']: ' + JSON.stringify(data[i]));
        }
    }, (err) => {
        console.error('Get sensorList failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get sensorList failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getSingleSensor9+

getSingleSensor(type: SensorId, callback: AsyncCallback<Sensor>): void

获取指定传感器类型的属性信息。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId 指定传感器类型。
callback AsyncCallback<Sensor> 回调函数,返回指定传感器的属性信息。

错误码

以下错误码的详细介绍请参见 sensor.getSingleSensor错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER, (err, data) => {
        if (err) {
            console.error('Get singleSensor failed. Error code: ' + err.code + '; message: ' + err.message);
            return;
        }
        console.info('Sensor: ' + JSON.stringify(data));
    });
} catch (err) {
    console.error('Get singleSensor failed. Error code: ' + err.code + '; message: ' + err.message);
}

sensor.getSingleSensor9+

getSingleSensor(type: SensorId): Promise<Sensor>

获取指定类型的传感器信息。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorId 传感器类型。

返回值:

参数名 类型 必填 说明
promise Promise<Sensor> 返回传感器信息。

错误码

以下错误码的详细介绍请参见 sensor.getSingleSensor错误码

错误码ID 错误信息
14500101 Service exception.

示例:

try {
    sensor.getSingleSensor(sensor.SensorId.ACCELEROMETER).then((data) => {
        console.info('Sensor: ' + JSON.stringify(data));
    }, (err) => {
        console.error('Get singleSensor failed. Error code: ' + err.code + '; message: ' + err.message);
    });
} catch (err) {
    console.error('Get singleSensor failed. Error code: ' + err.code + '; message: ' + err.message);
}

SensorId9+

表示要订阅或取消订阅的传感器类型。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 说明
ACCELEROMETER 1 加速度传感器。
GYROSCOPE 2 陀螺仪传感器。
AMBIENT_LIGHT 5 环境光传感器。
MAGNETIC_FIELD 6 磁场传感器。
BAROMETER 8 气压计传感器。
HALL 10 霍尔传感器。
PROXIMITY 12 接近光传感器。
HUMIDITY 13 湿度传感器。
ORIENTATION 256 方向传感器。
GRAVITY 257 重力传感器。
LINEAR_ACCELEROMETER 258 线性加速度传感器。
ROTATION_VECTOR 259 旋转矢量传感器。
AMBIENT_TEMPERATURE 260 环境温度传感器。
MAGNETIC_FIELD_UNCALIBRATED 261 未校准磁场传感器。
GYROSCOPE_UNCALIBRATED 263 未校准陀螺仪传感器。
SIGNIFICANT_MOTION 264 有效运动传感器。
PEDOMETER_DETECTION 265 计步检测传感器。
PEDOMETER 266 计步传感器。
HEART_RATE 278 心率传感器。
WEAR_DETECTION 280 佩戴检测传感器。
ACCELEROMETER_UNCALIBRATED 281 未校准加速度计传感器。

SensorType(deprecated)

表示要订阅或取消订阅的传感器类型。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 说明
SENSOR_TYPE_ID_ACCELEROMETER 1 加速度传感器。
SENSOR_TYPE_ID_GYROSCOPE 2 陀螺仪传感器。
SENSOR_TYPE_ID_AMBIENT_LIGHT 5 环境光传感器。
SENSOR_TYPE_ID_MAGNETIC_FIELD 6 磁场传感器。
SENSOR_TYPE_ID_BAROMETER 8 气压计传感器。
SENSOR_TYPE_ID_HALL 10 霍尔传感器。
SENSOR_TYPE_ID_PROXIMITY 12 接近光传感器。
SENSOR_TYPE_ID_HUMIDITY 13 湿度传感器。
SENSOR_TYPE_ID_ORIENTATION 256 方向传感器。
SENSOR_TYPE_ID_GRAVITY 257 重力传感器。
SENSOR_TYPE_ID_LINEAR_ACCELERATION 258 线性加速度传感器。
SENSOR_TYPE_ID_ROTATION_VECTOR 259 旋转矢量传感器。
SENSOR_TYPE_ID_AMBIENT_TEMPERATURE 260 环境温度传感器。
SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED 261 未校准磁场传感器。
SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED 263 未校准陀螺仪传感器。
SENSOR_TYPE_ID_SIGNIFICANT_MOTION 264 有效运动传感器。
SENSOR_TYPE_ID_PEDOMETER_DETECTION 265 计步检测传感器。
SENSOR_TYPE_ID_PEDOMETER 266 计步传感器。
SENSOR_TYPE_ID_HEART_RATE 278 心率传感器。
SENSOR_TYPE_ID_WEAR_DETECTION 280 佩戴检测传感器。
SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED 281 未校准加速度计传感器。

Response

传感器数据的时间戳。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
timestamp number 传感器数据上报的时间戳。

Sensor9+

指示传感器信息。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
sensorName string 传感器名称。
vendorName string 传感器供应商。
firmwareVersion string 传感器固件版本。
hardwareVersion string 传感器硬件版本。
sensorId number 传感器类型id。
maxRange number 传感器测量范围的最大值。
minSamplePeriod number 允许的最小采样周期。
maxSamplePeriod number 允许的最大采样周期。
precision number 传感器精度。
power number 传感器功率。

AccelerometerResponse

加速度传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 施加在设备x轴的加速度,单位 : m/s2。
y number 施加在设备y轴的加速度,单位 : m/s2。
z number 施加在设备z轴的加速度,单位 : m/s2。

LinearAccelerometerResponse

线性加速度传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 施加在设备x轴的线性加速度,单位 : m/s2。
y number 施加在设备y轴的线性加速度,单位 : m/s2。
z number 施加在设备z轴的线性加速度,单位 : m/s2。

AccelerometerUncalibratedResponse

未校准加速度计传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 施加在设备x轴未校准的加速度,单位 : m/s2。
y number 施加在设备y轴未校准的加速度,单位 : m/s2。
z number 施加在设备z轴未校准的加速度,单位 : m/s2。
biasX number 施加在设备x轴未校准的加速度偏量,单位 : m/s2。
biasY number 施加在设备上y轴未校准的加速度偏量,单位 : m/s2。
biasZ number 施加在设备z轴未校准的加速度偏量,单位 : m/s2。

GravityResponse

重力传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 施加在设备x轴的重力加速度,单位 : m/s2。
y number 施加在设备y轴的重力加速度,单位 : m/s2。
z number 施加在设备z轴的重力加速度,单位 : m/s2。

OrientationResponse

方向传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
alpha number 设备围绕Z轴的旋转角度,单位:度。
beta number 设备围绕X轴的旋转角度,单位:度。
gamma number 设备围绕Y轴的旋转角度,单位:度。

RotationVectorResponse

旋转矢量传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 旋转矢量x轴分量。
y number 旋转矢量y轴分量。
z number 旋转矢量z轴分量。
w number 标量。

GyroscopeResponse

陀螺仪传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 设备x轴的旋转角速度,单位rad/s。
y number 设备y轴的旋转角速度,单位rad/s。
z number 设备z轴的旋转角速度,单位rad/s。

GyroscopeUncalibratedResponse

未校准陀螺仪传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 设备x轴未校准的旋转角速度,单位rad/s。
y number 设备y轴未校准的旋转角速度,单位rad/s。
z number 设备z轴未校准的旋转角速度,单位rad/s。
biasX number 设备x轴未校准的旋转角速度偏量,单位rad/s。
biasY number 设备y轴未校准的旋转角速度偏量,单位rad/s。
biasZ number 设备z轴未校准的旋转角速度偏量,单位rad/s。

SignificantMotionResponse

有效运动传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
scalar number 表示剧烈运动程度。测量三个物理轴(x、y 和 z)上,设备是否存在大幅度运动;如果取值为1则代表存在大幅度运动,取值为0则代表没有大幅度运动。

ProximityResponse

接近光传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
distance number 可见物体与设备显示器的接近程度。0表示接近,1表示远离。

LightResponse

环境光传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
intensity number 光强(单位:勒克斯)。

HallResponse

霍尔传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
status number 显示霍尔状态。测量设备周围是否存在磁力吸引,0表示没有,大于0表示有。

MagneticFieldResponse

磁场传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number x轴环境磁场强度,单位 : μT。
y number y轴环境磁场强度,单位 : μT。
z number z轴环境磁场强度,单位 : μT。

MagneticFieldUncalibratedResponse

未校准磁场传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number x轴未校准环境磁场强度,单位 : μT。
y number y轴未校准环境磁场强度,单位 : μT。
z number z轴未校准环境磁场强度,单位 : μT。
biasX number x轴未校准环境磁场强度偏量,单位 : μT。
biasY number y轴未校准环境磁场强度偏量,单位 : μT。
biasZ number z轴未校准环境磁场强度偏量,单位 : μT。

PedometerResponse

计步传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
steps number 用户的行走步数。

HumidityResponse

湿度传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
humidity number 湿度值。测量环境的相对湿度,以百分比 (%) 表示。

PedometerDetectionResponse

计步检测传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
scalar number 计步器检测。检测用户的计步动作,如果取值为1则代表用户产生了计步行走的动作,取值为0则代表用户没有发生运动。

AmbientTemperatureResponse

温度传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
temperature number 环境温度(单位:摄氏度)。

BarometerResponse

气压计传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
pressure number 压力值(单位:帕斯卡)。

HeartRateResponse

心率传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
heartRate number 心率值。测量用户的心率数值,单位:bpm。

WearDetectionResponse

佩戴检测传感器数据,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
value number 表示设备是否被穿戴(1表示已穿戴,0表示未穿戴)。

Options

设置传感器上报频率。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
interval number 表示传感器的上报频率,默认值为200000000ns。

RotationMatrixResponse

设置旋转矩阵响应对象。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
rotation Array<number> 旋转矩阵。
inclination Array<number> 倾斜矩阵。

CoordinatesOptions

设置坐标选项对象。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number x坐标方向。
y number y坐标方向。

GeomagneticResponse

设置地磁响应对象,继承于Response

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
x number 地磁场的北分量。
y number 地磁场的东分量。
z number 地磁场的垂直分量。
geomagneticDip number 地磁倾角,即地球磁场线与水平面的夹角。
deflectionAngle number 地磁偏角,即地磁北方向与正北方向在水平面上的角度。
levelIntensity number 地磁场的水平强度。
totalIntensity number 地磁场的总强度。

LocationOptions

指示地理位置。

系统能力:以下各项对应的系统能力均为SystemCapability.Sensors.Sensor

名称 类型 可读 可写 说明
latitude number 纬度。
longitude number 经度。
altitude number 海拔高度。

sensor.on(deprecated)

ACCELEROMETER(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>,options?: Options): void

监听加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.ACCELEROMETER代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ACCELEROMETER 要订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。
callback Callback<AccelerometerResponse> 注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
},
    {interval: 10000000}
);

LINEAR_ACCELERATION(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>, options?: Options): void

监听线性加速度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.LINEAR_ACCELEROMETER代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION 要订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。
callback Callback<LinearAccelerometerResponse> 注册线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

ACCELEROMETER_UNCALIBRATED(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>, options?: Options): void

监听未校准加速度计传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.ACCELEROMETER_UNCALIBRATED代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED 要订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。
callback Callback<AccelerometerUncalibratedResponse> 注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
},
    {interval: 10000000}
);

GRAVITY(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>,options?: Options): void

监听重力传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.GRAVITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GRAVITY 要订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
callback Callback<GravityResponse> 注册重力传感器的回调函数,上报的数据类型为GravityResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
},
    {interval: 10000000}
);

GYROSCOPE(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>, options?: Options): void

监听陀螺仪传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.GYROSCOPE代替。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GYROSCOPE 要订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
callback Callback<GyroscopeResponse> 注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
},
    {interval: 10000000}
);

GYROSCOPE_UNCALIBRATED(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback:Callback<GyroscopeUncalibratedResponse>, options?: Options): void

监听未校准陀螺仪传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.GYROSCOPE_UNCALIBRATED代替。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED 要订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。
callback Callback<GyroscopeUncalibratedResponse> 注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。
options Options 可选参数列表,设置上报频率。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
},
    {interval: 10000000}
);

SIGNIFICANT_MOTION(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback: Callback<SignificantMotionResponse>, options?: Options): void

监听大幅动作传感器数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.SIGNIFICANT_MOTION 代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION 要订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。
callback Callback<SignificantMotionResponse> 注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,function(data){
    console.info('Scalar data: ' + data.scalar);
},
    {interval: 10000000}
);

PEDOMETER_DETECTION(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback: Callback<PedometerDetectionResponse>, options?: Options): void

监听计步检测传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.PEDOMETER_DETECTION代替。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION 要订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。
callback Callback<PedometerDetectionResponse> 注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,function(data){
    console.info('Scalar data: ' + data.scalar);
},
    {interval: 10000000}
);

PEDOMETER(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>, options?: Options): void

监听计步传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.PEDOMETER代替。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PEDOMETER 要订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
callback Callback<PedometerResponse> 注册计步传感器的回调函数,上报的数据类型为PedometerResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER,function(data){
    console.info('Steps: ' + data.steps);
},
    {interval: 10000000}
);

AMBIENT_TEMPERATURE(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback:Callback<AmbientTemperatureResponse>, options?: Options): void

监听环境温度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.AMBIENT_TEMPERATURE代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE 要订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。
callback Callback<AmbientTemperatureResponse> 注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,function(data){
    console.info('Temperature: ' + data.temperature);
},
    {interval: 10000000}
);

MAGNETIC_FIELD(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>,options?: Options): void

监听磁场传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.MAGNETIC_FIELD代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD 要订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
callback Callback<MagneticFieldResponse> 注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
},
    {interval: 10000000}
);

MAGNETIC_FIELD_UNCALIBRATED(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>, options?: Options): void

监听未校准磁场传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.MAGNETIC_FIELD_UNCALIBRATED代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED 要订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。
callback Callback<MagneticFieldUncalibratedResponse> 注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
},
    {interval: 10000000}
);

PROXIMITY(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>,options?: Options): void

监听接近光传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.PROXIMITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PROXIMITY 要订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
callback Callback<ProximityResponse> 注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY,function(data){
    console.info('Distance: ' + data.distance);
},
    {interval: 10000000}
);

HUMIDITY(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>,options?: Options): void

监听湿度传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.HUMIDITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HUMIDITY 要订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
callback Callback<HumidityResponse> 注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY,function(data){
    console.info('Humidity: ' + data.humidity);
},
    {interval: 10000000}
);

BAROMETER(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>,options?: Options): void

监听气压计传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.BAROMETER代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_BAROMETER 要订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
callback Callback<BarometerResponse> 注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER,function(data){
    console.info('Atmospheric pressure: ' + data.pressure);
},
    {interval: 10000000}
);

HALL(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>, options?: Options): void

监听霍尔传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.HALL代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HALL 要订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。
callback Callback<HallResponse> 注册霍尔传感器的回调函数,上报的数据类型为 HallResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_HALL,function(data){
    console.info('Status: ' + data.status);
},
    {interval: 10000000}
);

AMBIENT_LIGHT(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>, options?: Options): void

监听环境光传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.AMBIENT_LIGHT代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT 要订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。
callback Callback<LightResponse> 注册环境光传感器的回调函数,上报的数据类型为LightResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT,function(data){
    console.info(' Illumination: ' + data.intensity);
},
    {interval: 10000000}
);

ORIENTATION(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>, options?: Options): void

监听方向传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.ORIENTATION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ORIENTATION 要订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION
callback Callback<OrientationResponse> 注册方向传感器的回调函数,上报的数据类型为OrientationResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION,function(data){
    console.info('The device rotates at an angle around the X axis: ' + data.beta);
    console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
    console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
},
    {interval: 10000000}
);

HEART_RATE(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>, options?: Options): void

监听心率传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.on.HEART_RATE代替。

需要权限:ohos.permission.HEALTH_DATA

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HEART_RATE 要订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
callback Callback<HeartRateResponse> 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。

ROTATION_VECTOR(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,callback: Callback<RotationVectorResponse>,options?: Options): void

监听旋转矢量传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.ROTATION_VECTOR代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR 要订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。
callback Callback<RotationVectorResponse> 注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('Scalar quantity: ' + data.w);
},
    {interval: 10000000}
);

WEAR_DETECTION(deprecated)

on(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>,options?: Options): void

监听佩戴检测传感器的数据变化。如果多次调用该接口,仅最后一次调用生效。

从API version 9 开始不再维护,建议使用sensor.on.WEAR_DETECTION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_WEAR_DETECTION 要订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。
callback Callback<WearDetectionResponse> 注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。
options Options 可选参数列表,设置上报频率,默认值为200000000ns。

示例:

sensor.on(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION,function(data){
    console.info('Wear status: ' + data.value);
},
    {interval: 10000000}
);

sensor.once(deprecated)

ACCELEROMETER(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback: Callback<AccelerometerResponse>): void

监听加速度传感器的数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.ACCELEROMETER代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ACCELEROMETER 加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。
callback Callback<AccelerometerResponse> 注册一次加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER,function(data){
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
  }
);

LINEAR_ACCELERATION(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION,callback:Callback<LinearAccelerometerResponse>): void

监听线性加速度传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.LINEAR_ACCELEROMETER代替。

需要权限:ohos.permission.ACCELERATION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION 线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。
callback Callback<LinearAccelerometerResponse> 注册一次线性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。

ACCELEROMETER_UNCALIBRATED(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED,callback: Callback<AccelerometerUncalibratedResponse>): void

监听未校准加速度传感器的数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.ACCELEROMETER_UNCALIBRATED代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED 未校准加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。
callback Callback<AccelerometerUncalibratedResponse> 注册一次未校准加速度传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, function(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
  }
);

GRAVITY(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback: Callback<GravityResponse>): void

监听重力传感器的数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.GRAVITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GRAVITY 重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
callback Callback<GravityResponse> 注册一次重力传感器的回调函数,上报的数据类型为GravityResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, function(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
  }
);

GYROSCOPE(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback: Callback<GyroscopeResponse>): void

监听陀螺仪传感器的数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.GYROSCOPE代替。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GYROSCOPE 陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
callback Callback<GyroscopeResponse> 注册一次陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, function(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
  }
);

GYROSCOPE_UNCALIBRATED(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED,callback: Callback<GyroscopeUncalibratedResponse>): void

监听未校准陀螺仪传感器的数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.GYROSCOPE_UNCALIBRATED代替。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED 未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。
callback Callback<GyroscopeUncalibratedResponse> 注册一次未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, function(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
  }
);

SIGNIFICANT_MOTION(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION,callback: Callback<SignificantMotionResponse>): void

监听有效运动传感器的数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.SIGNIFICANT_MOTION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION 有效运动传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。
callback Callback<SignificantMotionResponse> 注册一次有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, function(data) {
    console.info('Scalar data: ' + data.scalar);
  }
);

PEDOMETER_DETECTION(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION,callback: Callback<PedometerDetectionResponse>): void

监听计步检测传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.PEDOMETER_DETECTION代替。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION 计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。
callback Callback<PedometerDetectionResponse> 注册一次计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, function(data) {
    console.info('Scalar data: ' + data.scalar);
  }
);

PEDOMETER(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback: Callback<PedometerResponse>): void

监听计步器传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.PEDOMETER代替。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PEDOMETER 计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
callback Callback<PedometerResponse> 注册一次计步传感器的回调函数,上报的数据类型为PedometerResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, function(data) {
    console.info('Steps: ' + data.steps);
  }
);

AMBIENT_TEMPERATURE(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE,callback: Callback<AmbientTemperatureResponse>): void

监听环境温度传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.AMBIENT_TEMPERATURE代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE 环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。
callback Callback<AmbientTemperatureResponse> 注册一次环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, function(data) {
    console.info('Temperature: ' + data.temperature);
  }
);

MAGNETIC_FIELD(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback: Callback<MagneticFieldResponse>): void

监听磁场传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.MAGNETIC_FIELD代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD 磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
callback Callback<MagneticFieldResponse> 注册一次磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, function(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
  }
);

MAGNETIC_FIELD_UNCALIBRATED(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED,callback: Callback<MagneticFieldUncalibratedResponse>): void

监听未校准磁场传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.MAGNETIC_FIELD_UNCALIBRATED代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED 未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。
callback Callback<MagneticFieldUncalibratedResponse> 注册一次未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, function(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
  }
);

PROXIMITY(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback: Callback<ProximityResponse>): void

监听接近光传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.PROXIMITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PROXIMITY 接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
callback Callback<ProximityResponse> 注册一次接近光传感器的回调函数,上报的数据类型为ProximityResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, function(data) {
    console.info('Distance: ' + data.distance);
  }
);

HUMIDITY(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback: Callback<HumidityResponse>): void

监听湿度传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.HUMIDITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HUMIDITY 湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
callback Callback<HumidityResponse> 注册一次湿度传感器的回调函数,上报的数据类型为HumidityResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, function(data) {
    console.info('Humidity: ' + data.humidity);
  }
);

BAROMETER(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback: Callback<BarometerResponse>): void

监听气压计传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.BAROMETER代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_BAROMETER 气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
callback Callback<BarometerResponse> 注册一次气压计传感器的回调函数,上报的数据类型为BarometerResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, function(data) {
    console.info('Atmospheric pressure: ' + data.pressure);
  }
);

HALL(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_HALL, callback: Callback<HallResponse>): void

监听霍尔传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.HALL代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HALL 霍尔传感器类型为SENSOR_TYPE_ID_HALL。
callback Callback<HallResponse> 注册一次霍尔传感器的回调函数,上报的数据类型为HallResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_HALL, function(data) {
    console.info('Status: ' + data.status);
  }
);

AMBIENT_LIGHT(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback: Callback<LightResponse>): void

监听环境光传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.AMBIENT_LIGHT代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT 环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。
callback Callback<LightResponse> 注册一次环境光传感器的回调函数,上报的数据类型为LightResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, function(data) {
    console.info(' Illumination: ' + data.intensity);
  }
);

ORIENTATION(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback: Callback<OrientationResponse>): void

监听方向传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.ORIENTATION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ORIENTATION 方向传感器类型为SENSOR_TYPE_ID_ORIENTATION。
callback Callback<OrientationResponse> 注册一次方向传感器的回调函数,上报的数据类型为OrientationResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, function(data) {
    console.info('The device rotates at an angle around the X axis: ' + data.beta);
    console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
    console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
  }
);

ROTATION_VECTOR(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback: Callback<RotationVectorResponse>): void

监听旋转矢量传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.ROTATION_VECTOR代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR 旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。
callback Callback<RotationVectorResponse> 注册一次旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, function(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('Scalar quantity: ' + data.w);
  }
);

HEART_RATE(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback: Callback<HeartRateResponse>): void

监听心率传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.HEART_RATE代替。

需要权限:ohos.permission.HEART_RATE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HEART_RATE 心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
callback Callback<HeartRateResponse> 注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。

WEAR_DETECTION(deprecated)

once(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback: Callback<WearDetectionResponse>): void

监听佩戴检测传感器数据变化一次。

从API version 9 开始不再维护,建议使用sensor.once.WEAR_DETECTION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_WEAR_DETECTION 佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。
callback Callback<WearDetectionResponse> 注册一次穿戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。

示例:

sensor.once(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, function(data) {
    console.info("Wear status: "+ data.value);
  }
);

sensor.off(deprecated)

ACCELEROMETER(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback?: Callback<AccelerometerResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.ACCELEROMETER代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ACCELEROMETER 要取消订阅的加速度传感器类型为SENSOR_TYPE_ID_ACCELEROMETER。
callback Callback<AccelerometerResponse> 取消注册加速度传感器的回调函数,上报的数据类型为AccelerometerResponse。

示例:

function callback(data) {
    console.info('x-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, callback);

ACCELEROMETER_UNCALIBRATED(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback?: Callback<AccelerometerUncalibratedResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.ACCELEROMETER_UNCALIBRATED代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED 要取消订阅的未校准加速度计传感器类型为SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED。
callback Callback<AccelerometerUncalibratedResponse> 取消注册未校准加速度计传感器的回调函数,上报的数据类型为AccelerometerUncalibratedResponse。

示例:

function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER_UNCALIBRATED, callback);

AMBIENT_LIGHT(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback?: Callback<LightResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.AMBIENT_LIGHT代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT 要取消订阅的环境光传感器类型为SENSOR_TYPE_ID_AMBIENT_LIGHT。
callback Callback<LightResponse> 取消注册环境光传感器的回调函数,上报的数据类型为LightResponse。

示例:

function callback(data) {
    console.info(' Illumination: ' + data.intensity);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_LIGHT, callback);

AMBIENT_TEMPERATURE(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback?: Callback<AmbientTemperatureResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.AMBIENT_TEMPERATURE代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE 要取消订阅的环境温度传感器类型为SENSOR_TYPE_ID_AMBIENT_TEMPERATURE。
callback Callback<AmbientTemperatureResponse> 取消注册环境温度传感器的回调函数,上报的数据类型为AmbientTemperatureResponse。

示例:

function callback(data) {
     console.info('Temperature: ' + data.temperature);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_AMBIENT_TEMPERATURE, callback);

BAROMETER(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_BAROMETER, callback?: Callback<BarometerResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.BAROMETER代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_BAROMETER 要取消订阅的气压计传感器类型为SENSOR_TYPE_ID_BAROMETER。
callback Callback<BarometerResponse> 取消注册气压计传感器的回调函数,上报的数据类型为BarometerResponse。

示例:

function callback(data) {
     console.info('Atmospheric pressure: ' + data.pressure);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_BAROMETER, callback);

GRAVITY(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_GRAVITY, callback?: Callback<GravityResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.GRAVITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GRAVITY 要取消订阅的重力传感器类型为SENSOR_TYPE_ID_GRAVITY。
callback Callback<GravityResponse> 取消注册注册重力传感器的回调函数,上报的数据类型为GravityResponse。

示例:

function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off( sensor.SensorType.SENSOR_TYPE_ID_GRAVITY, callback);

GYROSCOPE(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback?: Callback<GyroscopeResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.GYROSCOPE代替。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GYROSCOPE 要取消订阅的陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE。
callback Callback<GyroscopeResponse> 取消注册陀螺仪传感器的回调函数,上报的数据类型为GyroscopeResponse。

示例:

function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE, callback);

GYROSCOPE_UNCALIBRATED(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback?: Callback<GyroscopeUncalibratedResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.GYROSCOPE_UNCALIBRATED代替。

需要权限:ohos.permission.GYROSCOPE

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED 要取消订阅的未校准陀螺仪传感器类型为SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED。
callback Callback<GyroscopeUncalibratedResponse> 取消注册未校准陀螺仪传感器的回调函数,上报的数据类型为GyroscopeUncalibratedResponse。

示例:

function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_GYROSCOPE_UNCALIBRATED, callback);

HALL(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_HALL, callback?: Callback<HallResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.HALL代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HALL 要取消订阅的霍尔传感器类型为SENSOR_TYPE_ID_HALL。
callback Callback<HallResponse> 取消注册霍尔传感器的回调函数,上报的数据类型为 HallResponse。

示例:

function callback(data) {
    console.info('Status: ' + data.status);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HALL, callback);

HEART_RATE(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_HEART_RATE, callback?: Callback<HeartRateResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.HEART_RATE代替。

需要权限:ohos.permission.HEALTH_DATA

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HEART_RATE 要取消订阅的心率传感器类型为SENSOR_TYPE_ID_HEART_RATE。
callback Callback<HeartRateResponse> 取消注册一次心率传感器的回调函数,上报的数据类型为HeartRateResponse。

HUMIDITY(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_HUMIDITY, callback?: Callback<HumidityResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.HUMIDITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_HUMIDITY 要取消订阅的湿度传感器类型为SENSOR_TYPE_ID_HUMIDITY。
callback Callback<HumidityResponse> 取消注册湿度传感器的回调函数,上报的数据类型为HumidityResponse。

示例:

function callback(data) {
    console.info('Humidity: ' + data.humidity);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_HUMIDITY, callback);

LINEAR_ACCELERATION(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION, callback?: Callback<LinearAccelerometerResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.LINEAR_ACCELEROMETER代替。

需要权限:ohos.permission.ACCELEROMETER

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_LINEAR_ACCELERATION 要取消订阅的线性加速度传感器类型为SENSOR_TYPE_ID_LINEAR_ACCELERATION。
callback Callback<LinearAccelerometerResponse> 取消注册性加速度传感器的回调函数,上报的数据类型为LinearAccelerometerResponse。

MAGNETIC_FIELD(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback?: Callback<MagneticFieldResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.MAGNETIC_FIELD代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD 要取消订阅的磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD。
callbackcallback Callback<MagneticFieldResponse> 取消注册磁场传感器的回调函数,上报的数据类型为MagneticFieldResponse。

示例:

function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD, callback);

MAGNETIC_FIELD_UNCALIBRATED(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback?: Callback<MagneticFieldUncalibratedResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.MAGNETIC_FIELD_UNCALIBRATED代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED 要取消订阅的未校准磁场传感器类型为SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED。
callback Callback<MagneticFieldUncalibratedResponse> 取消注册未校准磁场传感器的回调函数,上报的数据类型为MagneticFieldUncalibratedResponse。

示例:

function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('X-coordinate bias: ' + data.biasX);
    console.info('Y-coordinate bias: ' + data.biasY);
    console.info('Z-coordinate bias: ' + data.biasZ);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_MAGNETIC_FIELD_UNCALIBRATED, callback);

ORIENTATION(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_ORIENTATION, callback?: Callback<OrientationResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.ORIENTATION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ORIENTATION 要取消订阅的方向传感器类型为SENSOR_TYPE_ID_ORIENTATION
callback Callback<OrientationResponse> 取消注册方向传感器的回调函数,上报的数据类型为OrientationResponse。

示例:

function callback(data) {
    console.info('The device rotates at an angle around the X axis: ' + data.beta);
    console.info('The device rotates at an angle around the Y axis: ' + data.gamma);
    console.info('The device rotates at an angle around the Z axis: ' + data.alpha);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ORIENTATION, callback);

PEDOMETER(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER, callback?: Callback<PedometerResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.PEDOMETER代替。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PEDOMETER 要取消订阅的计步传感器类型为SENSOR_TYPE_ID_PEDOMETER。
callback Callback<PedometerResponse> 取消注册计步传感器的回调函数,上报的数据类型为PedometerResponse。

示例:

function callback(data) {
    console.info('Steps: ' + data.steps);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER, callback);

PEDOMETER_DETECTION(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback?: Callback<PedometerDetectionResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.PEDOMETER_DETECTION代替。

需要权限:ohos.permission.ACTIVITY_MOTION

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION 要取消订阅的计步检测传感器类型为SENSOR_TYPE_ID_PEDOMETER_DETECTION。
callback Callback<PedometerDetectionResponse> 取消注册计步检测传感器的回调函数,上报的数据类型为PedometerDetectionResponse。

示例:

function callback(data) {
    console.info('Scalar data: ' + data.scalar);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PEDOMETER_DETECTION, callback);

PROXIMITY(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_PROXIMITY, callback?: Callback<ProximityResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.PROXIMITY代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_PROXIMITY 要取消订阅的接近光传感器类型为SENSOR_TYPE_ID_PROXIMITY。
callback Callback<ProximityResponse> 取消注册接近光传感器的回调函数,上报的数据类型为ProximityResponse。

示例:

function callback(data) {
    console.info('Distance: ' + data.distance);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_PROXIMITY, callback);

ROTATION_VECTOR(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback?: Callback<RotationVectorResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.ROTATION_VECTOR代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR 要取消订阅的旋转矢量传感器类型为SENSOR_TYPE_ID_ROTATION_VECTOR。
callback Callback<RotationVectorResponse> 取消注册旋转矢量传感器的回调函数,上报的数据类型为RotationVectorResponse。

示例:

function callback(data) {
    console.info('X-coordinate component: ' + data.x);
    console.info('Y-coordinate component: ' + data.y);
    console.info('Z-coordinate component: ' + data.z);
    console.info('Scalar quantity: ' + data.w);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ROTATION_VECTOR, callback);

SIGNIFICANT_MOTION(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback?: Callback<SignificantMotionResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.SIGNIFICANT_MOTION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION 要取消订阅的大幅动作传感器类型为SENSOR_TYPE_ID_SIGNIFICANT_MOTION。
callback Callback<SignificantMotionResponse> 取消注册有效运动传感器的回调函数,上报的数据类型为SignificantMotionResponse。

示例:

function callback(data) {
    console.info('Scalar data: ' + data.scalar);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_SIGNIFICANT_MOTION, callback);

WEAR_DETECTION(deprecated)

off(type: SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, callback?: Callback<WearDetectionResponse>): void

取消订阅传感器数据。

从API version 9 开始不再维护,建议使用sensor.off.WEAR_DETECTION代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
type SensorType.SENSOR_TYPE_ID_WEAR_DETECTION 要取消订阅的佩戴检测传感器类型为SENSOR_TYPE_ID_WEAR_DETECTION。
callback Callback<WearDetectionResponse> 取消注册佩戴检测传感器的回调函数,上报的数据类型为WearDetectionResponse。

示例:

function accCallback(data) {
    console.info('Wear status: ' + data.value);
}
sensor.off(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, accCallback);

sensor.transformCoordinateSystem(deprecated)

transformCoordinateSystem(inRotationVector: Array<number>, coordinates: CoordinatesOptions, callback: AsyncCallback<Array<number>>): void

旋转提供的旋转矩阵,使其可以以不同的方式表示坐标系。

从API version 9 开始不再维护,建议使用sensor.transformRotationMatrix代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inRotationVector Array<number> 表示旋转矩阵。
coordinates CoordinatesOptions 表示坐标系方向。
callback AsyncCallback<Array<number>> 返回转换后的旋转矩阵。

示例:

sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {x:2, y:3}, function(err, data) {
    if (err) {
        console.error("Operation failed. Error code: " + err.code + ", message: " + err.message);
        return;
    }
    console.info("Operation succeeded. Data obtained: " + data);
    for (var i=0; i < data.length; i++) {
        console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
    }
 })

sensor.transformCoordinateSystem(deprecated)

transformCoordinateSystem(inRotationVector: Array<number>, coordinates: CoordinatesOptions): Promise<Array<number>>

旋转提供的旋转矩阵,使其可以以不同的方式表示坐标系。

从API version 9 开始不再维护,建议使用sensor.transformRotationMatrix代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inRotationVector Array<number> 表示旋转矩阵。
coordinates CoordinatesOptions 表示坐标系方向。

返回值:

类型 说明
Promise<Array<number>> 返回转换后的旋转矩阵。

示例:

const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {x:2, y:3});
    promise.then((data) => {
        console.info("Operation succeeded.");
        for (var i=0; i < data.length; i++) {
            console.info("transformCoordinateSystem data[ " + i + "] = " + data[i]);
        }
    }).catch((err) => {
           console.info("Operation failed");
})

sensor.getGeomagneticField(deprecated)

getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callback: AsyncCallback<GeomagneticResponse>): void

获取地球上特定位置的地磁场。

从API version 9 开始不再维护,建议使用sensor.getGeomagneticInfo代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
locationOptions LocationOptions 地理位置。
timeMillis number 表示获取磁偏角的时间,单位为毫秒。
callback AsyncCallback<GeomagneticResponse> 返回磁场信息。

示例:

sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000, function(err, data)  {
    if (err) {
        console.error('Operation failed. Error code: ' + err.code + '; message: ' + err.message);
        return;
    }
    console.info('sensor_getGeomagneticField_callback x: ' + data.x + ',y: ' + data.y + ',z: ' +
	             data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
		     ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
});

sensor.getGeomagneticField(deprecated)

getGeomagneticField(locationOptions: LocationOptions, timeMillis: number): Promise<GeomagneticResponse>

获取地球上特定位置的地磁场。

从API version 9 开始不再维护,建议使用sensor.getGeomagneticInfo代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
locationOptions LocationOptions 地理位置。
timeMillis number 表示获取磁偏角的时间,单位为毫秒。

返回值:

类型 说明
Promise<GeomagneticResponse> 返回磁场信息。

示例:

const promise = sensor.getGeomagneticField({latitude:80, longitude:0, altitude:0}, 1580486400000);
    promise.then((data) => {
        console.info('sensor_getGeomagneticField_promise x: ' + data.x + ',y: ' + data.y + ',z: ' +
	             data.z + ',geomagneticDip: ' + data.geomagneticDip + ',deflectionAngle: ' + data.deflectionAngle +
		     ',levelIntensity: ' + data.levelIntensity + ',totalIntensity: ' + data.totalIntensity);
    }).catch((reason) => {
        console.info('Operation failed.');
})

sensor.getAltitude(deprecated)

getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallback<number>): void

根据气压值获取设备所在的海拔高度。

从API version 9 开始不再维护,建议使用sensor.getDeviceAltitude代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
seaPressure number 表示海平面气压值,单位为hPa。
currentPressure number 表示设备所在高度的气压值,单位为hPa。
callback AsyncCallback<number> 返回设备所在的海拔高度,单位为米。

示例:

sensor.getAltitude(0, 200, function(err, data)  {
    if (err) {
        console.error(
"Operation failed. Error code: " + err.code + ", message: " + err.message);
        return;
    }
        console.info("Succeeded to get getAltitude interface get data: " + data);
});

sensor.getAltitude(deprecated)

getAltitude(seaPressure: number, currentPressure: number): Promise<number>

根据气压值获取设备所在的海拔高度。

从API version 9 开始不再维护,建议使用sensor.getDeviceAltitude代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
seaPressure number 表示海平面气压值,单位为hPa。
currentPressure number 表示设备所在高度的气压值,单位为hPa。

返回值:

类型 说明
Promise<number> 返回设备所在的海拔高度(单位:米)。

示例:

const promise = sensor.getAltitude(0, 200);
    promise.then((data) => {
        console.info(' sensor_getAltitude_Promise success', data);
    }).catch((err) => {
        console.error("Operation failed");
})

sensor.getGeomagneticDip(deprecated)

getGeomagneticDip(inclinationMatrix: Array<number>, callback: AsyncCallback<number>): void

根据倾斜矩阵计算地磁倾斜角。

从API version 9 开始不再维护,建议使用sensor.getInclination代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inclinationMatrix Array<number> 表示倾斜矩阵。
callback AsyncCallback<number> 返回地磁倾斜角,单位为弧度。

示例:

sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data)  {
    if (err) {
        console.error('SensorJsAPI--->Failed to register data, error code is:' + err.code + ', message: ' + 
                      err.message);
        return;
    }
        console.info("Succeeded to get getGeomagneticDip interface get data: " + data);
})

sensor.getGeomagneticDip(deprecated)

getGeomagneticDip(inclinationMatrix: Array<number>): Promise<number>

根据倾斜矩阵计算地磁倾斜角。

从API version 9 开始不再维护,建议使用sensor.getInclination代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
inclinationMatrix Array<number> 表示倾斜矩阵。

返回值:

类型 说明
Promise<number> 返回地磁倾斜角,单位为弧度。

示例:

const promise = sensor.getGeomagneticDip([1, 0, 0, 0, 1, 0, 0, 0, 1]);
    promise.then((data) => {
        console.info('getGeomagneticDip_promise succeeded', data);
    }).catch((err) => {
         console.error("Operation failed");
})

sensor. getAngleModify(deprecated)

getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Array<number>, callback: AsyncCallback<Array<number>>): void

获取两个旋转矩阵之间的角度变化。

从API version 9 开始不再维护,建议使用sensor.getAngleVariation代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
currentRotationMatrix Array<number> 表示当前旋转矩阵。
preRotationMatrix Array<number> 表示旋转矩阵。
callback AsyncCallback<Array<number>> 返回z、x、y轴方向的旋转角度变化。

示例:

sensor. getAngleModify([1,0,0,0,1,0,0,0,1], [1, 0, 0, 0, 0.87, -0.50, 0, 0.50, 0.87], function(err, data)  {
    if (err) {
        console.error('Failed to register data, error code is: ' + err.code + ', message: ' + 
                      err.message);
        return;
    }
    for (var i=0; i < data.length; i++) {
        console.info("data[" + i + "]: " + data[i]);
    }
})

sensor. getAngleModify(deprecated)

getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Array<number>): Promise<Array<number>>

获取两个旋转矩阵之间的角度变化。

从API version 9 开始不再维护,建议使用sensor.getAngleVariation代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
currentRotationMatrix Array<number> 表示当前旋转矩阵。
preRotationMatrix Array<number> 表示旋转矩阵。

返回值:

类型 说明
Promise<Array<number>> 返回z、x、y轴方向的旋转角度变化。

示例:

const promise = sensor.getAngleModify([1,0,0,0,1,0,0,0,1], [1,0,0,0,0.87,-0.50,0,0.50,0.87]);
    promise.then((data) => {
        console.info('getAngleModify_promise success');
        for (var i=0; i < data.length; i++) {
            console.info("data[" + i + "]: " + data[i]);
        }
    }).catch((reason) => {
        console.info("promise::catch", reason);
})

sensor.createRotationMatrix(deprecated)

createRotationMatrix(rotationVector: Array<number>, callback: AsyncCallback<Array<number>>): void

将旋转矢量转换为旋转矩阵。

从API version 9 开始不再维护,建议使用sensor.getRotationMatrix代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 表示旋转矢量。
callback AsyncCallback<Array<number>> 返回旋转矩阵。

示例:

sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data) {
    if (err) {
        console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + 
                      err.message);
        return;
    }
    for (var i=0; i < data.length; i++) {
        console.info("data[" + i + "]: " + data[i]);
    }
})

sensor.createRotationMatrix(deprecated)

createRotationMatrix(rotationVector: Array<number>): Promise<Array<number>>

将旋转矢量转换为旋转矩阵。

从API version 9 开始不再维护,建议使用sensor.getRotationMatrix代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 表示旋转矢量。

返回值:

类型 说明
Promise<Array<number>> 返回旋转矩阵。

示例:

const promise = sensor.createRotationMatrix([0.20046076, 0.21907, 0.73978853, 0.60376877]);
    promise.then((data) => {
        console.info('createRotationMatrix_promise success');
        for (var i=0; i < data.length; i++) {
            console.info("data[" + i + "]: " + data[i]);
        }
    }).catch((reason) => {
        console.info("promise::catch", reason);
})	

sensor.createQuaternion(deprecated)

createQuaternion(rotationVector: Array<number>, callback: AsyncCallback<Array<number>>): void

将旋转矢量转换为四元数。

从API version 9 开始不再维护,建议使用sensor.getQuaternion代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 表示旋转矢量。
callback AsyncCallback<Array<number>> 返回四元数。

示例:

sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877], function(err, data)  {
    if (err) {
        console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' + 
                      err.message);
        return;
    }
    for (var i=0; i < data.length; i++) {
        console.info("data[" + i + "]: " + data[i]);
    }
})

sensor.createQuaternion(deprecated)

createQuaternion(rotationVector: Array<number>): Promise<Array<number>>

将旋转矢量转换为四元数。

从API version 9 开始不再维护,建议使用sensor.getQuaternion代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationVector Array<number> 表示旋转矢量。

返回值:

类型 说明
Promise<Array<number>> 返回四元数。

示例:

const promise = sensor.createQuaternion([0.20046076, 0.21907, 0.73978853, 0.60376877]);
    promise.then((data) => {
        console.info('createQuaternion_promise succeeded');
        for (var i=0; i < data.length; i++) {
            console.info("data[" + i + "]: " + data[i]);
        }
    }).catch((err) => {
        console.info('promise failed');
})

sensor.getDirection(deprecated)

getDirection(rotationMatrix: Array<number>, callback: AsyncCallback<Array<number>>): void

根据旋转矩阵计算设备的方向。

从API version 9 开始不再维护,建议使用sensor.getOrientation代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationMatrix Array<number> 表示旋转矩阵。
callback AsyncCallback<Array<number>> 返回围绕z、x、y轴方向的旋转角度。

示例:

sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1], function(err, data)  {
    if (err) {
        console.error('SensorJsAPI--->Failed to register data, error code is: ' + err.code + ', message: ' +
                      err.message);
        return;
    }
    console.info("SensorJsAPI--->Succeeded to get getDirection interface get data: " + data);
    for (var i = 1; i < data.length; i++) {
        console.info("sensor_getDirection_callback" + data[i]);
    }
})

sensor.getDirection(deprecated)

getDirection(rotationMatrix: Array<number>): Promise<Array<number>>

根据旋转矩阵计算设备的方向。

从API version 9 开始不再维护,建议使用sensor.getOrientation代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
rotationMatrix Array<number> 表示旋转矩阵。

返回值:

类型 说明
Promise<Array<number>> 返回围绕z、x、y轴方向的旋转角度。

示例:

const promise = sensor.getDirection([1, 0, 0, 0, 1, 0, 0, 0, 1]);
    promise.then((data) => {
        console.info('sensor_getAltitude_Promise success', data);
        for (var i = 1; i < data.length; i++) {
            console.info("sensor_getDirection_promise" + data[i]);
        }
    }).catch((err) => {
        console.info('promise failed');
})

sensor.createRotationMatrix(deprecated)

createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number>, callback: AsyncCallback<RotationMatrixResponse>): void

根据重力矢量和地磁矢量计算旋转矩阵。

从API version 9 开始不再维护,建议使用sensor.getRotationMatrix代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
gravity Array<number> 表示重力向量。
geomagnetic Array<number> 表示地磁矢量。
callback AsyncCallback<RotationMatrixResponse> 返回旋转矩阵。

示例:

sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444], function(err, data)  {
    if (err) {
        console.error('error code is: ' + err.code + ', message: ' + err.message);
        return;
    }
    console.info(JSON.stringify(data));
})

sensor.createRotationMatrix(deprecated)

createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number>,): Promise<RotationMatrixResponse>

根据重力矢量和地磁矢量计算旋转矩阵。

从API version 9 开始不再维护,建议使用sensor.getRotationMatrix代替。

系统能力:SystemCapability.Sensors.Sensor

参数:

参数名 类型 必填 说明
gravity Array<number> 表示重力向量。
geomagnetic Array<number> 表示地磁矢量。

返回值:

类型 说明
Promise<RotationMatrixResponse> 返回旋转矩阵。

示例:

const promise = sensor.createRotationMatrix([-0.27775216, 0.5351276, 9.788099], [210.87253, -78.6096, -111.44444]);
    promise.then((data) => {
        console.info(JSON.stringify(data));
    }).catch((err) => {
        console.info('promise failed');
})