flutternetwork · daadu · Jan 15, 2022 · Dec 4, 2021 · Dec 5, 2021 · Dec 5, 2021
diff --git a/.github/workflows/wifi_scan.yaml b/.github/workflows/wifi_scan.yaml
@@ -0,0 +1,91 @@
+# Build wifi_scan example
+name: wifi_scan
+
+on:
+  pull_request:
+    paths:
+      - "packages/wifi_scan/**"
+      - ".github/workflows/wifi_scan.yaml"
+
+env:
+  PLUGIN_SCOPE: "*wifi_scan*"
+  PLUGIN_EXAMPLE_SCOPE: "*wifi_scan_example*"
+
+jobs:
+  android:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v2
+      - name: "Install Flutter"
+        run: ./.github/workflows/scripts/install-flutter.sh stable
+      - name: "Install Tools"
+        run: ./.github/workflows/scripts/install-tools.sh
+      - name: "Build Example"
+        run: ./.github/workflows/scripts/build-examples.sh android ./lib/main.dart
+
+  ios:
+    runs-on: macos-latest
+    timeout-minutes: 30
+    steps:
+      - name: "Checkout repository"
+        uses: actions/checkout@v2
+      - name: "Install Flutter"
+        run: ./.github/workflows/scripts/install-flutter.sh stable
+      - name: "Install Tools"
+        run: ./.github/workflows/scripts/install-tools.sh
+      - name: "Build Example"
+        run: ./.github/workflows/scripts/build-examples.sh ios ./lib/main.dart
+
+#  macos:
+#    runs-on: macos-latest
+#    timeout-minutes: 30
+#    steps:
+#      - name: "Checkout repository"
+#        uses: actions/checkout@v2
+#      - name: "Install Flutter"
+#        run: ./.github/workflows/scripts/install-flutter.sh stable
+#      - name: "Install Tools"
+#        run: ./.github/workflows/scripts/install-tools.sh
+#      - name: "Build Example"
+#        run: ./.github/workflows/scripts/build-examples.sh macos ./lib/main.dart
+
+#    linux:
+#      runs-on: ubuntu-latest
+#      timeout-minutes: 30
+#      steps:
+#        - name: "Checkout repository"
+#          uses: actions/checkout@v2
+#        - name: "Install Flutter"
+#          run: ./.github/workflows/scripts/install-flutter.sh stable
+#        - name: "Install Tools"
+#          run: ./.github/workflows/scripts/install-tools.sh
+#        - name: "Build Example"
+#          run: ./.github/workflows/scripts/build-examples.sh linux ./lib/main.dart
+
+#    windows:
+#      runs-on: ubuntu-latest
+#      timeout-minutes: 30
+#      steps:
+#        - name: "Checkout repository"
+#          uses: actions/checkout@v2
+#        - name: "Install Flutter"
+#          run: ./.github/workflows/scripts/install-flutter.sh stable
+#        - name: "Install Tools"
+#          run: ./.github/workflows/scripts/install-tools.sh
+#        - name: "Build Example"
+#          run: ./.github/workflows/scripts/build-examples.sh windows ./lib/main.dart
+
+#    web:
+#      runs-on: ubuntu-latest
+#      timeout-minutes: 30
+#      steps:
+#        - name: "Checkout repository"
+#          uses: actions/checkout@v2
+#        - name: "Install Flutter"
+#          run: ./.github/workflows/scripts/install-flutter.sh stable
+#        - name: "Install Tools"
+#          run: ./.github/workflows/scripts/install-tools.sh
+#        - name: "Build Example"
+#          run: ./.github/workflows/scripts/build-examples.sh web ./lib/main.dart
diff --git a/README.md b/README.md
@@ -72,14 +72,14 @@ Flutter plugin for basic WiFi information and functionalities.
 ### `wifi_scan`
 > [![wifi_scan][scan_workflow_badge]][scan_workflow] [![wifi_scan][scan_pub_badge]][scan_pub] [![pub points][scan_pub_points_badge]][scan_pub_points]
 
-Flutter plugin to scan for WiFi networks.
+Flutter plugin to scan for WiFi access points.
 
 [[View Source][scan_code]]
 
 #### Platform Support
 | Android | iOS |
 | :-----: | :-: |
-|    ❌    | ➖  |
+|   ✔️    |     |
 
 ---
 

diff --git a/packages/wifi_scan/.gitignore b/packages/wifi_scan/.gitignore
@@ -0,0 +1,7 @@
+.DS_Store
+.dart_tool/
+
+.packages
+.pub/
+
+build/
diff --git a/packages/wifi_scan/.metadata b/packages/wifi_scan/.metadata
@@ -0,0 +1,10 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled and should not be manually edited.
+
+version:
+  revision: 18116933e77adc82f80866c928266a5b4f1ed645
+  channel: stable
+
+project_type: plugin
diff --git a/packages/wifi_scan/CHANGELOG.md b/packages/wifi_scan/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.0.1
+
+* TODO: Describe initial release.
diff --git a/packages/wifi_scan/LICENSE b/packages/wifi_scan/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 AlternaDom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/wifi_scan/README.md b/packages/wifi_scan/README.md
@@ -0,0 +1,144 @@
+<h3><a href="https://wifi.flutternetwork.dev/" ><img src="https://raw.githubusercontent.com/flutternetwork/WiFiFlutter/master/logo/logo%2Bname_vertical_color.png" alt="WiFiFlutter" height="112"/></a>| <code>wifi_scan</code></h3>
+
+<p>  
+<a href="https://github.com/flutternetwork/WiFiFlutter/actions/workflows/wifi_scan.yaml">
+  <img src="https://github.com/flutternetwork/WiFiFlutter/actions/workflows/wifi_scan.yaml/badge.svg" alt="analysis">
+</a>  
+<a href="https://pub.dev/packages/wifi_scan">
+  <img src="https://img.shields.io/pub/v/wifi_scan?logo=dart" alt="pub.dev">
+</a>
+<a href="https://pub.dev/packages/wifi_scan/score">
+  <img src="https://badges.bar/wifi_scan/pub%20points" alt="pub points">
+</a>  
+<a href="https://pub.dev/packages/wifi_scan/score">
+  <img src="https://badges.bar/wifi_scan/popularity" alt="popularity">
+</a>  
+<a href="https://pub.dev/packages/wifi_scan/score">
+  <img src="https://badges.bar/wifi_scan/likes" alt="likes">
+</a>  
+</p>  
+
+---
+This plugin allows Flutter apps to trigger WiFi scan and get scanned results.
+
+> This plugin is part of [WiFiFlutter][wf_home] suite, enabling various WiFi services for Flutter. 
+
+## Platform Support
+
+| Platform | Status | Min. Version |  API  | Notes |
+| :------: | :----: |:------------:| :---: |:-----:|
+| **Android** | ✔️ | 16 (J) | Scan related APIs in [`WifiManager`][android_WifiManager] *[[Guide][android_guide]]* | For SDK >= 26(O) scans are [throttled][android_throttling]. |
+| **iOS** | ✔️ | 9.0 | No API available | Dummy implementation with [sane static returns][ios_dummy]. |
+
+## Usage
+The entry point for the plugin is the singleton instance `WiFiScan.instance`.
+
+### Start scan
+You can trigger full WiFi scan with `WiFiScan.startScan` API, as shown below:
+```dart
+// check if platform support and necessary requirements
+final can = await WiFiScan.instance.canStartScan(askPermissions: true);
+switch(can) {
+  case CanStartScan.yes:
+    // start full scan async-ly
+    final isScanning = await WiFiScan.instance.startScan();
+    //...
+    break;
+  // ... handle other cases of CanStartScan values
+}
+```
+
+For more details, you can read documentation of [`WiFiScan.startScan`][doc_startScan], [`WiFiScan.canStartScan`][doc_canStartScan] and [`CanStartScan`][doc_enum_CanStartScan].
+
+### Get scanned results
+You can get scanned results with `WiFiScan.getScannedResults` API, as shown below:
+```dart
+// check if platform support and necessary requirements
+final can = await WiFiScan.instance.canGetScannedResults(askPermissions: true);
+switch(can) {
+  case CanGetScannedResults.yes:
+    // get scanned results
+    final accessPoints = await WiFiScan.instance.getScannedResults();
+    // ...
+    break;
+  // ... handle other cases of CanGetScannedResults values
+}
+```
+
+> **NOTE:** `getScannedResults` API can be used independently of `startScan` API. This returns the latest available scanned results.
+
+For more details, you can read documentation of [`WiFiScan.getScannedResults`][doc_getScannedResults], `WiFiAccessPoint`[doc_WiFiAccessPoint], [`WiFiScan.canGetScannedResults`][doc_canGetScannedResults] and [`CanGetScannedResults`][doc_enum_CanGetScannedResults].
+
+### Get notified when scanned results available
+You can get notified when new scanned results are available, as shown below:
+```dart
+// initialize accessPoints and subscription
+List<WiFiAccessPoint> accessPoints = [];
+StreamSubscription<List<WiFiAccessPoint>>? subscription;
+
+void _startListeningToScannedResults(){
+// check if platform support and necessary requirements
+  final can = await WiFiScan.instance.canGetScannedResults(askPermissions: true);
+  switch(can) {
+    case CanGetScannedResults.yes:
+      // listen to onScannedResultsAvailable stream
+      subscription = WiFiScan.instance.onScannedResultsAvailable.listen((results) {
+        // update accessPoints
+        setState(() => accessPoints = results);
+      });
+      // ...
+      break;
+    // ... handle other cases of CanGetScannedResults values
+  }
+}
+
+// make sure to cancel subscription after you are done
+@override
+dispose() {
+  super.dispose();
+  subscription?.cancel();
+}
+```
+
+Additionally, `WiFiScan.onScannedResultsAvailable` API can also be used with Flutter's [`StreamBuilder`][flutter_StreamBuilder] widget.
+
+> **NOTE:** `onScannedResultsAvailable` API can be used  independently of `startScan` API. The notification can also be result of a full scan performed by platform or other app.
+
+For more details, you can read documentation of [`WiFiScan.onScannedResultsAvailable`][doc_onScannedResultsAvailable], `WiFiAccessPoint`[doc_WiFiAccessPoint], [`WiFiScan.canGetScannedResults`][doc_canGetScannedResults] and [`CanGetScannedResults`][doc_enum_CanGetScannedResults].
+
+## Resources
+- 📖[API docs][docs]
+- 💻[Example app][example]
+
+## Issues and feedback
+
+Please file WiFiFlutter specific issues, bugs, or feature requests in our [issue tracker][wf_issue].
+
+To contribute a change to this plugin, please review plugin [checklist for 1.0][checklist], our [contribution guide][wf_contrib] and open a [pull request][wf_pull].
+
+<!-- links -->
+[wf_home]: https://wifi.flutternetwork.dev/
+[wf_issue]: https://github.com/flutternetwork/WiFiFlutter/issues/new
+[wf_contrib]: https://github.com/flutternetwork/WiFiFlutter/blob/master/CONTRIBUTING.md
+[wf_pull]: https://github.com/flutternetwork/WiFiFlutter/pulls
+
+[checklist]: https://github.com/flutternetwork/WiFiFlutter/issues/188
+[docs]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/wifi_scan-library.html
+[example]: https://github.com/flutternetwork/WiFiFlutter/tree/master/packages/wifi_scan/example
+
+[doc_startScan]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/WiFiScan/startScan.html
+[doc_canStartScan]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/WiFiScan/canStartScan.html
+[doc_enum_CanStartScan]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/CanStartScan.html
+[doc_getScannedResults]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/WiFiScan/getScannedResults.html
+[doc_WiFiAccessPoint]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/WiFiAccessPoint.html
+[doc_canGetScannedResults]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/WiFiScan/canGetScannedResults.html
+[doc_enum_CanGetScannedResults]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/CanGetScannedResults.html
+[doc_onScannedResultsAvailable]: https://pub.dev/documentation/wifi_scan/latest/wifi_scan/WiFiScan/onScannedResultsAvailable.html
+
+[flutter_StreamBuilder]: https://api.flutter.dev/flutter/widgets/StreamBuilder-class.html
+
+[android_guide]: https://developer.android.com/guide/topics/connectivity/wifi-scan
+[android_throttling]: https://developer.android.com/guide/topics/connectivity/wifi-scan#wifi-scan-throttling
+[android_WifiManager]: https://developer.android.com/reference/android/net/wifi/WifiManager
+
+[ios_dummy]: https://github.com/flutternetwork/WiFiFlutter/blob/master/packages/wifi_scan/ios/Classes/SwiftWifiScanPlugin.swift
diff --git a/packages/wifi_scan/android/.gitignore b/packages/wifi_scan/android/.gitignore
@@ -0,0 +1,8 @@
+*.iml
+.gradle
+/local.properties
+/.idea/workspace.xml
+/.idea/libraries
+.DS_Store
+/build
+/captures
diff --git a/packages/wifi_scan/android/build.gradle b/packages/wifi_scan/android/build.gradle
@@ -0,0 +1,50 @@
+group 'dev.flutternetwork.wifi.wifi_scan'
+version '1.0-SNAPSHOT'
+
+buildscript {
+    ext.kotlin_version = '1.3.50'
+    repositories {
+        google()
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath 'com.android.tools.build:gradle:4.1.0'
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
+}
+
+rootProject.allprojects {
+    repositories {
+        google()
+        mavenCentral()
+    }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+android {
+    compileSdkVersion 30
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = '1.8'
+    }
+
+    sourceSets {
+        main.java.srcDirs += 'src/main/kotlin'
+    }
+
+    defaultConfig {
+        minSdkVersion 16
+    }
+}
+
+dependencies {
+    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
+}
diff --git a/packages/wifi_scan/android/gradle.properties b/packages/wifi_scan/android/gradle.properties
@@ -0,0 +1,3 @@
+org.gradle.jvmargs=-Xmx1536M
+android.useAndroidX=true
+android.enableJetifier=true
diff --git a/packages/wifi_scan/android/gradle/wrapper/gradle-wrapper.properties b/packages/wifi_scan/android/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
diff --git a/packages/wifi_scan/android/settings.gradle b/packages/wifi_scan/android/settings.gradle
@@ -0,0 +1 @@
+rootProject.name = 'wifi_scan'
diff --git a/packages/wifi_scan/android/src/main/AndroidManifest.xml b/packages/wifi_scan/android/src/main/AndroidManifest.xml
@@ -0,0 +1,10 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+  package="dev.flutternetwork.wifi.wifi_scan">
+    <!-- required for: `WifiManager.getScanResult` -->
+    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
+    <!-- required for: `WifiManager.startScan` -->
+    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/>
+    <!-- required for: `WifiManager.getScanResult`, `WifiManager.startScan` -->
+    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
+</manifest>