B4A Library Simple WIFI library

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.

.

 

[Peter Simpson]

Well I must admit it @HotShoe , it's a really fast library there's no doubting that. IMO listing other local available WiFi networks maybe as a string array or list, is the only thing that is missing from this library, then it would be perfect.

Cheers

 

[HotShoe]

A new class MLscan has been added to scan for wireless AP's.

--- Jem

 

[Peter Simpson]

Hello,
Erm erm erm, thank you @HotShoe , I wasn't expecting you to do it today. And wow it's really really really fast. It's faster than other solutions on the forum and less cluttered too. It works absolutely perfect

Keep up the good work, cheers

Go and poor yourself one of these, you deserve it...

10k image file.

 

[netchicken]

This is a great little application @HotShoe . I was wondering if we could access the signal strength of a wifi point. That way I could pass it to google maps and get a wifi range or even pass it to a needle that starts to point to where the wireless router is after you get some points to triangulate

 

[HotShoe]

I don't think that will be too much of a problem. It'll be later in the week before I can get back to this though. I am snowed under with work for now.

--- Jem

 

[HotShoe]

Version 1.06 added to first post.

--- Jem

 

[incendio]

Though I am not using this lib right now, but thanks a lot for this useful utility.

 

[ixdev]

Thanks for this

 

[mr23]

FYI the wifitext sample has "getWifiLinkSpeed" in it. Not found in the library included.

 

[HotShoe]

Thanks, I'll change that.

--- Jem

 

[mr23]

Subsequently I found that I think you meant to have:

dblbl.Text = wifi.getWifiSignal & " DB" ' instead of .getWifiLinkSpeed

 

[daniel69]

Well done @HotShoe ! I've just played with your lib ... really impressive!

 

[HotShoe]

Thank you sir.

 

[Harris]

Excellent lib!!

Just one thing I have noticed. getSSID will throw a null pointer exception if called when not connected to AP. All others return empty string (IP, MAC).

This will come in handy to determine signal strength before I start down and up loading data (which may get cut off due to wander too far from the AP).

Thanks so much.

Sub wifi1_Tick

    wifilbl.Text = "WIFI = "&wifi.IsWifiConnected
    iplbl.Text  = "My IP = "&wifi.getIPAddress
    If wifi.IsWifiConnected = True Then  ' would often report true and throw exception
      If wifi.getWifiStrength > 50 Then  ' added to prevent exception from above
          inetlbl.Text = "Internet = "&wifi.isOnline&"  SSID: "&wifi.getSSID
      End If
    Else
      inetlbl.Text = "Internet = "&wifi.isOnline&"  SSID: none"
    End If
    maclbl.Text  = "MAC address = "&wifi.getMACAddress
    dblbl.Text    = wifi.getWifiSignal  & " DB"
    levellbl.Text = wifi.getWifiStrength & "%"
   

End Sub

 

[HotShoe]

Harris,

Sorry about that I completely missed it. try version 1.07 in the first post.

I have also made a couiple changes to the wifitest project included in the zip file.

--- Jem

 

[Harris]

Harris,

Sorry about that I completely missed it. try version 1.07 in the first post.

I have also made a couiple changes to the wifitest project included in the zip file.

--- Jem

Will do and thanks again!

I may have missed this somewhere, but how do you determine Internet (isOnline), ping a site or does:

• android.permission.ACCESS_NETWORK_STATE handle this call

 

[HotShoe]

Actually, the state manager will lie to you about the connection status sometimes, so I am using the connectivity manager to see if there is a remote IP address and received packets.

--- Jem

 

[Harris]

Ok, I see.

We had this issue elsewhere. Not an easy one to solve.
We were attempting to ping a url and if we got a response - then we had network.

I don't envy your attempts to resolve.

Thanks for the 1.07

Cheers

 

[Dadeda]

Thanks for your work, your lib is great, keep it up!

 

[tianya]

thanks