react-native-machine-info
Device Information for React Native.
TOC
Installation
Using npm:
npm install --save react-native-machine-info
or using yarn:
yarn add react-native-machine-info
⚠️ If you are on React Native > 0.47, you must use version 0.11.0 of this library or higher
Linking
Automatic
react-native link react-native-machine-info
(or using rnpm
for versions of React Native < 0.27)
rnpm link react-native-machine-info
For iOS users using Pods
You still need to run pod install
after running the above link command inside your IOS
folder.
Manual
iOS (via CocoaPods)
Add the following line to your build targets in your Podfile
pod 'RNDeviceInfo', :path => '../node_modules/react-native-machine-info'
Then run pod install
iOS (without CocoaPods)
In XCode, in the project navigator:
- Right click Libraries
- Add Files to [your project's name]
- Go to
node_modules/react-native-machine-info
- Add the
.xcodeproj
file
In XCode, in the project navigator, select your project.
- Add the
libRNDeviceInfo.a
from the deviceinfo project to your project's Build Phases ➜ Link Binary With Libraries - Click
.xcodeproj
file you added before in the project navigator and go the Build Settings tab. Make sure All is toggled on (instead of Basic). - Look for Header Search Paths and make sure it contains both
$(SRCROOT)/../react-native/React
and$(SRCROOT)/../../React
- Mark both as recursive (should be OK by default).
Run your project (Cmd+R)
(Thanks to @brysgo for writing the instructions)
Android
- optional in
android/build.gradle
:
... ext { // dependency versions googlePlayServicesVersion = "<Your play services version>" // default: "+" compileSdkVersion = "<Your compile SDK version>" // default: 23 buildToolsVersion = "<Your build tools version>" // default: "25.0.2" targetSdkVersion = "<Your target SDK version>" // default: 22 }...
- in
android/app/build.gradle
:
dependencies { ... implementation "com.facebook.react:react-native:+" // From node_modules+ implementation project(':react-native-machine-info')}
- in
android/settings.gradle
:
...include ':app'+ include ':react-native-machine-info'+ project(':react-native-machine-info').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-machine-info/android')
With React Native 0.29+
- in
MainApplication.java
:
+ import com.learnium.RNDeviceInfo.RNDeviceInfo; public class MainApplication extends Application implements ReactApplication { //...... @Override protected List<ReactPackage> getPackages() { return Arrays.<ReactPackage>asList(+ new RNDeviceInfo(), new MainReactPackage() ); } ...... }
With older versions of React Native:
- in
MainActivity.java
:
+ import com.learnium.RNDeviceInfo.RNDeviceInfo; public class MainActivity extends ReactActivity { ...... @Override protected List<ReactPackage> getPackages() { return Arrays.<ReactPackage>asList(+ new RNDeviceInfo(), new MainReactPackage() ); } }
NOTE: If you faced with this error: Could not resolve all files for configuration ':react-native-machine-info:debugCompileClasspath'.
, in build.gradle
put google()
in the first line (according to https://stackoverflow.com/a/50748249)
- in
android/build.gradle
:
allprojects { repositories {+ google() ... }}
(Thanks to @chirag04 for writing the instructions)
Windows
- Open the solution in Visual Studio for your Windows apps
- right click your in the Explorer and click Add > Existing Project...
- Navigate to
./<app-name>/node_modules/react-native-machine-info/windows/RNDeviceInfo
and addRNDeviceInfo.csproj
- this time right click on your React Native Windows app under your solutions directory and click Add > Reference...
- check the
RNDeviceInfo
you just added and press ok - open up
MainReactNativeHost.cs
for your app and edit the file like so:
+ using RNDeviceInfo;...... protected override List<IReactPackage> Packages => new List<IReactPackage> { new MainReactPackage(),+ new RNDeviceInfoPackage(), };
(Thanks to @josephan for writing the instructions)
Usage
;
API
Method | Return Type | iOS | Android | Windows | Since |
---|---|---|---|---|---|
getAPILevel() | number |
❌ | ✅ | ❌ | 0.12.0 |
getApplicationName() | string |
✅ | ✅ | ✅ | 0.14.0 |
getBatteryLevel() | Promise<number> |
✅ | ✅ | ✅ | 0.18.0 |
getBrand() | string |
✅ | ✅ | ✅ | 0.9.3 |
getBuildNumber() | string |
✅ | ✅ | ✅ | ? |
getBundleId() | string |
✅ | ✅ | ✅ | ? |
getCameraPresence() | Promise<boolean> |
❌ | ✅ | ✅ | ? |
getCarrier() | string |
✅ | ✅ | ❌ | 0.13.0 |
getDeviceCountry() | string |
✅ | ✅ | ✅ | 0.9.0 |
getDeviceId() | string |
✅ | ✅ | ✅ | 0.5.0 |
getDeviceLocale() | string |
✅ | ✅ | ✅ | 0.7.0 |
getPreferredLocales() | Array<string> |
✅ | ✅ | ❌ | ? |
getDeviceName() | string |
✅ | ✅ | ✅ | ? |
getFirstInstallTime() | number |
❌ | ✅ | ✅ | 0.12.0 |
getFontScale() | number |
✅ | ✅ | ❌ | 0.15.0 |
getFreeDiskStorage() | number |
✅ | ✅ | ❌ | 0.15.0 |
getIPAddress() | Promise<string> |
✅ | ✅ | ✅ | 0.12.0 |
getInstallReferrer() | string |
❌ | ✅ | ❌ | 0.19.0 |
getInstanceID() | string |
❌ | ✅ | ❌ | ? |
getLastUpdateTime() | number |
❌ | ✅ | ❌ | 0.12.0 |
getMACAddress() | Promise<string> |
✅ | ✅ | ❌ | 0.12.0 |
getManufacturer() | string |
✅ | ✅ | ✅ | ? |
getMaxMemory() | number |
❌ | ✅ | ✅ | 0.14.0 |
getModel() | string |
✅ | ✅ | ✅ | ? |
getPhoneNumber() | string |
❌ | ✅ | ❌ | 0.12.0 |
getPowerState() | Promise<object> |
✅ | ❌ | ❌ | |
getReadableVersion() | string |
✅ | ✅ | ✅ | ? |
getSerialNumber() | string |
❌ | ✅ | ❌ | 0.12.0 |
getSystemName() | string |
✅ | ✅ | ✅ | ? |
getSystemVersion() | string |
✅ | ✅ | ✅ | ? |
getBuildId() | string |
✅ | ✅ | ❌ | ? |
getTimezone() | string |
✅ | ✅ | ✅ | ? |
getTotalDiskCapacity() | number |
✅ | ✅ | ❌ | 0.15.0 |
getTotalMemory() | number |
✅ | ✅ | ❌ | 0.14.0 |
getUniqueID() | string |
✅ | ✅ | ✅ | ? |
getUserAgent() | string |
✅ | ✅ | ❌ | 0.7.0 |
getVersion() | string |
✅ | ✅ | ✅ | ? |
is24Hour() | boolean |
✅ | ✅ | ✅ | 0.13.0 |
isAirPlaneMode() | Promise<boolean> |
❌ | ✅ | ❌ | 0.25.0 |
isBatteryCharging() | Promise<boolean> |
✅ | ✅ | ❌ | 0.27.0 |
isEmulator() | boolean |
✅ | ✅ | ✅ | ? |
isPinOrFingerprintSet() | (callback)boolean |
✅ | ✅ | ✅ | 0.10.1 |
isTablet() | boolean |
✅ | ✅ | ✅ | ? |
hasNotch() | boolean |
✅ | ✅ | ✅ | 0.23.0 |
isLandscape() | boolean |
✅ | ✅ | ✅ | 0.24.0 |
getDeviceType() | string |
✅ | ✅ | ❌ | ? |
isAutoDateAndTime() | boolean |
❌ | ✅ | ❌ | 0.29.0 |
isAutoTimeZone() | boolean |
❌ | ✅ | ❌ | 0.29.0 |
supportedABIs() | string[] |
✅ | ✅ | ❌ | 1.1.0 |
hasSystemFeature() | Promise<boolean> |
❌ | ✅ | ❌ | ? |
getSystemAvailableFeatures() | Promise<string[]> |
❌ | ✅ | ❌ | ? |
isLocationEnabled() | Promise<boolean> |
✅ | ✅ | ❌ | ? |
getAvailableLocationProviders() | Promise<Object> |
✅ | ✅ | ❌ | ? |
getAPILevel()
Gets the API level.
Examples
const apiLevel = DeviceInfo; // iOS: ?// Android: 25// Windows: ?
Notes
See API Levels
getApplicationName()
Gets the application name.
Examples
const appName = DeviceInfo; // "Learnium Mobile"
getBatteryLevel()
Gets the battery level of the device as a float comprised between 0 and 1.
Examples
DeviceInfo;
Notes
To be able to get actual battery level enable battery monitoring mode for application. Add this code:
.batteryMonitoringEnabled = true;
to AppDelegate.m application:didFinishLaunchingWithOptions:
Returns -1 on the iOS Simulator
getBrand()
Gets the device brand.
Examples
const brand = DeviceInfo; // iOS: "Apple"// Android: "Xiaomi"// Windows: ?
getBuildNumber()
Gets the application build number.
Examples
const buildNumber = DeviceInfo; // iOS: "89"// Android: 4// Windows: ?
Notes
There is a type inconsistency: Android return an integer instead of the documented string.
getBundleId()
Gets the application bundle identifier.
Examples
const bundleId = DeviceInfo; // "com.learnium.mobile"
getCameraPresence()
Tells if the device have any camera now.
Examples
DeviceInfo ;
Notes
- Hot add/remove of camera is supported.
- Returns the status of the physical presence of the camera. If camera present but your app don't have permissions to use it, getCameraPresence will still return the true
getCarrier()
Gets the carrier name (network operator).
Examples
const carrier = DeviceInfo; // "SOFTBANK"
getDeviceCountry()
Gets the device country based on the locale information.
Examples
const deviceCountry = DeviceInfo; // "US"
getDeviceId()
Gets the device ID.
Examples
const deviceId = DeviceInfo; // iOS: "iPhone7,2"// Android: "goldfish"// Windows: ?
getDeviceLocale()
Gets the device locale.
Examples
const deviceLocale = DeviceInfo; // iOS: "en"// Android: "en-US"// Windows: ?
getPreferredLocales()
Gets the preferred locales defined by the user.
Examples
const preferredLocales = DeviceInfo; // iOS: "[es-ES, en-US]"// Android: "[es-ES, en-US]"// Windows: ?
getDeviceName()
Gets the device name.
Examples
const deviceName = DeviceInfo; // iOS: "Becca's iPhone 6"// Android: ?// Windows: ?
Android Permissions
getFirstInstallTime()
Gets the time at which the app was first installed, in milliseconds.
Examples
const firstInstallTime = DeviceInfo; // Android: 1517681764528
getFontScale()
Gets the device font scale. The font scale is the ratio of the current system font to the "normal" font size, so if normal text is 10pt and the system font is currently 15pt, the font scale would be 1.5 This can be used to determine if accessability settings has been changed for the device; you may want to re-layout certain views if the font scale is significantly larger ( > 2.0 )
In iOS App Extensions this call always returns 1.0, see #625.
Examples
const fontScale = DeviceInfo; // 1.2
getFreeDiskStorage()
Gets available storage size, in bytes.
Examples
const freeDiskStorage = DeviceInfo; // Android: 17179869184// iOS: 17179869184
Notes
From developer.android.com:
Return the primary shared/external storage directory.
Note: don't be confused by the word "external" here. This directory can better be thought as media/shared storage. It is a filesystem that can hold a relatively large amount of data and that is shared across all applications (does not enforce permissions). Traditionally this is an SD card, but it may also be implemented as built-in storage in a device that is distinct from the protected internal storage and can be mounted as a filesystem on a computer.
getIPAddress()
Gets the device current IP address.
Examples
DeviceInfo;
Android Permissions
Notes
Support for iOS was added in 0.22.0
getInstallReferrer()
Gets the referrer string upon application installation.
Examples
const referrer = DeviceInfo; // If the app was installed from https://play.google.com/store/apps/details?id=com.myapp&referrer=my_install_referrer// the result will be "my_install_referrer"
getInstanceID()
Gets the application instance ID.
Examples
const instanceId = DeviceInfo; // Android: ?
Notes
getLastUpdateTime()
Gets the time at which the app was last updated, in milliseconds.
Examples
const lastUpdateTime = DeviceInfo; // Android: 1517681764992
getMACAddress()
Gets the network adapter MAC address.
Examples
DeviceInfo;
Android Permissions
Notes
iOS: This method always return "02:00:00:00:00:00" as retrieving the MAC address is disabled since iOS 7
getManufacturer()
Gets the device manufacturer.
Examples
const manufacturer = DeviceInfo; // iOS: "Apple"// Android: "Google"// Windows: ?
getMaxMemory()
Returns the maximum amount of memory that the VM will attempt to use, in bytes.
Examples
const maxMemory = DeviceInfo; // 402653183
getModel()
Gets the device model.
iOS warning: The list with device names is maintained by the community and could lag new devices. It is recommended to use getDeviceId()
since it's more reliable and always up-to-date with new iOS devices. We do accept pull requests that add new iOS devices to the list with device names.
Examples
const model = DeviceInfo; // iOS: ?// Android: ?// Windows: ?
getPhoneNumber()
Gets the device phone number.
Examples
const phoneNumber = DeviceInfo; // Android: null return: no permission, empty string: unprogrammed or empty SIM1, e.g. "+15555215558": normal return value
Android Permissions
Notes
This can return
undefined
in certain cases and should not be relied on. SO entry on the subject.
getPowerState()
Gets the power state of the device including the battery level, whether it is plugged in, and if the system is currently operating in low power mode. Displays a warning on iOS if battery monitoring not enabled, or if attempted on an emulator (where monitoring is not possible)
Examples
DeviceInfo;
getReadableVersion()
Gets the application human readable version.
Examples
const readableVersion = DeviceInfo; // iOS: 1.0.1// Android: 1.0.1// Windows: ?
getSerialNumber()
Gets the device serial number.
Examples
const serialNumber = DeviceInfo; // iOS: undefined// Android: ?// Windows: ?
getSystemName()
Gets the device OS name.
Examples
const systemName = DeviceInfo; // iOS: "iOS" on newer iOS devices "iPhone OS" on older devices, including older iPad's.// Android: "Android"// Windows: ?
getSystemVersion()
Gets the device OS version.
Examples
const systemVersion = DeviceInfo; // iOS: "11.0"// Android: "7.1.1"// Windows: ?
getBuildId()
Gets build number of the operating system.
Examples
const osBuildId = DeviceInfo; // iOS: "12A269"// tvOS: not available// Android: "13D15"// Windows: not available
getTimezone()
Gets the device default timezone.
Examples
const timezone = DeviceInfo; // "Africa/Tunis"
getTotalDiskCapacity()
Gets full disk storage size, in bytes.
Examples
const storageSize = DeviceInfo; // Android: 17179869184// iOS: 17179869184
getTotalMemory()
Gets the device total memory, in bytes.
Examples
const totalMemory = DeviceInfo; // 1995018240
getUniqueID()
Gets the device unique ID.
Examples
const uniqueId = DeviceInfo; // iOS: "FCDBD8EF-62FC-4ECB-B2F5-92C9E79AC7F9"// Android: "dd96dec43fb81c97"// Windows: ?
Notes
- iOS: This is
IDFV
so it will change if all apps from the current apps vendor have been previously uninstalled.- android: Prior to Oreo, this id (ANDROID_ID) will always be the same once you set up your phone.
getUserAgent()
Gets the device User Agent.
Examples
const userAgent = DeviceInfo; // iOS: "Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13B143"// tvOS: not available// Android: ?// Windows: ?
getVersion()
Gets the application version.
Examples
const version = DeviceInfo; // iOS: "1.0"// Android: "1.0"// Windows: ?
is24Hour()
Tells if the user preference is set to 24-hour format.
Examples
const is24Hour = DeviceInfo; // true
isAirPlaneMode()
Tells if the device is in AirPlaneMode.
Examples
DeviceInfo;
Notes
- This only works if the remote debugger is disabled.
isBatteryCharging()
Tells if the battery is currently charging.
Examples
DeviceInfo;
isEmulator()
Tells if the application is running in an emulator.
Examples
const isEmulator = DeviceInfo; // false
isPinOrFingerprintSet()
Tells if a PIN number or a fingerprint was set for the device.
Examples
DeviceInfo { if !isPinOrFingerprintSet // ... };
Notes
- Since the device setting for PIN/Fingerprint can be modified while the app is still open, this is available via callback instead of as a constant.
- iOS: Not supported for iOS < 9
isTablet()
Tells if the device is a tablet.
Examples
const isTablet = DeviceInfo; // true
isLandscape()
Tells if the device is currently in landscape mode.
Examples
const isLandscape = DeviceInfo; // true
hasNotch()
Tells if the device has a notch.
Examples
const hasNotch = DeviceInfo; // true
getDeviceType()
Returns the device's type as a string, which will be one of:
Handset
Tablet
Tv
Unknown
Examples
const deviceType = DeviceInfo; // 'Handset'
isAutoDateAndTime()
Tells if the automatic date & time setting is enabled on the phone.
Examples
DeviceInfo;
isAutoTimeZone()
Tells if the automatic time zone setting is enabled on the phone.
Examples
DeviceInfo;
supportedABIs()
Returns a list of supported processor architecture version
Examples
DeviceInfo; // [ "arm64 v8", "Intel x86-64h Haswell", "arm64-v8a", "armeabi-v7a", "armeabi" ]
hasSystemFeature(feature)
Tells if the device has a specific system feature.
Examples
DeviceInfo;
getSystemAvailableFeatures()
Returns a list of available system features on Android.
Examples
DeviceInfo;
isLocationEnabled()
Tells if the device has location services turned off at the device-level (NOT related to app-specific permissions)
Examples
DeviceInfo;
getAvailableLocationProviders()
Returns an object of platform-specfic location providers/servcies, with boolean
value whether or not they are currently available.
NOTE: This function requires access to the Location permission on Android
Android Example
DeviceInfo;
iOS Example
DeviceInfo;
Events
Currently iOS-only.
batteryLevelDidChange
Fired when the battery level changes; sent no more frequently than once per minute.
Examples
const deviceInfoEmitter = NativeModulesRNDeviceInfo deviceInfoEmitter;
batteryLevelIsLow
Fired when the battery drops below 20%.
Examples
const deviceInfoEmitter = NativeModulesRNDeviceInfo deviceInfoEmitter;
powerStateDidChange
Fired when the battery state changes, for example when the device enters charging mode or is unplugged.
Examples
const deviceInfoEmitter = NativeModulesRNDeviceInfo deviceInfoEmitter;
Troubleshooting
When installing or using react-native-machine-info
, you may encounter the following problems:
[android] - Unable to merge dex / Multiple dex files / Problems with `com.google.android.gms`
react-native-device-info
uses com.google.android.gms:play-services-gcm
to provide [getInstance()][#getinstance].
This can lead to conflicts when building the Android application.
If you're using a different version of com.google.android.gms:play-services-gcm
in your app, you can define the
googlePlayServicesVersion
gradle variable in your build.gradle
file to tell react-native-machine-info
what version
it should require. See the example project included here for a sample.
If you're using a different library that conflicts with com.google.android.gms:play-services-gcm
, and you are certain you know what you are doing such that you will avoid version conflicts, you can simply
ignore this dependency in your gradle file:
compile(project(':react-native-machine-info')) { exclude group: 'com.google.android.gms'}
[ios] - ld: library not found for -lRNDeviceInfo-tvOS
Seems to be a bug caused by react-native link
. You can manually delete libRNDeviceInfo-tvOS.a
in Xcode -> [Your iOS build target] -> Build Phrases -> Link Binary with Libraries
.
[ios] - [NetworkInfo] Descriptors query returned error: Error Domain=NSCocoaErrorDomain Code=4099 “The connection to service named com.apple.commcenter.coretelephony.xpc was invalidated.”
This is a system level log that may be turned off by executing:
xcrun simctl spawn booted log config --mode "level:off" --subsystem com.apple.CoreTelephony
.
To undo the command, you can execute:
xcrun simctl spawn booted log config --mode "level:info" --subsystem com.apple.CoreTelephony
[ios] - Multiple versions of React when using CocoaPods "tries to require 'react-native' but there are several files providing this module"
You may need to adjust your Podfile like this if you use Cocoapods and have undefined symbols or duplicate React definitions
target 'yourTargetName' do # See http://facebook.github.io/react-native/docs/integration-with-existing-apps.html#configuring-cocoapods-dependencies pod 'React', :path => '../node_modules/react-native', :subspecs => [ 'Core', 'CxxBridge', # Include this for RN >= 0.47 'DevSupport', # Include this to enable In-App Devmenu if RN >= 0.43 'RCTText', 'RCTNetwork', 'RCTWebSocket', # Needed for debugging 'RCTAnimation', # Needed for FlatList and animations running on native UI thread # Add any other subspecs you want to use in your project ] # Explicitly include Yoga if you are using RN >= 0.42.0 pod 'yoga', :path => '../node_modules/react-native/ReactCommon/yoga' # Third party deps podspec link - you may have multiple pods here, just an example pod 'RNDeviceInfo', path: '../node_modules/react-native-machine-info' end # if you see errors about React duplicate definitions, this fixes it. The same works for yoga. post_install do |installer| installer.pods_project.targets.each do |target| if target.name == "React" target.remove_from_project end endend
[tests] - Cannot run my test suite when using this library
react-native-machine-info
contains native code, and needs to be mocked. Jest Snapshot support may work though.
Here's how to do it with jest for example:
// in your package.json:
"jest": {
"setupFiles": [
"./testenv.js"
],
// testenv.js:
jest.mock('react-native-machine-info', () => {
return {
getModel: jest.fn(),
};
});
[warnings] - I get too many warnings (battery state, etc)
Some of the APIs (like getBatteryState) will throw warnings in certain conditions like on tvOS or the iOS emulator. This won't be visible in production but even in development it may be irritating. It is useful to have the warnings because these devices return no state, and that can be surprising, leading to github support issues. The warnings is intended to educate you as a developer. If the warnings are troublesome you may try this in your code to suppress them:
;YellowBox;
Release Notes
See the CHANGELOG.md.
Contributing
Please see the contributing guide
.
react-native-dom
As a courtesy to developers, this library was made compatible in v0.21.6 with react-native-dom and react-native-web by providing an empty polyfill in order to avoid breaking builds.
Only getUserAgent() will return a correct value. All other API methods will return an "empty" value of its documented return type: 0
for numbers, ''
for strings, false
for booleans.