Skip to content

Commit

Permalink
docs: updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MousyBusiness committed Feb 8, 2022
1 parent 3d83f0d commit cecdbd0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,26 @@

Connect to an IoT access point using Android or iOS

## Android Support

Currently requires Version >= Android Q

## Android Permissions

```
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> !!! Android < 29 Required to scan !!!
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> !!! Android >= 29 Required to scan !!!
```

> NOTE: Explicit requesting of permissions (e.g. with permission_handler) is required with newer versions.
## iOS Support

Minimum iOS >= 11.0, iOS >= 13.0 required for prefix connect

## iOS Entitlements

```
Expand All @@ -19,3 +31,9 @@ Connect to an IoT access point using Android or iOS
<true/>
```

## iOS Info.plist

```
<key>NSLocationWhenInUseUsageDescription</key>
<string>XXXXXX</string>
```
11 changes: 3 additions & 8 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@ Demonstrates how to use the flutter_iot_wifi plugin.

## Getting Started

This project is a starting point for a Flutter application.
Replace `ssid` and `password` in main.dart with the WiFi AP you'd like to connect to.

A few resources to get you started if this is your first Flutter project:
## iOS restrictions

- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)

For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
Scan and List are not available for iOS. The recommended approach is to connect using prefix=true if you have a known ssid prefix.

0 comments on commit cecdbd0

Please sign in to comment.