Skip to main content
Version: v3

Accelerometer

Start from API_LEVEL 3.0 . Please refer to API_LEVEL.

Accelerometer_image}

accelerometer. Measure the acceleration of the device along three orthogonal axes (x, y, z). The x and y axes are parallel to the screen, with the positive direction referring to the diagram. The z-axis is perpendicular to the device's screen, with the positive direction pointing upward.

info

permission code: device:os.accelerometer

Methods

start

Start listening to accelerometer data

start(): void

stop

Stop listening to accelerometer data

stop(): void

getCurrent

Get current accelerometer data

getCurrent(): Result

Result

PropertyTypeDescriptionAPI_LEVEL
xnumberAcceleration of x-axis in cm/s^23.0
ynumberAcceleration of y-axis in cm/s^23.0
znumberAcceleration of z-axis in cm/s^23.0

onChange

Register the accelerometer data change event listener callback function

onChange(callback: () => void): void

offChange

Cancel the accelerometer data change event listener callback function

offChange(callback: () => void): void

setFreqMode

Start from API_LEVEL 3.0

Set the mode of trigger frequency, mode value reference frequency mode constant

setFreqMode(mode: number): void

Constants

Frequency Mode
ConstantDescriptionAPI_LEVEL
FREQ_MODE_LOWLow power mode with low trigger frequency3.0
FREQ_MODE_NORMALNormal power consumption mode, medium trigger frequency3.0
FREQ_MODE_HIGHHigh power consumption mode with high trigger frequency3.0

getFreqMode

Start from API_LEVEL 3.0

Get the mode of trigger frequency, result value reference frequency mode constant

getFreqMode(): number

Constants

Frequency Mode
ConstantDescriptionAPI_LEVEL
FREQ_MODE_LOWLow power mode with low trigger frequency3.0
FREQ_MODE_NORMALNormal power consumption mode, medium trigger frequency3.0
FREQ_MODE_HIGHHigh power consumption mode with high trigger frequency3.0

Example

import { Accelerometer, FREQ_MODE_NORMAL } from '@zos/sensor'

const accelerometer = new Accelerometer()

const callback = () => {
console.log(accelerometer.getCurrent())
}
accelerometer.onChange(callback)
accelerometer.setFreqMode(FREQ_MODE_NORMAL)
accelerometer.start()

// When not needed for use
accelerometer.offChange()
accelerometer.stop()