Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

Embed: (wiki syntax)

« Back to documentation index

Types

Network Types. More...

Data Structures

class  NetworkInterface
 The provides an interface for joining and/or creating a network. More...
class  ScanResult
 Contains single entry from WiFi scan results. More...
class  ScanResultList
 List of WiFi network scan results. More...
struct  Ssid
 Network SSID type. More...
struct  MacAddress
 Network MAC Address type. More...

Typedefs

typedef char MacAddressStrBuffer [18]
 Buffer to hold a MAC address string.
typedef char SsidStrBuffer [129]
 Buffer to hold a SSID string.
typedef char IpStrBuffer [18]
 Buffer to hold an IP address string.

Enumerations

enum  NetworkStatus { NETWORK_STATUS_DOWN, NETWORK_STATUS_WIFI_ONLY, NETWORK_STATUS_UP, NETWORK_STATUS_JOINING }
 

Network connection status.

More...
enum  NetworkJoinResult {
  NETWORK_JOIN_RESULT_NONE, NETWORK_JOIN_RESULT_SUCCESS, NETWORK_JOIN_RESULT_JOINING, NETWORK_JOIN_RESULT_NO_SSID,
  NETWORK_JOIN_RESULT_NO_PASSWORD, NETWORK_JOIN_RESULT_BAD_SECURITY, NETWORK_JOIN_RESULT_NOT_FOUND, NETWORK_JOIN_RESULT_FAILED,
  NETWORK_JOIN_RESULT_ABORTED
}
 

Network connection status.

More...
enum  NetworkSignalStrength {
  NETWORK_RSSI_EXCELLENT = 0, NETWORK_RSSI_VERY_GOOD = 1, NETWORK_RSSI_GOOD = 2, NETWORK_RSSI_POOR = 3,
  NETWORK_RSSI_VERY_POOR = 4, NETWORK_RSSI_UNKNOWN = 5
}
 

Network RSSI signal level.

More...
enum  NetworkSecurity
 

Network security type.

More...

Detailed Description

Network Types.


Typedef Documentation

typedef char IpStrBuffer[18]

Buffer to hold an IP address string.

Definition at line 329 of file WiconnectTypes.h.

typedef char MacAddressStrBuffer[18]

Buffer to hold a MAC address string.

Definition at line 317 of file WiconnectTypes.h.

typedef char SsidStrBuffer[129]

Buffer to hold a SSID string.

Definition at line 323 of file WiconnectTypes.h.


Enumeration Type Documentation

enum NetworkJoinResult

Network connection status.

Enumerator:
NETWORK_JOIN_RESULT_NONE 

Haven't attempted to join.

NETWORK_JOIN_RESULT_SUCCESS 

Successfully joined the network.

NETWORK_JOIN_RESULT_JOINING 

Currently attempting to join.

NETWORK_JOIN_RESULT_NO_SSID 

The SSID has not be configured.

NETWORK_JOIN_RESULT_NO_PASSWORD 

The network requires a password and none has been set.

NETWORK_JOIN_RESULT_BAD_SECURITY 

The specified security type is not supported by the network.

NETWORK_JOIN_RESULT_NOT_FOUND 

The network with the configured SSID was not found.

NETWORK_JOIN_RESULT_FAILED 

Failed to join the network.

NETWORK_JOIN_RESULT_ABORTED 

Joining was aborted (via command)

Definition at line 251 of file WiconnectTypes.h.

enum NetworkSecurity

Network security type.

Definition at line 282 of file WiconnectTypes.h.

enum NetworkSignalStrength

Network RSSI signal level.

Enumerator:
NETWORK_RSSI_EXCELLENT 

> -20 dBm

NETWORK_RSSI_VERY_GOOD 

> -35 dBm

NETWORK_RSSI_GOOD 

> -50 dBm

NETWORK_RSSI_POOR 

> -70 dBm

NETWORK_RSSI_VERY_POOR 

< -71 dBm

NETWORK_RSSI_UNKNOWN 

Not available.

Definition at line 268 of file WiconnectTypes.h.

enum NetworkStatus

Network connection status.

Enumerator:
NETWORK_STATUS_DOWN 

Not connected to network.

NETWORK_STATUS_WIFI_ONLY 

Connected to network but don't have IP address.

NETWORK_STATUS_UP 

Conntected to network and have IP address.

NETWORK_STATUS_JOINING 

Joining a network.

Definition at line 239 of file WiconnectTypes.h.