tijos.framework.platform.wlan

Class TiWiFi

java.lang.Object

tijos.framework.platform.wlan.TiWiFi

public class TiWiFi
extends Object

The TiWiFi for platform of framework.

Author:

Andy.

Method Summary

Modifier and Type	Method and Description
void	changePassword(String password) Change the WiFi password, effective at next startup
void	changeSoftAPPassword(String password) Change the WiFi softAP password, effective at next startup
void	changeSoftAPSSID(String SSID) Change the WiFi softAP SSID, effective at next startup
void	changeSSID(String SSID) Change the WiFi SSID, effective at next startup
String	getAddress() Gets the address of WiFi
static TiWiFi	getInstance() Gets the WiFi object
String	getPassword() Gets the WiFi password
String	getSoftAPAddress() Gets the address of softAP of WiFi
String	getSoftAPPassword() Gets the WiFi softAP password
String	getSoftAPSSID() Gets the WiFi softAP SSID
String[]	getSoftAPStaticAddress() Gets the WiFi softAP static address
int	getSoftAPStationNum() Gets the number of station on the softAP of WiFi
String	getSSID() Gets the WiFi SSID
String[]	getStaticAddress() Gets the WiFi static address
boolean	isConnected() Check if WiFi is connected
void	setSoftAPStaticAddress(String localAddress, String gateWayAddress, int subnetPrefix) Set the WiFi softAP static address, effective at next startup
void	setStaticAddress(String localAddress, String gateWayAddress, int subnetPrefix) Set the WiFi static address, effective at next startup
void	shutdown() Shutdown the WiFi, WiFi and WiFiSoftAP are shutdown at the same time
void	shutdownSoftAP() Shutdown the softAP of WiFi
void	smartConfig(int timeout) The WiFi smart configuration, and connect to the AP
void	startup(int timeout) Startup the WiFi, and connect to the AP
void	startupSoftAP(boolean hidden) Startup the softAP of WiFi, WiFi must startup first

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

changePassword

public void changePassword(String password)
                    throws IOException

Change the WiFi password, effective at next startup

Parameters:

password - password string of AP, or "" no password

Throws:

IOException - If a TiWiFi error occurs

NullPointerException - If password is null

changeSoftAPPassword

public void changeSoftAPPassword(String password)
                          throws IOException

Change the WiFi softAP password, effective at next startup

Parameters:

password - password string of AP, or null

Throws:

IOException - If a TiWiFi error occurs

NullPointerException - If password is null

changeSoftAPSSID

public void changeSoftAPSSID(String SSID)
                      throws IOException

Change the WiFi softAP SSID, effective at next startup

Parameters:

SSID - SSID string of AP

Throws:

IOException - If a TiWiFi error occurs

NullPointerException - If SSID is null

changeSSID

public void changeSSID(String SSID)
                throws IOException

Change the WiFi SSID, effective at next startup

Parameters:

SSID - SSID string of AP

Throws:

IOException - If a TiWiFi error occurs

NullPointerException - If SSID is null

getAddress

public String getAddress()
                  throws IOException

Gets the address of WiFi

Returns:

address string For example: "192.168.1.200"

Throws:

IOException - If a TiWiFi error occurs

getInstance

public static TiWiFi getInstance()

Gets the WiFi object

Returns:

object

getPassword

public String getPassword()
                   throws IOException

Gets the WiFi password

Returns:

password string or null

Throws:

IOException - If a TiWiFi error occurs

getSoftAPAddress

public String getSoftAPAddress()
                        throws IOException

Gets the address of softAP of WiFi

Returns:

address string For example: "192.168.1.100"

Throws:

IOException - If a TiWiFi error occurs

getSoftAPPassword

public String getSoftAPPassword()
                         throws IOException

Gets the WiFi softAP password

Returns:

password string or null

Throws:

IOException - If a TiWiFi error occurs

getSoftAPSSID

public String getSoftAPSSID()
                     throws IOException

Gets the WiFi softAP SSID

Returns:

SSID string or ""

Throws:

IOException - If a TiWiFi error occurs

getSoftAPStaticAddress

public String[] getSoftAPStaticAddress()
                                throws IOException

Gets the WiFi softAP static address

Returns:

static address or """"
address[0] local address, for example:1.local, "192.168.1.100"
address[1] gateWay address/subnet prefix length, for example:1.gateWay, "192.168.1.1/24"

Throws:

IOException - If a TiWiFi error occurs

getSoftAPStationNum

public int getSoftAPStationNum()
                        throws IOException

Gets the number of station on the softAP of WiFi

Returns:

number

Throws:

IOException - If a TiWiFi error occurs

getSSID

public String getSSID()
               throws IOException

Gets the WiFi SSID

Returns:

SSID string or null

Throws:

IOException - If a TiWiFi error occurs

getStaticAddress

public String[] getStaticAddress()
                          throws IOException

Gets the WiFi static address

Returns:

static address or """"
address[0] local address, for example:1.local, "192.168.1.100"
address[1] gateWay address/subnet prefix length, for example:1.gateWay, "192.168.1.1/24"

Throws:

IOException - If a TiWiFi error occurs

isConnected

public boolean isConnected()
                    throws IOException

Check if WiFi is connected

Returns:

true or false

Throws:

IOException - If a TiWiFi error occurs

setSoftAPStaticAddress

public void setSoftAPStaticAddress(String localAddress,
                                   String gateWayAddress,
                                   int subnetPrefix)
                            throws IOException

Set the WiFi softAP static address, effective at next startup

Parameters:

localAddress - local address
For example:1.local, "192.168.1.100"
2."", static address off

gateWayAddress - gateWay address
For example:1.gateWay, "192.168.1.1"
2."", static address off

subnetPrefix - the subnet prefix length
For example(IPv4):"255.255.255.0" subnet prefix 24

Throws:

IOException - If a TiWiFi error occurs

NullPointerException - If localAddress or gateWayAddress is null

setStaticAddress

public void setStaticAddress(String localAddress,
                             String gateWayAddress,
                             int subnetPrefix)
                      throws IOException

Set the WiFi static address, effective at next startup

Parameters:

localAddress - local address
For example:1.local, "192.168.1.100"
2."", static address off

gateWayAddress - gateWay address
For example:1.gateWay, "192.168.1.1"
2."", static address off

subnetPrefix - the subnet prefix length
For example(IPv4):"255.255.255.0" subnet prefix 24

Throws:

IOException - If a TiWiFi error occurs

NullPointerException - If localAddress or gateWayAddress is null

shutdown

public void shutdown()
              throws IOException

Shutdown the WiFi, WiFi and WiFiSoftAP are shutdown at the same time

Throws:

IOException - If a TiWiFi error occurs

shutdownSoftAP

public void shutdownSoftAP()
                    throws IOException

Shutdown the softAP of WiFi

Throws:

IOException - If a TiWiFi error occurs

smartConfig

public void smartConfig(int timeout)
                 throws IOException

The WiFi smart configuration, and connect to the AP

Parameters:

timeout - connect timeout, unit:second

Throws:

IOException - If a TiWiFi error occurs

startup

public void startup(int timeout)
             throws IOException

Startup the WiFi, and connect to the AP

Parameters:

timeout - connect timeout, unit:second

Throws:

IOException - If a TiWiFi error occurs

startupSoftAP

public void startupSoftAP(boolean hidden)
                   throws IOException

Startup the softAP of WiFi, WiFi must startup first

Parameters:

hidden - true:SSID hidden, false:SSID not hidden[IN]

Throws:

IOException - If a TiWiFi error occurs