https://github.com/cawfree/react-native-sensor-fusion

Robust absolute positioning in React Native.
https://github.com/cawfree/react-native-sensor-fusion

3d filter kalman native position react react-native sensor

Last synced: 3 months ago
JSON representation

Robust absolute positioning in React Native.

• Host: GitHub
• URL: https://github.com/cawfree/react-native-sensor-fusion
• Owner: cawfree
• License: mit
• Created: 2019-11-02T13:44:55.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-14T20:24:43.000Z (over 1 year ago)
• Last Synced: 2024-05-01T14:49:30.306Z (10 months ago)
• Topics: 3d, filter, kalman, native, position, react, react-native, sensor
• Language: JavaScript
• Homepage:
• Size: 7.81 KB
• Stars: 30
• Watchers: 6
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-native-sensor-fusion

Robust absolute 3D positioning in React Native, using [sensor fusion](https://en.wikipedia.org/wiki/Sensor_fusion) to exploit the superior characterstics of the device Accelerometer, Gyroscope and Magnetometer, whilst mitigating against their negative qualities.

Physical data acquisition is implemented using [react-native-sensors](https://github.com/react-native-sensors/). The noise in sampled data is filtered from the input signals using the high quality [kalmanjs](https://github.com/wouterbulten/kalmanjs), and sensor fusion is calculated using [ahrs](https://github.com/psiphi75/ahrs).

## 🚀 Getting Started

Using [`npm`]():

```sh

npm install --save react-native-sensor-fusion

```

Using [`yarn`]():

```sh

yarn add react-native-sensor-fusion

```

## ✍️ Example

```javascript

import React from 'react';

import { Text } from 'react-native';

import SensorFusionProvider, { useSensorFusion, useCompass, toDegrees } from 'react-native-sensor-fusion';

const Indicator = () => {

  const { ahrs } = useSensorFusion();  

  const { x, y, z, w } = ahrs.toVector();

  return (

    

  );

const Indicator = () => {

  const { ahrs } = useSensorFusion();

  const { heading, pitch, roll } = ahrs.getEulerAngles();

  const compass = useCompass();

  return (

    

      Heading: {toDegrees(heading)}°{'\n'}

      Pitch: {toDegrees(pitch)}°{'\n'}

      Roll: {toDegrees(roll)}°{'\n'}

      Compass: {toDegrees(compass)}°{'\n'}

    

  );

};

export default () => (

  

    

  

);

```

## 📌 Prop Types

-----

Prop                  | Type     | Default                   | Required | Description

--------------------- | -------- | ------------------------- | -------- | -----------

sampleInterval|number|60|No|The frequency to sample the device sensors in Hz.

algorithm|string|'Mahony'|No|Choose from the `Madgwick` or `Mahony` filter.

beta|number|0.4|No|The filter noise value, smaller values have smoother estimates, but have higher latency. This only works for the `Madgwick` filter.

kp|number|0.5|No|The filter noise values for the `Mahony` filter (Proportional).

ki|number|0|No|The filter noise values for the `Mahony` filter (Integral).

## ✌️ License

[MIT](https://opensource.org/licenses/MIT)