Skip to content
This repository has been archived by the owner on May 17, 2023. It is now read-only.

Latest commit

 

History

History
134 lines (118 loc) · 4.48 KB

README.md

File metadata and controls

134 lines (118 loc) · 4.48 KB


React Native Hotspot [Android]

NPM Version NPM Version PRs Welcome

DEPRECATED

Please use react-native-tethering instead which compatible with latest react-native versions and Android APIs

Introduce

Since there's not a strict API from React Native to allow us to handle operations on Hotspot. So, today I would like to share my small kit with you guys to help most of rn developers to be able to use wifi-hotspot and enjoy its powerful.

The kit is designed to be helpful and to provide an easy API that can suit your needs so let me tell you how this kit can help you a long away with:

  • Talk to your ROBOT!
  • Communicating without an Internet
  • Build yourown SHAREit (Share any types of files locally)
  • Build a tiny network with your friends

Setup

Fetch it using npm or yarn

npm i --save react-native-wifi-hotspot
OR
yarn add react-native-wifi-hotspot

Then run this command to link it

react-native link react-native-wifi-hotspot

Almost done just put this lines into Settings.gradle

include ':hotspotmanager'
project(':hotspotmanager').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-wifi-hotspot/android/hotspotmanager')

💥 Just run it!

Example

🔥 Full Example

Features

  • Enable Hotspot
  • Disable Hotspot
  • Create Hotspot's Settings (SSID, Password, ..)
  • Fetch Hotspot's Settings
  • Get List of Connected Peers

Demo

example app

Get Started

  • Check WIFI is on/off then turn hotspot on and automatically check if hotspot already opened
Hotspot.enable(() => {
      ToastAndroid.show("Hotspot Enabled",ToastAndroid.SHORT);
    }, (err) => {
      ToastAndroid.show(err.toString(),ToastAndroid.SHORT);
    })
  • Check hotspot is on then turn it off and automatically check if hotspot already closed
Hotspot.disable(() => {
      ToastAndroid.show("Hotspot Disabled",ToastAndroid.SHORT);
    }, (err) => {
      ToastAndroid.show(err.toString(),ToastAndroid.SHORT);
    })
  • You can set your own configuration to your hotspot using this function. supported configuration:
    • SSID
    • Password
    • Protocols
    • authAlgorithms
    • Security type
Parameters Required Types Default
SSID * none none
password * none password should be provided if you will use our settings
protocols - Hotspot.protocols.RSN
Hotspot.protocols.WPA
Hotspot.protocols.BOTH
Hotspot.protocols.BOTH
securityType - Hotspot.security.WPA_PSK
Hotspot.security.WPA_EAP
Hotspot.security.IEEE8021X
Hotspot.security.WPA2_PSK
Hotspot.security.WPA2_PSK
authAlgorithms - Hotspot.auth.OPEN
Hotspot.auth.SHARED
Hotspot.auth.LEAP
Hotspot.auth.SHARED
const hotspot = {SSID: 'ASSEM', password: 'helloworld', authAlgorithms: Hotspot.auth.OPEN, protocols: Hotspot.protocols.WPA }
    Hotspot.create(hotspot, () => {
      ToastAndroid.show("Hotspot enstablished", ToastAndroid.SHORT);
    }, (err) => {
      ToastAndroid.show(err.toString(), ToastAndroid.SHORT);
    })

You can also use your own old settings without the need of creating new one

  • You can fetch your hotsot's configuration. Supported returning config:
    • ssid
    • password
    • status ( network is enabled or disabled )
    • networkId
config: {
  ssid: string,
  password: string,
  status: boolean ( true means enable, false means disable )
  networkId: Int
}
Hotspot.getConfig((config) => {
      ToastAndroid.show("Hotspot SSID: " + config.ssid, ToastAndroid.SHORT);
    }, (err) => {
      ToastAndroid.show(err.toString(), ToastAndroid.SHORT);
    })
  • Fethcing connected devices to your wifi network. Returned an object for every device contains:
    • ip
    • mac
    • device number
data: [
  results: {
    ip: 192.168.x.x,
    mac: A3:76:E1:33:79:F3,
    device: number
  }
]
Hotspot.peersList((data) => {
      const peers = JSON.parse(data);
    }, (err) => {
      ToastAndroid.show(err.toString(), ToastAndroid.SHORT);
    })