B4A Library Simple WIFI library

HotShoe · Mar 8, 2014

NOTICE :

I am looking for someone to take over development and maintenance on this and other libraries. I am just no longer interested in programming and don't know how long I will feel that way. Anyone interested in taking over this library or any of my others, let me know a bit about yourself by email to jem@mlsoft.org

Thanks,

--- Jem Miller

The Eclipse project and all source code has been attached below.

This is a very simple library that uses only 16 methods:

This is version 2.17. Don't panic, this version does not break anything!

I re-wrote the MACAddress method to handle Android M (API 23) and above. I also added the INTERNET and ACCESS_FINE_LOCATION permissions which seems to be required in API 23, and added a new method getAPI() that returns the version of Android running on the device as an integer.

SEE THE NEW WIFITEST EXAMPLE included in the zip file for examples of how to use this library.

MLwifi
Author: Jem Miller - Missing Link Software
Version: 2.17

MLScan
Events:
- ScanDone (Results() As String, Count As Int)
Fields:
- wifis As String[]
  A string array containing all scanned access points in the area of the device.
  These are comma separated entries consisting of the following:
  SSID, Security type, signal strength, and "Saved" if this network was previously saved for use on this device.
Methods:
- Disconnect As Boolean
  Disconnects the current wifi AP connection
  Returns True on success
- WifiCap (EntryNumber As Int) As String
  Returns a String containing info about the entry. A startScan must have already been done. The string contains the SSID, the BSSID, and the capabilities of the network access point.
  Each item is separated by a comma (SSID,BSSID,CapabilityString). The capabilities part can be quite long.
  EntryNumber - If you display the string array wifis or the array returned in the getWifiList method UNSORTED, you can pass the Position variable from your ListView_Click event.
  Otherwise, you must pass the entry number from the string array since that is what is used as a reference.
  Returns a string of comma separated entries of SSID,BSSID, and capability string. Returns an empty string on error.
- addAP (EntryNumber As Int, securityType As String, Password As String) As Boolean
  Adds an entry to the wifi manager and connects to it. This method saves the configuration of the new entry onto the device. Use the forgetAP method to delete them. Updated to handle quoted or unquoted SSID strings.
  EntryNumber - If you display the string array wifis or the array returned in the getWifiList method UNSORTED, you can pass the Position variable from your ListView_Click event.
  Otherwise, you must pass the entry number from the string array since that is what is used as a reference.
  securityType - The Access Point security type (returned in the scan result string array)
  Password - The password/phrase for the wifi access point. Pass "" for an open network. Handles WEP HEX or text phrases
  It is up to you to supply all information. The security type is found in the scan results array.
  
  Returns True if the connection is successful
- connectToAP (EntryNumber As Int) As Boolean
  Connects to a network already configured on the device. The device will use saved values to connect. Updated to handle quoted or unquoted SSID strings.
  EntryNumber - If you display the string array wifis or the array returned in the getWifiList method UNSORTED, you can pass the Position variable from your ListView_Click event.
  Otherwise, you must pass the entry number from the string array since that is what is used as a reference.
  Returns true if successful
- forgetAP (NetId As Int) As Boolean
  Forgets (erases) a stored access point on the device.
  NetId - The network ID number to forget (returned in the listSavedNetworks method)
  Returns True if successful
- getBSSID (EntryNumber As Int) As String
  Returns the BSSID for the selected entry.
  EntryNumber - If you display the string array wifis or the array returned in the getWifiList method UNSORTED, you can pass the Position variable from your ListView_Click event.
  Otherwise, you must pass the entry number from the string array since that is what is used as a reference.
- isStored (EntryNumber As Int) As Boolean
  Checks the stored networks on the device to see if this entry is a previously saved access point
  EntryNumber - The entry number in the wifis array to check. If you display the string array wifis or the array returned in the getWifiList method UNSORTED, you can pass the Position variable from your ListView_Click event.
  Otherwise, you must pass the entry number from the string array since that is what is used as a reference.
  Returns True if this is a stored network
- listSavedNetworks As List
  Builds a list of all saved networks on the device.
  Returns a comma separated list of SSID's and their BSSID and network ID number.
- startScan (EventName As String)
  Initializes all objects and scans for wifi networks. Builds a string array of results (wifis) that can be accessed directly or with a call to updateWifiList.
  THIS METHOD SHOULD ONLY BE CALLED ONCE!
- updateWifiList
  Call only after startScan has already been called and a string array of Access Points has been built. This method returns a string array containing the access points from the most recent scan, including background scans done automatically by the Android WifiManager. *
  Calls the ScanDone event when a new list is ready.
  Returns the string array of comma separated wifi access points by SSID. Each entry may contain the following:
  SSID, Security type, Signal level (in DB's), and the word "Saved" if the network was previously saved for use on this device.
Properties:
- LinkSpeed As Int [read only]
  Returns the LinkSpeed of the connected wifi access point
MLwifi
Methods:
- EnableWifi (Enabled As Boolean)
  Turns wifi on or off
  Pass True to enable wifi or False to disable.
  Example
  dim wifi as MLwifi
  wifi.EnableWifi(true)
- IpAddress As String
  Get IP address from the wifi interface)
  Returns address or empty string
- MACAddress As String
  Returns MAC address of the current interface
  
  Returns MAC address or empty string
- SSID As String
  Returns the current SSID
- WifiSignal As Int
  Returns the raw signal strength in decibels as an integer
  Returns 0 on error
- WifiStrength As Int
  Returns an integer between 0 and 100 as a percentage of signal strength
  Returns 0 on error.
- isOnLine As Boolean
  Checks for internet connection
  This method does not check or care what type of network is used.
  It can be wifi, 2g, 3g, 4g, wimax, etc. It just tests for internet connectivity.
  Returns True if internet is available.
- isWifiConnected As Boolean
  Checks if wifi is connected. This only checks for wifi connection to a router.
  It does NOT test for internet availability. Use isOnLine() for that.
  Returns True if wifi is connected or False if 2g, 3g, 4g, wimax or no connection.
Permissions:
- android.permission.ACCESS_FINE_LOCATION
- android.permission.ACCESS_NETWORK_STATE
- android.permission.ACCESS_WIFI_STATE
- android.permission.CHANGE_WIFI_STATE
- android.permission.INTERNET
Properties:
- API As Int [read only]
  Returns the current devices Android API (the version of Android running on the device.) as an integer such as 19, 21, 23, etc.

There is a small test app included and a readme file as well. The whole mess is tiny and requires no other libs.

--- Jem

Version 1.00 - Initial release.

Version 1.01 - Added EnableWifi that I forgot in the initial release.

Version 1.02 - Using a different method to find IP address.

Version 1.03 - Adds getSSID

Version 1.04 - Removed "'s from getSSID. Renamed IsWifiConnected to isWifiConnected.

Version 1.05 - Adding AP scanning.

Version 1.06 - Adds getWifiSignal and getWifiStrength

Version 1.07 - Fixed an error in the test project and forced getSSID to return an empty string instead of Null if no SSID is found.

Version 2.00 - New connection manager methods in the MLScan class. Also changed the string array returned on a scan to include more information in a comma separated list of: SSID, security type, signal strength, and the word "Saved" if this network is saved on the device.

Version 2.01 - Added a new method WifiCap(SSID). This returns a string with comma separated fields of SSID, BSSID, and network capabilities. The capabilities refers to its security protocols. I also included a new version of the wifitest app. I forgot to add it to the version 2.00 library zip file. Tapping on a listed SSID will allow you to connect to that network.

Version 2.10 - Added Disconnect, isStored, and LinkSpeed and changed the way you must call several methods.

Version 2.11 - Removed WifiList and added updateWifiList. Fixed the connectToAP and isStored methods. Added a ScanDone event to automate scan results (no more timers needed). Added error correction and more speed.

Version 2.1.2 - Updated ScanDone event to allow real time scan results.

Version 2.13 - Updated the connect methods to handle either quoted or unquoted SSID values so in theory any version of the API should now work correctly for connecting to an AP.

Version 2.14 - Fixed the ConnectToAP method (Hopefully). Also updated the wifitest app to fix a few minor bugs.

Version 2.15 - Corrected a null pointer error if wifi is turned off during operation.

Version 2.16 - Added some error checking an changed the connecttoAP method slightly. It now checks both the SSID and BSSID to ensure that correct AP is connect to.

Version 2.17 - Added permissions for API 23, Re-wrote the MACAddress method so it returns a valid MAC address on Android M OR any lower version of Android. Added the getAPI method to get the current version of Android on the device.

.

Cableguy · Oct 26, 2014

I have one question, how do you test internet connection?

HotShoe · Oct 26, 2014

isOnline will test if you are connected to the internet and isWifiConnected tests to see if you are connected to a router or other access point.

--- Jem

Deleted member 103 · Oct 29, 2014

Thank you for this library, it is exactly what I was looking for.

ivanomonti · Oct 31, 2014

There is something to learn even the signal line gsm, 3g, 4g.

thanks

Geritt Schlag · Mar 10, 2015

Thank you for this library. Works great!
I am search only an important point: How can i make the connection to the desired WLAN?

HotShoe · Mar 10, 2015

Geritt Schlag said:
I am search only an important point: How can i make the connection to the desired WLAN?

This library is for collecting information about your wireless connection and AP's around you. It is not a wifi manager that actually makes or manages those connections.

--- Jem

Brad · May 7, 2015

Awesome and simple library! One question. Is there a way during the scan to determine what type of security of the AP? WEP/WPA/WPA2?

HotShoe · May 7, 2015

Brad said:
Awesome and simple library! One question. Is there a way during the scan to determine what type of security of the AP? WEP/WPA/WPA2?

There is, it just isn't exposed. I'll add that in since it probably should have already been there.

--- Jem

HotShoe · May 9, 2015

Version 2.00 is in the first post. It now contains a connection manager so that you can use MLwifi to check AND connect to networks. Be sure to look over the first post carefully.

NJDude · May 9, 2015

I have written a sample showing some of the features of this simple but cool library.

Enjoy.

HotShoe · May 10, 2015

Looks great NJ!

HotShoe · May 10, 2015

Added a new version to the first post. This is version 2.01 and adds the wificap method to get capabilities of any scanned network. I also added the new wifitest example app source that I forgot to add to the 2.00 package. Sorry for the quick update, but I want this to be complete and useable.

In the new test app, clicking on any AP in the scanned list will allow you to see it's capabilities, and to connect to it.

--- Jem

NJDude · May 10, 2015

Can the "Link Speed" be also exposed?, I think that will complete this library.

Awesome work Shoe.

HotShoe · May 12, 2015

NJDude said:
Can the "Link Speed" be also exposed?, I think that will complete this library.

Absolutely.

HotShoe · May 13, 2015

Version 2.10 is linked in the first post. This version adds 3 new methods and changes the way several methods must be called. I know this will break some code, but this way of calling the methods just makes much more sense than using the SSID which can be an empty string or a duplicate entry. See the included example for a demonstration of how easy and how much less code this now takes. It also increases the speed of the library very slightly.

The new methods are :

Disconnect - to disconnect from an AP
isStored(EntryNumber) - to determine if this entry is already saved on the device
LinnkSpeed - to get the speed of the current connection

Also I have renamed 3 methods because they no longer use the SSID. Those methods are:

addSSID is now addAP
connectToSSID is now connectToAP
forgetSSID is now forgetAP

by the way, the entries returned in the wifis() array or a call to wifiList should be sorted by signal strength now.

--- Jem

FrankBerra · May 19, 2015

Hi there i am using the following code to perform a scan:

B4X:

Sub Button1_Click

   wiffo.startScan
   Timer1.Initialize("Timer1", 2000) ' 1000 = 1 second
   Timer1.Enabled = True

End Sub


Sub Timer1_Tick
   If wiffo.wifis <> Null Then
    Timer1.Enabled = False
    Log (wiffo.WifiList)
    Log(wiffo.wifis)
   End If
End Sub

After few seconds the log says something like: "[Ljava.lang.String;@1107b928"

Where i am wrong?

HotShoe · May 19, 2015

That's the address of the array object returned by the call to WifiList and wifis. To get the entries use a method like in the sample project or put it into a List object.

--- Jem

FrankBerra · May 20, 2015

Perfect, it works! thank you!
I have another question, just a curiosity...
The OS scans the surrounding wifis in background constantly (if it is not disabled by user in the wifi settings).
Is it possible to retrieve infos about last OS scan without performing an additional scan?
If yes what the pro/cons?

HotShoe · May 20, 2015

FrankBerra said:
Is it possible to retrieve infos about last OS scan without performing an additional scan?

Not that I know of since I would not have access to the data. To my knowledge a new scan has to be done to get all of the features and data on each AP found.

--- Jem

FrankBerra · May 20, 2015

Well this code returns data of the last OS scan, even if i haven't done a scan intentionally

B4X:

Dim R As Reflector
R.Target = R.GetContext
R.Target = R.RunMethod2("getSystemService", "wifi", "java.lang.String")
R.Target = R.RunMethod("getScanResults")
String_InfoWIFI= R.RunMethod("toString")

I get data of surrounding enviroment periodically (about every 10 min) and this code seem draining less battery than using ABWifi library. (This is why i asked you if there are PROs abaout getting wifi info without an explicit scan)
The problem is that the code above returns empty SSID/BSSID on Samsung devices.
MLwifi returns correct WIFI values, and in the following days i will analyze the battery consumption

B4A Library Simple WIFI library

Attachments

Expert

Well-Known Member

Deleted member 103

Guest

Expert

Member

Well-Known Member

Active Member

Well-Known Member

Well-Known Member

Expert

Attachments

Well-Known Member

Well-Known Member

Expert

Well-Known Member

Well-Known Member

Active Member

Well-Known Member

Active Member

Well-Known Member

Active Member

Privacy & Transparency

Privacy & Transparency