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
Diff: WiconnectTypes.h
- Revision:
- 13:2b51f5267c92
- Parent:
- 11:ea484e1b7fc4
- Child:
- 16:7f1d6d359787
diff -r 3dfec824715a -r 2b51f5267c92 WiconnectTypes.h --- a/WiconnectTypes.h Tue Aug 12 02:44:34 2014 -0700 +++ b/WiconnectTypes.h Wed Aug 13 03:14:30 2014 -0700 @@ -121,7 +121,7 @@ /** - * @ingroup types_core + * @ingroup api_core_types * @brief API Result code */ typedef enum @@ -166,8 +166,9 @@ typedef int8_t (*PinToGpioMapper)(Pin pin); /** - * @ingroup types_core * @brief Generic buffer type + * + * @note Internal use only */ typedef struct { @@ -184,18 +185,19 @@ /** - * @ingroup types_network + * @ingroup api_network_types * @brief Network connection status */ typedef enum { 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_UP, ///< Conntected to network and have IP address + NETWORK_STATUS_JOINING ///< Joining a network } NetworkStatus; /** - * @ingroup types_network + * @ingroup api_network_types * @brief Network RSSI signal level */ typedef enum @@ -209,7 +211,7 @@ } NetworkSignalStrength; /** - * @ingroup types_network + * @ingroup api_network_types * @brief Network security type */ typedef enum @@ -225,7 +227,7 @@ } NetworkSecurity; /** - * @ingroup types_network + * @ingroup api_network_types * @brief Network SSID type */ typedef struct @@ -235,7 +237,7 @@ } Ssid; /** - * @ingroup types_network + * @ingroup api_network_types * @brief Network MAC Address type */ typedef struct @@ -244,19 +246,19 @@ } MacAddress; /** - * @ingroup types_network + * @ingroup api_network_types * @brief Buffer to hold a MAC address string */ typedef char MacAddressStrBuffer[18]; /** - * @ingroup types_network + * @ingroup api_network_types * @brief Buffer to hold a SSID string */ typedef char SsidStrBuffer[129]; /** - * @ingroup types_network + * @ingroup api_network_types * @brief Buffer to hold an IP address string */ typedef char IpStrBuffer[18]; @@ -266,7 +268,7 @@ /** - * @ingroup types_socket + * @ingroup api_socket_types * @brief Socket type */ typedef enum @@ -279,7 +281,7 @@ } SocketType; /** - * @ingroup types_socket + * @ingroup api_socket_types * @brief HTTP Socket sub-type */ typedef enum @@ -290,7 +292,7 @@ } HttpSocketType; /** - * @ingroup types_socket + * @ingroup api_socket_types * @brief Struct for hold HTTP socket configuration */ typedef struct @@ -306,7 +308,7 @@ /** - * @ingroup types_file + * @ingroup api_file_types * @brief File flags type */ typedef enum @@ -325,7 +327,7 @@ } FileFlags; /** - * @ingroup types_file + * @ingroup api_file_types * @brief File type type */ typedef enum