HarmonyOS API：设备管理

joytrian

发布于 2023-4-10 18:06

930浏览

0收藏

版本：v3.1 Beta

ORIENTATION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.

PEDOMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

PEDOMETER_DETECTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

PROXIMITY⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

ROTATION_VECTOR⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

SIGNIFICANT_MOTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

WEAR_DETECTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

sensor.once⁹⁺

ACCELEROMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.

ACCELEROMETER_UNCALIBRATED⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

AMBIENT_LIGHT⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

AMBIENT_TEMPERATURE⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

BAROMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

GRAVITY⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.

GYROSCOPE⁹⁺

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

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

需要权限：ohos.permission.GYROSCOPE

系统能力：SystemCapability.Sensors.Sensor

参数：

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

错误码：

以下错误码的详细介绍请参见。

错误码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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.

GYROSCOPE_UNCALIBRATED⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

HALL⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

HEART_RATE⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

HUMIDITY⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

LINEAR_ACCELEROMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.

MAGNETIC_FIELD⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.

MAGNETIC_FIELD_UNCALIBRATED⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.

ORIENTATION⁹⁺

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

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

系统能力：SystemCapability.Sensors.Sensor

参数：

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

错误码：

以下错误码的详细介绍请参见。

错误码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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.

PEDOMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

PEDOMETER_DETECTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

PROXIMITY⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

ROTATION_VECTOR⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

SIGNIFICANT_MOTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

WEAR_DETECTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.

sensor.off⁹⁺

ACCELEROMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

ACCELEROMETER_UNCALIBRATED⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

AMBIENT_LIGHT⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

AMBIENT_TEMPERATURE⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

BAROMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

GRAVITY⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

GYROSCOPE⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

GYROSCOPE_UNCALIBRATED⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

HALL⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

HEART_RATE⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

HUMIDITY⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

LINEAR_ACCELEROMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

MAGNETIC_FIELD⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

MAGNETIC_FIELD_UNCALIBRATED⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

ORIENTATION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

PEDOMETER⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

PEDOMETER_DETECTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

PROXIMITY⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

ROTATION_VECTOR⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

SIGNIFICANT_MOTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

WEAR_DETECTION⁹⁺

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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

sensor.getGeomagneticInfo⁹⁺

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

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

系统能力：SystemCapability.Sensors.Sensor

参数：

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

错误码：

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

错误码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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.

sensor.getGeomagneticInfo⁹⁺

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

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

系统能力：SystemCapability.Sensors.Sensor

参数：

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

返回值：

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

错误码：

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

错误码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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.

sensor.getDeviceAltitude⁹⁺

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

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

系统能力：SystemCapability.Sensors.Sensor

参数：

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

错误码：

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

错误码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);
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-sensor-0000001500954573-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001500954573__sensorgetdevicealtitude9

分类

其他

标签

HarmonyOS API

已于2023-4-10 18:06:40修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：设备管理

ORIENTATION9+

PEDOMETER9+

PEDOMETER_DETECTION9+

PROXIMITY9+

ROTATION_VECTOR9+

SIGNIFICANT_MOTION9+

WEAR_DETECTION9+

sensor.once9+

ACCELEROMETER9+

ACCELEROMETER_UNCALIBRATED9+

AMBIENT_LIGHT9+

AMBIENT_TEMPERATURE9+

BAROMETER9+

GRAVITY9+

GYROSCOPE9+

GYROSCOPE_UNCALIBRATED9+

HALL9+

HEART_RATE9+

HUMIDITY9+

LINEAR_ACCELEROMETER9+

MAGNETIC_FIELD9+

MAGNETIC_FIELD_UNCALIBRATED9+

ORIENTATION9+

PEDOMETER9+

PEDOMETER_DETECTION9+

PROXIMITY9+

ROTATION_VECTOR9+

SIGNIFICANT_MOTION9+

WEAR_DETECTION9+

sensor.off9+

ACCELEROMETER9+

ACCELEROMETER_UNCALIBRATED9+

AMBIENT_LIGHT9+

AMBIENT_TEMPERATURE9+

BAROMETER9+

GRAVITY9+

GYROSCOPE9+

GYROSCOPE_UNCALIBRATED9+

HALL9+

HEART_RATE9+

HUMIDITY9+

LINEAR_ACCELEROMETER9+

MAGNETIC_FIELD9+

MAGNETIC_FIELD_UNCALIBRATED9+

ORIENTATION9+

PEDOMETER9+

PEDOMETER_DETECTION9+

PROXIMITY9+

ROTATION_VECTOR9+

SIGNIFICANT_MOTION9+

WEAR_DETECTION9+

sensor.getGeomagneticInfo9+

sensor.getGeomagneticInfo9+

sensor.getDeviceAltitude9+

目录

订阅鸿蒙技术特刊，精选内容抢先看

ORIENTATION⁹⁺

PEDOMETER⁹⁺

PEDOMETER_DETECTION⁹⁺

PROXIMITY⁹⁺

ROTATION_VECTOR⁹⁺

SIGNIFICANT_MOTION⁹⁺

WEAR_DETECTION⁹⁺

sensor.once⁹⁺

ACCELEROMETER⁹⁺

ACCELEROMETER_UNCALIBRATED⁹⁺

AMBIENT_LIGHT⁹⁺

AMBIENT_TEMPERATURE⁹⁺

BAROMETER⁹⁺

GRAVITY⁹⁺

GYROSCOPE⁹⁺

GYROSCOPE_UNCALIBRATED⁹⁺

HALL⁹⁺

HEART_RATE⁹⁺

HUMIDITY⁹⁺

LINEAR_ACCELEROMETER⁹⁺

MAGNETIC_FIELD⁹⁺

MAGNETIC_FIELD_UNCALIBRATED⁹⁺

ORIENTATION⁹⁺

PEDOMETER⁹⁺

PEDOMETER_DETECTION⁹⁺

PROXIMITY⁹⁺

ROTATION_VECTOR⁹⁺

SIGNIFICANT_MOTION⁹⁺

WEAR_DETECTION⁹⁺

sensor.off⁹⁺

ACCELEROMETER⁹⁺

ACCELEROMETER_UNCALIBRATED⁹⁺

AMBIENT_LIGHT⁹⁺

AMBIENT_TEMPERATURE⁹⁺

BAROMETER⁹⁺

GRAVITY⁹⁺

GYROSCOPE⁹⁺

GYROSCOPE_UNCALIBRATED⁹⁺

HALL⁹⁺

HEART_RATE⁹⁺

HUMIDITY⁹⁺

LINEAR_ACCELEROMETER⁹⁺

MAGNETIC_FIELD⁹⁺

MAGNETIC_FIELD_UNCALIBRATED⁹⁺

ORIENTATION⁹⁺

PEDOMETER⁹⁺

PEDOMETER_DETECTION⁹⁺

PROXIMITY⁹⁺

ROTATION_VECTOR⁹⁺

SIGNIFICANT_MOTION⁹⁺

WEAR_DETECTION⁹⁺

sensor.getGeomagneticInfo⁹⁺

sensor.getGeomagneticInfo⁹⁺

sensor.getDeviceAltitude⁹⁺