Options
All
  • Public
  • Public/Protected
  • All
Menu

@openhps/react-native

OpenHPS
@openhps/react-native

Build Status Maintainability

@openhps/coreAPI


This component offers react-native nodes. Each node uses peer dependencies for

Features

  • IMUSourceNode: IMU source node that uses the internal sensors.
  • BLESourceNode: BLE source node that scans for (specific) BLE advertisements
  • WLANSourceNode: WLAN source node that scans for Wi-Fi access points.
  • GeolocationSourceNode: Processed geolocation data from native APIs.

Peer Dependencies

@openhps/react-native uses peer dependencies to create OpenHPS compatible data frames. When using a certain source node, you will have to install one or more of these dependencies manually.

Getting Started

If you have npm installed, start using @openhps/react-native with the following command.

npm install @openhps/react-native --save

Usage

BLESourceNode

The BLE source node scans for Bluetooth low energy devices using react-native-ble-plx as a peer dependency.

IMUSourceNode

The IMU source node uses react-native-sensors as a peer depedency to gather magnetometer, gyroscope, accelerometer and orientation data in an IMUDataFrame.

WLANSourceNode

With the WLAN source node that uses react-native-wifi-reborn as a peer dependency, you can get a complete scan list of Wi-Fi access points.

GeolocationSourceNode

High level geolocation source node using react-native-geolocation-service.

Contributors

The framework is open source and is mainly developed by PhD Student Maxim Van de Wynckel as part of his research towards Hybrid Positioning and Implicit Human-Computer Interaction under the supervision of Prof. Dr. Beat Signer.

Contributing

Use of OpenHPS, contributions and feedback is highly appreciated. Please read our contributing guidelines for more information.

License

Copyright (C) 2019-2021 Maxim Van de Wynckel & Vrije Universiteit Brussel

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.