@mkay4real/react-native-nearby-api
v1.0.2
Published
React Native wrapper around Google's Nearby API SDK
Downloads
72
Maintainers
Readme
react-native-nearby-api
This is a React Native wrapper for the Google Nearby Messages API. It is a fork of this repository by badfeatures.
Noteable changes to the original respository
- Rewritten in Typescript
- Autolinking support for React Native 0.60 and above.
- Android X support
- Upgraded to [email protected] on Android
- Upgraded to Gradle 3.5.2
Getting started
$ yarn add @mkay4real/react-native-nearby-api
Installation
iOS
cd ios/ pod install
- Build and run project
Android
There are no additional steps required for Android
Usage
See the example app for more detail and code examples.
Retrieve your API Keys from the Google Console iOS | Android
Add the correct permissions to the AndroidManifest.
<!-- Include if wish to use BLE --> <uses-permission android:name="android.permission.BLUETOOTH"/> <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/> <!-- Include if wish to use audio --> <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.RECORD_AUDIO" />
Add the Android API Key in the AndroidManifest .
<meta-data android:name="com.google.android.nearby.messages.API_KEY" android:value="MY_API_KEY" />
The iOS API key will be supplied through the
connect()
method.Add
NSBluetoothPeripheralUsageDescription
to the Info.plistAdd
NSMicrophoneUsageDescription
to the iOS project's Info.plist if using audio
import NearbyApi from 'react-native-nearby-api';
const nearbyAPI = new NearbyAPI(true); // Use BLE only, no audio.
nearbyAPI.onConnected((message) => {
console.log(message);
});
nearbyAPI.onDisconnected((message) => {
console.log(message);
});
nearbyAPI.onFound((message) => {
console.log('Message Found!');
console.log(message);
});
nearbyAPI.onLost((message) => {
console.log('Message Lost!');
console.log(message);
});
// Android Only
nearbyAPI.onDistanceChanged((message, value) => {
console.log('Distance Changed!');
console.log(message, value);
});
// Android Only
nearbyAPI.onBLESignalChanged((message, value) => {
console.log('BLE Signal Changed!');
console.log(message, value);
});
nearbyAPI.onPublishSuccess((message) => {
console.log(message);
});
nearbyAPI.onPublishFailed((message) => {
console.log(message);
});
nearbyAPI.onSubscribeSuccess(() => {});
nearbyAPI.onSubscribeFailed(() => {});
// To connect from Google API Client
nearbyAPI.connect(API_KEY);
// To check if the nearby API is connected.
nearbyAPI.isConnected((connected, error) => {
console.log(connected);
});
// To disconnect later
nearbyAPI.disconnect();
// To publish to nearby devices
nearbyAPI.publish('Hello World!');
// To check if the nearby API is publishing.
nearbyAPI.isPublishing((publishing, error) => {
console.log(publishing);
});
// To subscribe to nearby devices broadcasting
nearbyAPI.subscribe();
// To check if the nearby API is subscribing.
nearbyAPI.isSubscribing((subscribing, error) => {
console.log(subscribing);
});
// To unpublish
nearbyAPI.unpublish();
// To unsubscribe
nearbyAPI.unsubscribe();
Running the Example
Install the dependencies in the root folder
yarn
Generate an API Key from the Google Developer Console
- Go to the Google Developers Console.
- Create or select a project to register your application with.
- Click Continue to Enable the API.
- On the Credentials page, create a new API Key. (No key restrictions are needed for this example)
- Copy/Paste your key in example/index.js and in the example AndroidManifest.xml
Android
- To run the example app, the packager must have the
projectRoots
reordered for the example/ directory. In another terminal window:
yarn start --projectRoots <FULL-PATH-TO-REPO>/react-native-nearby-api/example,<FULL-PATH-TO-REPO>/react-native-nearby-api
yarn run:android
adb reverse tcp:8081 tcp:8081
iOS
cd example ios/
bundle exec pod install
- Open
example.xcworkspace
- Add your IP to
AppDelegate.m
jsCodeLocation = [NSURL URLWithString:@"http://<IP-ADDRESS>:8081/index.bundle?platform=ios&dev=true"];
- In another terminal window:
yarn start
- Run on device
Common issues
iOS compilation error: duplicate symbols for architecture
Cause
This is caused by a conflict of the AddLogSink
and RemoveLogSink
functions in the glog
and NearbyMessages
library.
Workaround
Add the following to your Podfile.
post_install do |installer|
puts "Renaming logging functions"
root = File.dirname(installer.pods_project.path)
Dir.chdir(root);
Dir.glob("**/*.{h,cc,cpp,in}") {|filename|
filepath = root + "/" + filename
text = File.read(filepath)
addText = text.gsub!(/(?<!React)AddLogSink/, "ReactAddLogSink")
if addText
File.chmod(0644, filepath)
f = File.open(filepath, "w")
f.write(addText)
f.close
end
text2 = addText ? addText : text
removeText = text2.gsub!(/(?<!React)RemoveLogSink/, "ReactRemoveLogSink")
if removeText
File.chmod(0644, filepath)
f = File.open(filepath, "w")
f.write(removeText)
f.close
end
}
end
iOS compilation error: Multiple commands produce Assets.car.
Details
This is casued by an issue in the NearbyMessage
podspec. This only affects bulids using the "New Build System" in Xcode.
Work around
Add the following to your Podfile
post_install do |installer|
project_path = 'example.xcodeproj'
project = Xcodeproj::Project.open(project_path)
project.targets.each do |target|
build_phase = target.build_phases.find { |bp| bp.display_name == '[CP] Copy Pods Resources' }
assets_path = '${TARGET_BUILD_DIR}/${UNLOCALIZED_RESOURCES_FOLDER_PATH}/Assets.car'
if build_phase.present? && build_phase.output_paths.include?(assets_path) == true
build_phase.output_paths.delete(assets_path)
end
end
project.save(project_path)
end