Sensor

NOTE

• The initial APIs of this module are supported since API version 4. Newly added APIs will be marked with a superscript to indicate their earliest API version.
• The APIs of this module are no longer maintained since API version 8. You are advised to use Sensor instead.
• This module requires hardware support and can only be debugged on real devices.

Modules to Import

import sensor from '@system.sensor';

Error Codes

sensor.subscribeAccelerometer

subscribeAccelerometer(Object): void

Subscribes to data changes of the acceleration sensor. If this API is called multiple times for the same application, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.ACCELEROMETER (a system permission)

Parameters

Return values of the success callback

Example

sensor.subscribeAccelerometer({
  interval: 'normal',
  success: function(ret) {
    console.log('X-axis data: ' + ret.x);
    console.log('Y-axis data: ' + ret.y);
    console.log('Z-axis data: ' + ret.z);
  },
  fail: function(data, code) {
    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeAccelerometer

unsubscribeAccelerometer(): void

Unsubscribes from data changes of the acceleration sensor.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.ACCELEROMETER (a system permission)

Example

sensor.unsubscribeAccelerometer();

sensor.subscribeCompass

subscribeCompass(Object): void

Subscribes to data changes of the compass sensor. If this API is called multiple times for the same application, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Parameters

Return values of the success callback

Example

sensor.subscribeCompass({
  success: function(ret) {
    console.log('get data direction:' + ret.direction);
  },
  fail: function(data, code) {
    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeCompass

unsubscribeCompass(): void

Unsubscribes from data changes of the compass sensor.

System capability: SystemCapability.Sensors.Sensor

Example

sensor.unsubscribeCompass();

sensor.subscribeProximity

subscribeProximity(Object): void

Subscribes to data changes of the proximity sensor. If this API is called multiple times for the same application, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Parameters

Return values of the success callback

Example

sensor.subscribeProximity({
  success: function(ret) {
    console.log('get data distance:' + ret.distance);
  },
  fail: function(data, code) {
    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeProximity

unsubscribeProximity(): void

Unsubscribes from data changes of the proximity sensor.

System capability: SystemCapability.Sensors.Sensor

Example

sensor.unsubscribeProximity();

sensor.subscribeLight

sensor.subscribeLight(Object): void

Subscribes to data changes of the ambient light sensor. If this API is called multiple times, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Parameters

Return values of the success callback

Example

sensor.subscribeLight({
  success: function(ret) {
    console.log('get data intensity:' + ret.intensity);
  },
  fail: function(data, code) {
    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeLight

unsubscribeLight(): void

Unsubscribes from data changes of the ambient light sensor.

System capability: SystemCapability.Sensors.Sensor

Example

sensor.unsubscribeLight();

sensor.subscribeStepCounter

subscribeStepCounter(Object): void

Subscribes to data changes of the step counter sensor. If this API is called multiple times for the same application, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.ACTIVITY_MOTION

Parameters

Return values of the success callback

Example

sensor.subscribeStepCounter({
  success: function(ret) {
    console.log('get step value:' + ret.steps);
  },
  fail: function(data, code) {
    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeStepCounter

unsubscribeStepCounter(): void

Unsubscribes from data changes of the step counter sensor.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.ACTIVITY_MOTION

Example

sensor.unsubscribeStepCounter();

sensor.subscribeBarometer

subcribeBarometer(Object): void

Subscribes to data changes of the barometer sensor. If this API is called multiple times for the same application, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Parameters

Return values of the success callback

Example

sensor.subscribeBarometer({
  success: function(ret) {
    console.log('get data value:' + ret.pressure);
  },
  fail: function(data, code) {
    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeBarometer

unsubscribeBarometer(): void

Unsubscribes from data changes of the barometer sensor.

System capability: SystemCapability.Sensors.Sensor

Example

sensor.unsubscribeBarometer();

sensor.subscribeHeartRate

subscribeHeartRate(Object): void

Subscribes to data changes of the heart rate sensor. If this API is called multiple times for the same application, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.READ_HEALTH_DATA

Parameters

Return values of the success callback

Example

sensor.subscribeHeartRate({
  success: function(ret) {
    console.log('get heartrate value:' + ret.heartRate);
  },
  fail: function(data, code) {
    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeHeartRate

unsubscribeHeartRate(): void

Unsubscribes from data changes of the heart rate sensor.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.READ_HEALTH_DATA

Example

sensor.unsubscribeHeartRate();

sensor.subscribeOnBodyState

subscribeOnBodyState(Object): void

Subscribes to changes of the wearing state of a wearable device. If this API is called multiple times for the same application, the last call takes effect.

System capability: SystemCapability.Sensors.Sensor

Parameters

Return values of the success callback

Example

sensor.subscribeOnBodyState({
  success: function(ret) {
    console.log('get on-body state value:' + ret.value);
  },
  fail: function(data, code) {
    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeOnBodyState

unsubscribeOnBodyState(): void

Unsubscribes from changes of the wearing state of a wearable device.

System capability: SystemCapability.Sensors.Sensor

Example

sensor.unsubscribeOnBodyState();

sensor.getOnBodyState

getOnBodyState(Object): void

Obtains the wearing state of a wearable device.

System capability: SystemCapability.Sensors.Sensor

Parameters

Return values of the success callback

Example

sensor.getOnBodyState({
  success: function(ret) {
    console.log('on body state: ' + ret.value);
  },
  fail: function(data, code) {
    console.log('Subscription failed. Code: ' + code + '; Data: ' + data);
  },
});

sensor.subscribeDeviceOrientation⁶⁺

subscribeDeviceOrientation(interval: string, success: (data: DeviceOrientationResponse), fail?: (data: string, code: number)): void

Subscribes to data changes of the device orientation sensor.

If this API is called multiple times for the same application, the last call takes effect. However, this API cannot be called multiple times in one click event.

System capability: SystemCapability.Sensors.Sensor

Parameters

Return values of the success callback

Example

sensor.subscribeDeviceOrientation({
  interval: 'normal',
  success: function(ret) {
    console.log('Alpha data: ' + ret.alpha);
    console.log('Beta data: ' + ret.beta);
    console.log('Gamma data: ' + ret.gamma);
  },
  fail: function(data, code) {
    console.error('Subscription failed. Code: ' + code + '; Data: ' + data);
  }
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeDeviceOrientation⁶⁺

unsubscribeDeviceOrientation(): void

Unsubscribes from data changes of the device orientation sensor.

System capability: SystemCapability.Sensors.Sensor

Example

sensor.unsubscribeDeviceOrientation();

sensor.subscribeGyroscope⁶⁺

subscribeGyroscope(interval: string, success: (data: GyroscopeResponse), fail?: (data: string, code: number)): void

Subscribes to data changes of the gyroscope sensor.

If this API is called multiple times for the same application, the last call takes effect. However, this API cannot be called multiple times in one click event.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.GYROSCOPE (a system permission)

Parameters

Return values of the success callback

Example

sensor.subscribeGyroscope({
  interval: 'normal',
  success: function(ret) {
    console.log('X-axis data: ' + ret.x);
    console.log('Y-axis data: ' + ret.y);
    console.log('Z-axis data: ' + ret.z);
  },
  fail: function(data, code) {
    console.error('Subscription failed. Code: ' + code + '; data: ' + data);
  }
});

NOTE To reduce performance overhead, you are advised to unsubscribe from the sensor data in the onDestory callback.

sensor.unsubscribeGyroscope⁶⁺

unsubscribeGyroscope(): void

Unsubscribes from data changes of the gyroscope sensor.

System capability: SystemCapability.Sensors.Sensor

Required permissions: ohos.permission.GYROSCOPE (a system permission)

Example

sensor.unsubscribeGyroscope();