ACKme Logo WiConnect Host Library- API Reference Guide
 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Types

Network Types. More...

Classes

class  wiconnect::NetworkInterface
 The provides an interface for joining and/or creating a network. It provides other utilities such as scanning for networks, pinging a network, resolving a domain name to IP address. More...
 
struct  wiconnect::Ssid
 Network SSID type. More...
 
struct  wiconnect::MacAddress
 Network MAC Address type. More...
 
class  wiconnect::ScanResult
 Contains single entry from WiFi scan results. More...
 
class  wiconnect::ScanResultList
 List of WiFi network scan results. More...
 

Typedefs

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

Enumerations

enum  wiconnect::NetworkStatus {
  wiconnect::NETWORK_STATUS_DOWN,
  wiconnect::NETWORK_STATUS_WIFI_ONLY,
  wiconnect::NETWORK_STATUS_UP,
  wiconnect::NETWORK_STATUS_JOINING
}
 Network connection status. More...
 
enum  wiconnect::NetworkJoinResult {
  wiconnect::NETWORK_JOIN_RESULT_NONE,
  wiconnect::NETWORK_JOIN_RESULT_SUCCESS,
  wiconnect::NETWORK_JOIN_RESULT_JOINING,
  wiconnect::NETWORK_JOIN_RESULT_NO_SSID,
  wiconnect::NETWORK_JOIN_RESULT_NO_PASSWORD,
  wiconnect::NETWORK_JOIN_RESULT_BAD_SECURITY,
  wiconnect::NETWORK_JOIN_RESULT_NOT_FOUND,
  wiconnect::NETWORK_JOIN_RESULT_FAILED,
  wiconnect::NETWORK_JOIN_RESULT_ABORTED
}
 Network connection status. More...
 
enum  wiconnect::NetworkSignalStrength {
  wiconnect::NETWORK_RSSI_EXCELLENT = 0,
  wiconnect::NETWORK_RSSI_VERY_GOOD = 1,
  wiconnect::NETWORK_RSSI_GOOD = 2,
  wiconnect::NETWORK_RSSI_POOR = 3,
  wiconnect::NETWORK_RSSI_VERY_POOR = 4,
  wiconnect::NETWORK_RSSI_UNKNOWN = 5
}
 Network RSSI signal level. More...
 
enum  wiconnect::NetworkSecurity
 Network security type.
 

Detailed Description

Network Types.

Enumeration Type Documentation

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 236 of file WiconnectTypes.h.

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 253 of file WiconnectTypes.h.

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 224 of file WiconnectTypes.h.