Gyroscope

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The Gyroscope interface of the Sensor APIs provides on each reading the angular velocity of the device along all three axes.

To use this sensor, the user must grant permission to the 'gyroscope' device sensor through the Permissions API. In addition, this feature may be blocked by a Permissions Policy set on your server.

Constructor

Gyroscope(): Creates a new Gyroscope object.

Instance properties

Gyroscope.x Read only: Returns a double, containing the angular velocity of the device along the device's x axis.
Gyroscope.y Read only: Returns a double, containing the angular velocity of the device along the device's y axis.
Gyroscope.z Read only: Returns a double, containing the angular velocity of the device along the device's z axis.

Instance methods

Gyroscope doesn't have own methods. However, it inherits methods from its parent interfaces, Sensor and EventTarget.

Events

Gyroscope doesn't have own events. However, it inherits events from its parent interface, Sensor.

Example

The gyroscope is typically read in the reading event callback. In the example below this occurs sixty times a second.

let gyroscope = new Gyroscope({ frequency: 60 });

gyroscope.addEventListener("reading", (e) => {
  console.log(`Angular velocity along the X-axis ${gyroscope.x}`);
  console.log(`Angular velocity along the Y-axis ${gyroscope.y}`);
  console.log(`Angular velocity along the Z-axis ${gyroscope.z}`);
});
gyroscope.start();

Specifications

Specification
Gyroscope # gyroscope-interface

Browser compatibility

BCD tables only load in the browser