Vibrator

Interface Declaration

{ "name": "system.vibrator" }

Import Module

import vibrator from '@system.vibrator' 
// or 
const vibrator = require('@system.vibrator')

Interface Definition

vibrator.vibrate(OBJECT)

Trigger vibration.

Parameters:

Parameter	Type	Required	Description
mode	String	No	Vibration mode. "long" indicates long vibration, and "short" indicates short vibration. Defaults to long.

Example:

vibrator.vibrate({
  mode: 'long'
})

vibrator.start(OBJECT)

Start vibration.

Parameters:

Parameter	Type	Required	Description
duration	Number	Yes	Vibration duration (in ms). Must be a positive integer.
interval	Number	Yes	Vibration interval (in ms). Must be a positive integer.
count	Number	Yes	Number of vibrations. Must be a positive integer.
success	Function	No	Callback function for success.
fail	Function	No	Callback function for failure.
complete	Function	No	Callback function after execution is complete.

Return Values for success:

Parameter Name	Type	Description
id	Number	Unique ID identifying the vibration task.

Return Values for fail:

Error Code	Description
205	Task already exists.
202	Parameter error.

Example:

vibrator.start({
  duration: 1000,
  interval: 1000,
  count: 10,
  success: function (data) {
    console.log(`handling success, id = ${data.id}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}, errorMsg=${data}`)
  },
  complete: function () {
    console.log(`handling complete`)
  }
})

vibrator.stop(Number)

Stop vibration.

Parameters:

Type	Required	Description
Number	Yes	ID of the vibration task.

Return Values:

Type	Description
Boolean	true: Success; false: Failure.

Example:

vibrator.stop(1)

vibrator.getSystemDefaultMode()

Get the system's default vibration mode.

Parameters:

None

Return Values:

Type	Description
Number	0: Vibration off; 1: Standard vibration; 2: Enhanced vibration.

Example:

vibrator.getSystemDefaultMode()

Support Details

Interface	Supported Device Products	Unsupported Device Products
vibrate	Xiaomi S1 Pro Sports & Health Watch, Xiaomi Band 8 Pro, Xiaomi Band 9 / 9 Pro, Redmi Watch 4, Xiaomi Watch H1, Xiaomi Watch S3, Xiaomi Band 10, Xiaomi Watch S4, REDMI Watch 5	-
start	-	Xiaomi Watch S3, Xiaomi Watch S4, REDMI Watch 5, Xiaomi S1 Pro Sports & Health Watch, Xiaomi Band 8 Pro, Xiaomi Band 9 / 9 Pro, Xiaomi Band 10, Redmi Watch 4, Xiaomi Watch H1
stop	-	Xiaomi Watch S3, Xiaomi Watch S4, REDMI Watch 5, Xiaomi S1 Pro Sports & Health Watch, Xiaomi Band 8 Pro, Xiaomi Band 9 / 9 Pro, Xiaomi Band 10, Redmi Watch 4, Xiaomi Watch H1
getSystemDefaultMode	-	Xiaomi Watch S3, Xiaomi Watch S4, REDMI Watch 5, Xiaomi S1 Pro Sports & Health Watch, Xiaomi Band 8 Pro, Xiaomi Band 9 / 9 Pro, Xiaomi Band 10, Redmi Watch 4, Xiaomi Watch H1