react-native-open-wifi

0.2.0 • Public • Published

react-native-open-wifi

npm version js-semistandard-style

Connect to unsecured, open WiFi networks and get the status of the WiFi connection on the device.

Based on the work of skierkowski/react-native-open-wifi-manager

Android only. Programatically connecting to WiFi networks on iOS is not possible. You should show instructions telling your user to connect manually.

Installation

First you need to install react-native-open-wifi:

npm install react-native-open-wifi --save
  • In android/setting.gradle
...
include ':OpenWifi', ':app'
project(':OpenWifi').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-open-wifi/android')
  • In android/app/build.gradle
...
dependencies {
    ...
    compile project(':OpenWifi')
}
  • register module (in MainActivity.java or MainApplication.java)

On newer versions of React Native (0.18+):

import com.skierkowski.OpenWifi.*;  // <--- import 
 
public class MainActivity extends ReactActivity {
  ......
  
  /**
   * A list of packages used by the app. If the app uses additional views
   * or modules besides the default ones, add more packages here.
   */
    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
        new OpenWifi(), // <------ add here 
        new MainReactPackage());
    }
}

On older versions of React Native:

import com.skierkowski.OpenWifi.*;  // <--- import 
 
public class MainActivity extends Activity implements DefaultHardwareBackBtnHandler {
  ......
 
  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    mReactRootView = new ReactRootView(this);
 
    mReactInstanceManager = ReactInstanceManager.builder()
      .setApplication(getApplication())
      .setBundleAssetName("index.android.bundle")
      .setJSMainModuleName("index.android")
      .addPackage(new MainReactPackage())
      .addPackage(new OpenWifi())              // <------ add here 
      .setUseDeveloperSupport(BuildConfig.DEBUG)
      .setInitialLifecycleState(LifecycleState.RESUMED)
      .build();
 
    mReactRootView.startReactApplication(mReactInstanceManager, "ExampleRN", null);
 
    setContentView(mReactRootView);
  }
 
  ......
 
}

Example

Load module

var OpenWifi = require('react-native-open-wifi');

Connect to a new network (connect)

// Attempts to connect to the network specified.
// The promise will be rejected if not connected after 20 seconds.
OpenWifi.connect(ssid, { timeout: 10000 }) // Timeout (optional) 10 seconds
  .then(() => console.log('Successfully connected to', ssid))
  .catch(err => console.log('Check message for failure info'));

TODO (by priority)

[x] Change connect result to polling the current SSID
[x] Make timeout configurable
[x] Resolve connect promise immediately if the currentSSID equals the wanted SSID
[ ] Expose more methods, such as getting current SSID

Package Sidebar

Install

npm i react-native-open-wifi

Weekly Downloads

3

Version

0.2.0

License

MIT

Last publish

Collaborators

  • javorosas