cordova-plugin-rssi

Cordova RSSI Plugin

This plugin allows you to read WiFi RSSI from applications developed using Cordova 3.0 or newer.

Works on both Android and iOS platforms, but will not pass the Apple App Store Review process.

Tested on iOS Simulator devices: iPhone 5, 6, 7, 8, SE, X, XR, XS, XS Max

NOTE: Does not return any values for iPad at this time.

Installation

In your application project directory:

cordova plugin add cordova-plugin-rssi

Usage

const rssi = cordova.plugins.rssi;

rssi.read(success, failure)

Returns the device's current WiFi RSSI information via 3 parameters:

rssi.read(function success(data){
    console.log(data);
    // -> {rssi: -38, bars: 4, isIPhoneX: false}
});

• rssi: WiFi Received Signal Strength Indicator
  • Availability: Android, iOS but not iPhoneX
  • Value: Integer or null if unavailable
  • Range: -100 ≤ x ≤ 0
• bars: Number of visible bars in WiFi icon
  • Availability: Android, iOS
  • Value: Integer
  • Range: 0 ≤ x ≤ 4: ^{*Range values only tested for Android}
    • 4: RSSI -55+
    • 3: RSSI -56 - -66
    • 2: RSSI -67 - -77
    • 1: RSSI -78 - -88
    • 0: RSSI -89-
• isIPhoneX: Flag for detecting whether iPhone X acquisition was used
  • Availability: Android, iOS
  • Value: Boolean

Browser / Development Usage

While developing in browser, a mock can be utilized to prevent errors. See an example Ionic 4 app at emcniece/ionic-cordova-rssi-demo.

References

• Android RSSI-to-bar formula
• Android WifiManager class
• iOS iPhone X Detection

Attribution

This open-source project was made possible by some fine people over at CNY Apps.

Licence

The MIT License

Changelog

• v1.1.2

  • Upgrade cordova-plugin-add-swift-support to 2.0.1

• v1.1.1

  • Preventing iPad crash (#4)

• v1.1.0

  • Adding support for iPhone XR, XS, XS Max, iOS 12

• v1.0.0

  • Init