react-native-sensors

Supported React Native Versions

React Native Version	react-native-sensors Version
<= 39	< 1.0
>= 40	>= 1.0

Cool Projects using `react-native-sensors`

Do you want your project listed here? Just send a PR.

Getting started

$ npm install react-native-sensors --save

Automatic installation

$ react-native link react-native-sensors

Option: With CocoaPods (iOS only)

Add the following to your Podfile and run $ pod install:

pod 'RNSensors', :path => '../node_modules/react-native-sensors'

Manual installation

iOS

In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
Go to node_modules ➜ react-native-sensors and add RNSensors.xcodeproj
In XCode, in the project navigator, select your project. Add libRNSensors.a to your project's Build Phases ➜ Link Binary With Libraries
Run your project (Cmd+R)<

Android

Open up android/app/src/main/java/[...]/MainApplication.java

Add import com.sensors.RNSensorsPackage; to the imports at the top of the file
Add new RNSensorsPackage() to the list returned by the getPackages() method

Append the following lines to android/settings.gradle:

include ':react-native-sensors'
project(':react-native-sensors').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-sensors/android')

Insert the following lines inside the dependencies block in android/app/build.gradle:
```
  compile project(':react-native-sensors')
```

Usage

Sensor API

import { Accelerometer, Gyroscope } from "react-native-sensors";

let accelerationObservable = null;
new Accelerometer({
	updateInterval: 400 // defaults to 100ms
})
	.then(observable => {
		accelerationObservable = observable;

		// Normal RxJS functions
		accelerationObservable
			.map(({ x, y, z }) => x + y + z)
			.filter(speed => speed > 20)
			.subscribe(speed => console.log(`You moved your phone with ${speed}`));
	})
	.catch(error => {
		console.log("The sensor is not available");
	});

setTimeout(() => {
	accelerationObservable.stop();
}, 1000);

Decorator usage

import React, { Component } from "react";
import { Text, View } from "react-native";
import { decorator as sensors } from "react-native-sensors";

class MyComponent {
	// no lifecycle needed
	render() {
		const { sensorsFound, Accelerometer, Gyroscope } = this.props;

		if (!Accelerometer || !Gyroscope) {
			// One of the sensors is still initializing
			return null;
		}

		return (
			<View style={styles.container}>
				<Text style={styles.welcome}>
					{(sensorsFound["Accelerometer"] &&
						`Acceleration has value: ${Accelerometer}`) ||
						"Acceleration is not available"}
					{(sensorsFound["Gyroscope"] && `Gyro has value: ${Gyroscope}`) ||
						"Gyro is not available"}
				</Text>
			</View>
		);
	}
}

export default sensors({
	Accelerometer: {
		updateInterval: 300 // optional
	},
	Gyroscope: true
})(MyComponent);

Changelog

Please see the changelog here

Credits

This project is inspired by the react-native-sensor-manager and by the react-native-motion-manager. Both have similar solutions with a non-uniform interface and this project aims to unify both.

Contributors

Thanks goes to these wonderful people (emoji key):

_{Daniel Schmidt} 💻	_Noitidart 📖	_{Christophe Lemonnier} 💻	_Gennady 📖	_{Jiaming Lu} 💻	_{Alex Wasner} 💻	_{Nam Đàm} 💻
_{Mike Knapp} 💻	_{Kevin Gonnord} 💻	_ImAtome 💻	_{Lisa Huynh} 💻	_{Cory Smith} 💻	_{Esa-Matti Suuronen} 💻	_{Viet Nguyen} 💻
_{Simon Bengtsson} 💻	_{maxkomarychev} 💻	_{Alexander Baygeldin} 💻	_{Noane Dan} 💻