HarmonyOS API:设备管理

joytrian
发布于 2023-4-10 17:54
浏览
0收藏

版本:v3.1 Beta

@ohos.vibrator (振动)

更新时间: 2023-02-17 09:19


vibrator模块提供控制马达振动启、停的能力。


说明

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

导入模块

import vibrator from '@ohos.vibrator';

EffectId

预置的振动效果。

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

名称

说明

EFFECT_CLOCK_TIMER

"haptic.clock.timer"

描述用户调整计时器时的振动效果。

VibratorStopMode

停止的振动模式。

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

名称

说明

VIBRATOR_STOP_MODE_TIME

"time"

停止模式为duration模式的振动。

VIBRATOR_STOP_MODE_PRESET

"preset"

停止模式为预置EffectId的振动。

VibrateEffect9+

马达振动效果。

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

类型

说明

​VibrateTime​

按照指定持续时间触发马达振动。

​VibratePreset​

按照预置振动类型触发马达振动。

VibrateTime9+

马达振动时长。

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

名称

说明

type

"time"

按照指定持续时间触发马达振动。

duration

-

马达持续振动时长, 单位ms。

VibratePreset9+

马达预置振动类型。

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

名称

说明

type

"preset"

按照预置振动效果触发马达振动。

effectId

-

预置的振动效果ID。

count

-

重复振动的次数。

@ohos.sensor (传感器)

更新时间: 2023-02-17 09:19


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);
}


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

已于2023-4-10 17:54:21修改
收藏
回复
举报
回复