A library that provides access to the device's gyroscope sensor.
GitHub
npm
Gyroscope
from expo-sensors
provides access to the device's gyroscope sensor to respond to changes in rotation in three-dimensional space.
-
npx expo install expo-sensors
If you are installing this in an existing React Native app, start by installing expo
in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.
import { useState, useEffect } from 'react';
import { StyleSheet, Text, TouchableOpacity, View } from 'react-native';
import { Gyroscope } from 'expo-sensors';
export default function App() {
const [{ x, y, z }, setData] = useState({
x: 0,
y: 0,
z: 0,
});
const [subscription, setSubscription] = useState(null);
const _slow = () => Gyroscope.setUpdateInterval(1000);
const _fast = () => Gyroscope.setUpdateInterval(16);
const _subscribe = () => {
setSubscription(
Gyroscope.addListener(gyroscopeData => {
setData(gyroscopeData);
})
);
};
const _unsubscribe = () => {
subscription && subscription.remove();
setSubscription(null);
};
useEffect(() => {
_subscribe();
return () => _unsubscribe();
}, []);
return (
<View style={styles.container}>
<Text style={styles.text}>Gyroscope:</Text>
<Text style={styles.text}>x: {x}</Text>
<Text style={styles.text}>y: {y}</Text>
<Text style={styles.text}>z: {z}</Text>
<View style={styles.buttonContainer}>
<TouchableOpacity onPress={subscription ? _unsubscribe : _subscribe} style={styles.button}>
<Text>{subscription ? 'On' : 'Off'}</Text>
</TouchableOpacity>
<TouchableOpacity onPress={_slow} style={[styles.button, styles.middleButton]}>
<Text>Slow</Text>
</TouchableOpacity>
<TouchableOpacity onPress={_fast} style={styles.button}>
<Text>Fast</Text>
</TouchableOpacity>
</View>
</View>
);
}
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: 'center',
paddingHorizontal: 10,
},
text: {
textAlign: 'center',
},
buttonContainer: {
flexDirection: 'row',
alignItems: 'stretch',
marginTop: 15,
},
button: {
flex: 1,
justifyContent: 'center',
alignItems: 'center',
backgroundColor: '#eee',
padding: 10,
},
middleButton: {
borderLeftWidth: 1,
borderRightWidth: 1,
borderColor: '#ccc',
},
});
import { Gyroscope } from 'expo-sensors';
Gyroscope
Type: Class extends DeviceSensor<GyroscopeMeasurement>
A base class for subscribable sensors. The events emitted by this class are measurements
specified by the parameter type Measurement
.
Gyroscope Methods
addListener(listener)
Parameter | Type | Description |
---|---|---|
listener | Listener<GyroscopeMeasurement> | A callback that is invoked when a gyroscope update is available. When invoked,
the listener is provided a single argument that is an |
Subscribe for updates to the gyroscope.
A subscription that you can call remove()
on when you would like to unsubscribe the listener.
hasListeners()
Returns boolean which signifies if sensor has any listeners registered.
boolean
isAvailableAsync()
You should always check the sensor availability before attempting to use it.
Returns whether the gyroscope is enabled on the device.
On mobile web, you must first invoke Gyroscope.requestPermissionsAsync()
in a user interaction (i.e. touch event) before you can use this module.
If the status
is not equal to granted
then you should inform the end user that they may have to open settings.
On web this starts a timer and waits to see if an event is fired. This should predict if the iOS device has the device orientation API disabled in
Settings > Safari > Motion & Orientation Access. Some devices will also not fire if the site isn't hosted with HTTPS as DeviceMotion
is now considered a secure API.
There is no formal API for detecting the status of DeviceMotion
so this API can sometimes be unreliable on web.
Promise<boolean>
A promise that resolves to a boolean
denoting the availability of the gyroscope.
removeSubscription(subscription)
Parameter | Type | Description |
---|---|---|
subscription | Subscription | A subscription to remove. |
Removes the given subscription.
void
setUpdateInterval(intervalMs)
Parameter | Type | Description |
---|---|---|
intervalMs | number | Desired interval in milliseconds between sensor updates.
|
Set the sensor update interval.
void
PermissionResponse
An object obtained by permissions get and request functions.
PermissionResponse Properties
Name | Type | Description |
---|---|---|
canAskAgain | boolean | Indicates if user can be asked again for specific permission. If not, one should be directed to the Settings app in order to enable/disable the permission. |
expires | PermissionExpiration | Determines time when the permission expires. |
granted | boolean | A convenience boolean that indicates if the permission is granted. |
status | PermissionStatus | Determines the status of the permission. |
GyroscopeMeasurement
Each of these keys represents the rotation along that particular axis measured in degrees per second (°/s).
Name | Type | Description |
---|---|---|
timestamp | number | Timestamp of the measurement in seconds. |
x | number | Value of rotation in degrees per second device reported in X axis. |
y | number | Value of rotation in degrees per second device reported in Y axis. |
z | number | Value of rotation in degrees per second device reported in Z axis. |
PermissionExpiration
Literal Type: multiple types
Permission expiration time. Currently, all permissions are granted permanently.
Acceptable values are: 'never'
| number
Subscription
Name | Type | Description |
---|---|---|
remove | () => void | A method to unsubscribe the listener. |
PermissionStatus
PermissionStatus Values
UNDETERMINED
PermissionStatus.UNDETERMINED = "undetermined"
User hasn't granted or denied the permission yet.