ReactiveWiFi


Source link: https://github.com/pwittchen/ReactiveWiFi

ReactiveWiFi

Android library listening available WiFi Access Points and related information with RxJava Observables.

This library is one of the successors of the NetworkEvents library. Its functionality was extracted from ReactiveNetwork project to make it more specialized and reduce number of required permissions required to perform specific task.

If you are searching library for observing network or Internet connectivity check ReactiveNetwork project.

Library is compatible with RxJava 1.+ and RxAndroid 1.+ and uses them under the hood.

JavaDoc is available at: http://pwittchen.github.io/ReactiveWiFi/

Contents

Usage

Library has the following RxJava Observables available in the public API:

Observable<List<ScanResult>> observeWifiAccessPoints(final Context context) Observable<Integer> observeWifiSignalLevel(final Context context, final int numLevels) Observable<WifiSignalLevel> observeWifiSignalLevel(final Context context) Observable<SupplicantState> observeSupplicantState(final Context context) Observable<WifiInfo> observeWifiAccessPointChanges(final Context context) Observable<WifiState> observeWifiStateChange(final Context context)

Please note: Due to memory leak in WifiManager reported in issue 43945 in Android issue tracker it's recommended to use Application Context instead of Activity Context.

Observing WiFi Access Points

Please note: If you want to observe WiFi access points on Android M (6.0) or higher, you need to request runtime permission for ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION. After that, location services have to be enabled. See sample app in app directory to check how it's done. User needs to enable Location manually. You can suggest him or her to do it via AccessRequester class from this library as follows:

if (!AccessRequester.isLocationEnabled(this)) {

AccessRequester.requestLocationAccess(this);
 
}
 else {

// observe WiFi Access Points 
}

If you need more customization (e.g. custom title and message of the dialog window or custom listener), check public API of the AccessRequester class.

We can observe WiFi Access Points with observeWifiAccessPoints(context) method. Subscriber will be called everytime, when strength of the WiFi Access Points signal changes (it usually happens when user is moving around with a mobile device). We can do it in the following way:

ReactiveWifi.observeWifiAccessPoints(context)
  .subscribeOn(Schedulers.io())
  ... // anything else what you can do with RxJava
  .observeOn(AndroidSchedulers.mainThread())
  .subscribe(new Action1<List<ScanResult>>() {

 @Override public void call(List<ScanResult> scanResults) {

// do something with scanResults

 
}

  
}
);

Hint: If you want to operate on a single ScanResult instead of List<ScanResult> in a subscribe(...) method, consider using flatMap(...) and Observable.from(...) operators from RxJava for transforming the stream.

Observing WiFi signal level

We can observe WiFi signal level with observeWifiSignalLevel(context, numLevels) method. Subscriber will be called everytime, when signal level of the connected WiFi changes (it usually happens when user is moving around with a mobile device). We can do it in the following way:

ReactiveWifi.observeWifiSignalLevel(context, numLevels)
  .subscribeOn(Schedulers.io())
  ... // anything else what you can do with RxJava
  .observeOn(AndroidSchedulers.mainThread())
  .subscribe(new Action1<Integer>() {

 @Override public void call(Integer level) {

// do something with level

 
}

  
}
);

We can also observe WiFi signal level with observeWifiSignalLevel(final Context context) method, which has predefined num levels value, which is equal to 4 and returns Observable<WifiSignalLevel>. WifiSignalLevel is an enum, which contains information about current signal level. We can do it as follows:

ReactiveWifi.observeWifiSignalLevel(context)
  .subscribeOn(Schedulers.io())
  ... // anything else what you can do with RxJava
  .observeOn(AndroidSchedulers.mainThread())
  .subscribe(new Action1<WifiSignalLevel>() {

 @Override public void call(WifiSignalLevel signalLevel) {

// do something with signalLevel

 
}

  
}
);

WifiSignalLevel has the following values:

public enum WifiSignalLevel {

NO_SIGNAL(0, "no signal"),
POOR(1, "poor"),
FAIR(2, "fair"),
GOOD(3, "good"),
EXCELLENT(4, "excellent");

... 
}

Observing WiFi information changes

We can observe WiFi network information changes with observeWifiAccessPointChanges(context) method. Subscriber will be called every time the WiFi network the device is connected to has changed. We can do it in the following way:

ReactiveWifi.observeWifiAccessPointChanges(context)
  .subscribeOn(Schedulers.io())
  ... // anything else what you can do with RxJava
  .observeOn(AndroidSchedulers.mainThread())
  .subscribe(new Action1<WifiInfo>() {

 @Override public void call(WifiInfo wifiInfo) {

// do something with wifiInfo

 
}

  
}
);

Observing WPA Supplicant state changes

We can observe changes in the WPA Supplicant state with observeSupplicantState(context) method. Subscriber will be called every time the WPA Supplicant will change its state, getting information at a lower level than usually available. We can do it in the following way:

ReactiveWifi.observeSupplicantState(context)
  .subscribeOn(Schedulers.io())
  ... // anything else what you can do with RxJava
  .observeOn(AndroidSchedulers.mainThread())
  .subscribe(new Action1<SupplicantState>() {

 @Override public void call(SuppicantState state) {

// do something with state

 
}

  
}
);

Observing WiFi state changes

We can observe wifi state change with observeWifiStateChange(context) method. Subscriber will be called every time whenever the wifi state change such like enabling,disabling,enabled and disabled. We can do it in the following way:

ReactiveWifi.observeWifiStateChange(context)
  .subscribeOn(Schedulers.io())
  ... // anything else what you can do with RxJava
  .observeOn(AndroidSchedulers.mainThread())
  .subscribe(new Action1<WifiState>() {

 @Override public void call(WifiState wifiState) {

// do something with state

 
}

  
}
);

Examples

Exemplary application is located in app directory of this repository.

If you want to use this library with Kotlin, check app-kotlin directory.

Download

<dependency>
  <groupId>com.github.pwittchen</groupId>
  <artifactId>reactivewifi</artifactId>
  <version>0.2.0</version> </dependency>

or through Gradle:

dependencies {

compile 'com.github.pwittchen:reactivewifi:0.2.0' 
}

Code style

Code style used in the project is called SquareAndroid from Java Code Styles repository by Square available at: https://github.com/square/java-code-styles.

Static code analysis

Static code analysis runs Checkstyle, FindBugs, PMD and Lint. It can be executed with command:

./gradlew check 

Reports from analysis are generated in library/build/reports/ directory.

License

Copyright 2016 Piotr Wittchen  Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License. You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 

Resources

The Android implementation of Replace. The content of the layout can be any view, such as ListView, RecyclerView, ScrollView, etc.

ShareLoginLib is a tool to help Android developers to share content (image, text or music) to WeChat, Weibo and QQ.

A nice tab to navigate between the different pages of a ViewPager. It supports badge, blur, and cross-fade effect.

How much time do you spend each day waiting for Gradle? Now you know!

Features:

  • Sortable bar chart summaries
  • CSV output
  • Daily and total summary

Do you like waiting? Godot is for passionate thumb-twiddlers of the quantified-self-era. A Gradle plugin to help you keep track of how much time you spend waiting for builds to finish.

Bindroid is an open-source utility library for Android apps whose primary goal is to simplify binding UI to data. It introduces an observability pattern for model objects and a number of simple methods for quickly binding these objects to your user interfaces. The result is a responsive, always-consistent and up-to-date user experience without having to write all of the glue to ensure that your UI is updated whenever the data it presents changes.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes