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
api/README.h@34:2616445d0823, 2014-11-26 (annotated)
- Committer:
- dan_ackme
- Date:
- Wed Nov 26 23:46:00 2014 -0800
- Revision:
- 34:2616445d0823
- Parent:
- 29:b6af04b77a56
added support for out-dated wifi firmware
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
dan_ackme | 29:b6af04b77a56 | 1 | /** |
dan_ackme | 29:b6af04b77a56 | 2 | * @mainpage Library Overview |
dan_ackme | 29:b6af04b77a56 | 3 | * |
dan_ackme | 29:b6af04b77a56 | 4 | * @section Overview |
dan_ackme | 29:b6af04b77a56 | 5 | * The WiConnect Library runs on a host MCU and controls a |
dan_ackme | 29:b6af04b77a56 | 6 | * WiConnect enabled WiFi module. This library is essentially a |
dan_ackme | 34:2616445d0823 | 7 | * programming API for the WiConnect serial command set. |
dan_ackme | 34:2616445d0823 | 8 | * More infomation about the serial command set may be found here: |
dan_ackme | 29:b6af04b77a56 | 9 | * <a href="http://wiconnect.ack.me" target="_blank">WiConnect Reference Guide</a> |
dan_ackme | 29:b6af04b77a56 | 10 | * |
dan_ackme | 34:2616445d0823 | 11 | * @if mbed_sdk |
dan_ackme | 34:2616445d0823 | 12 | * The library may be downloaded from here: <a href="http://developer.mbed.org/teams/ACKme/code/WiConnect/" target="_blank">WiConnect Repository</a> |
dan_ackme | 34:2616445d0823 | 13 | * @else |
dan_ackme | 34:2616445d0823 | 14 | * The library may be downloaded from here: <a href="https://bitbucket.org/ackme/ackme_wiconnect_library/src" target="_blank">WiConnect Repository</a> |
dan_ackme | 34:2616445d0823 | 15 | * @endif |
dan_ackme | 34:2616445d0823 | 16 | * |
dan_ackme | 29:b6af04b77a56 | 17 | * @section notes Important Notes |
dan_ackme | 29:b6af04b77a56 | 18 | * - This class is implemented as a 'singleton'. This means it only needs to be |
dan_ackme | 29:b6af04b77a56 | 19 | * instantiated once. |
dan_ackme | 29:b6af04b77a56 | 20 | * - The WiConnect library does NOT call the global 'new' or 'malloc' functions. |
dan_ackme | 29:b6af04b77a56 | 21 | * All memory allocation (if required) comes from a user supplied malloc function pointer or buffer |
dan_ackme | 29:b6af04b77a56 | 22 | * |
dan_ackme | 29:b6af04b77a56 | 23 | * |
dan_ackme | 29:b6af04b77a56 | 24 | * @section features Library Settings |
dan_ackme | 29:b6af04b77a56 | 25 | * The WiConnect Library has multiple settings so as to allow |
dan_ackme | 29:b6af04b77a56 | 26 | * for the most flexibility within a user's application. |
dan_ackme | 29:b6af04b77a56 | 27 | * |
dan_ackme | 29:b6af04b77a56 | 28 | * Some of these configurations are as follows: |
dan_ackme | 29:b6af04b77a56 | 29 | * - Blocking / Non-blocking |
dan_ackme | 29:b6af04b77a56 | 30 | * - Dynamic / Static allocation |
dan_ackme | 29:b6af04b77a56 | 31 | * - Asynchronous Processing |
dan_ackme | 29:b6af04b77a56 | 32 | * |
dan_ackme | 29:b6af04b77a56 | 33 | * |
dan_ackme | 29:b6af04b77a56 | 34 | * @subsection setting_blocking_modes Blocking / Non-blocking Modes |
dan_ackme | 29:b6af04b77a56 | 35 | * The WiConnect Library may be configured for either 'blocking' or |
dan_ackme | 29:b6af04b77a56 | 36 | * 'non-blocking' operation: |
dan_ackme | 29:b6af04b77a56 | 37 | * - blocking - API calls do not return until they complete successfully or timeout. |
dan_ackme | 29:b6af04b77a56 | 38 | * - non-blocking - API calls return immediately. The caller should check the return code to see |
dan_ackme | 29:b6af04b77a56 | 39 | * if the command is still processing, completed, or an error occurred. The caller |
dan_ackme | 29:b6af04b77a56 | 40 | * should continue to call the API function (as often as possible) until it returns |
dan_ackme | 29:b6af04b77a56 | 41 | * either a success or error code. |
dan_ackme | 29:b6af04b77a56 | 42 | * |
dan_ackme | 29:b6af04b77a56 | 43 | * @subsubsection setting_blocking_mode Blocking Mode |
dan_ackme | 29:b6af04b77a56 | 44 | * In blocking mode, an API function will block until it completes. |
dan_ackme | 29:b6af04b77a56 | 45 | * More details to come... |
dan_ackme | 29:b6af04b77a56 | 46 | * |
dan_ackme | 29:b6af04b77a56 | 47 | * @subsubsection setting_nonblocking_mode Non-Blocking Mode |
dan_ackme | 29:b6af04b77a56 | 48 | * In non-blocking mode, an API function returns immediately. |
dan_ackme | 29:b6af04b77a56 | 49 | * More details to come... |
dan_ackme | 29:b6af04b77a56 | 50 | * |
dan_ackme | 29:b6af04b77a56 | 51 | * |
dan_ackme | 29:b6af04b77a56 | 52 | * |
dan_ackme | 29:b6af04b77a56 | 53 | * @subsection setting_alloc Dynamic / Static Allocation |
dan_ackme | 29:b6af04b77a56 | 54 | * There are two cases when memory allocation is required: |
dan_ackme | 29:b6af04b77a56 | 55 | * - Buffer allocation |
dan_ackme | 29:b6af04b77a56 | 56 | * - Class instantiation |
dan_ackme | 29:b6af04b77a56 | 57 | * |
dan_ackme | 29:b6af04b77a56 | 58 | * In both cases, either static or dynamic memory allocation may be used. |
dan_ackme | 29:b6af04b77a56 | 59 | * |
dan_ackme | 29:b6af04b77a56 | 60 | * In cases when memory allocation is needed, the API call requires a buffer pointer |
dan_ackme | 29:b6af04b77a56 | 61 | * and length parameters. If both are supplied, the library uses the supplied external buffer. |
dan_ackme | 29:b6af04b77a56 | 62 | * This is considered static allocation (however the buffer could have been dynamically allocated). |
dan_ackme | 29:b6af04b77a56 | 63 | * The caller is responsible for maintaining the supplied buffer. |
dan_ackme | 29:b6af04b77a56 | 64 | * |
dan_ackme | 29:b6af04b77a56 | 65 | * If, however, only the buffer length is supplied and the buffer pointer is NULL |
dan_ackme | 29:b6af04b77a56 | 66 | * the Wiconnect Library will call the user supplied malloc() function. This is considered |
dan_ackme | 29:b6af04b77a56 | 67 | * dynamic allocation. In this case, the library will maintain the buffer and release it |
dan_ackme | 29:b6af04b77a56 | 68 | * when necessary using the user supplied free() function. |
dan_ackme | 29:b6af04b77a56 | 69 | * |
dan_ackme | 29:b6af04b77a56 | 70 | * @note To use dynamic allocation the WiConnect Library must be compiled with |
dan_ackme | 29:b6af04b77a56 | 71 | * @ref WICONNECT_ENABLE_MALLOC defined, and the Wiconnect() constructor must be |
dan_ackme | 29:b6af04b77a56 | 72 | * supplied with pointers to malloc() and free() functions. |
dan_ackme | 29:b6af04b77a56 | 73 | * |
dan_ackme | 29:b6af04b77a56 | 74 | * @note The Wiconnect Library does NOT call the global 'new' operator. Classes that are |
dan_ackme | 29:b6af04b77a56 | 75 | * internally instantiated overload the 'new' operator and either call the user |
dan_ackme | 29:b6af04b77a56 | 76 | * supplied malloc() function or use the supplied static buffer. |
dan_ackme | 29:b6af04b77a56 | 77 | * |
dan_ackme | 29:b6af04b77a56 | 78 | * |
dan_ackme | 29:b6af04b77a56 | 79 | * @subsection setting_async_processing Asynchronous Processing |
dan_ackme | 29:b6af04b77a56 | 80 | * When applicable, the WiConnect Library will asynchronously process |
dan_ackme | 29:b6af04b77a56 | 81 | * commands in the background. When the background processing completes, the |
dan_ackme | 29:b6af04b77a56 | 82 | * supplied callback is called. |
dan_ackme | 29:b6af04b77a56 | 83 | * |
dan_ackme | 29:b6af04b77a56 | 84 | * User commands may also be executed in the background using the enqueueCommand() |
dan_ackme | 29:b6af04b77a56 | 85 | * API function. |
dan_ackme | 29:b6af04b77a56 | 86 | * |
dan_ackme | 29:b6af04b77a56 | 87 | * @note The WiConnect Library must be compiled with @ref WICONNECT_ASYNC_TIMER_ENABLED |
dan_ackme | 29:b6af04b77a56 | 88 | * defined for background processing to be enabled. |
dan_ackme | 29:b6af04b77a56 | 89 | * |
dan_ackme | 29:b6af04b77a56 | 90 | * |
dan_ackme | 29:b6af04b77a56 | 91 | * |
dan_ackme | 29:b6af04b77a56 | 92 | * @section send_command_desc Sending Commands To WiFi Module |
dan_ackme | 29:b6af04b77a56 | 93 | * More details to come... |
dan_ackme | 29:b6af04b77a56 | 94 | * |
dan_ackme | 29:b6af04b77a56 | 95 | * |
dan_ackme | 29:b6af04b77a56 | 96 | */ |
dan_ackme | 29:b6af04b77a56 | 97 | |
dan_ackme | 29:b6af04b77a56 | 98 | // ---------------------------------------------------------------------------- |
dan_ackme | 29:b6af04b77a56 | 99 | |
dan_ackme | 29:b6af04b77a56 | 100 | /** |
dan_ackme | 29:b6af04b77a56 | 101 | * @defgroup api_core Core |
dan_ackme | 29:b6af04b77a56 | 102 | * @brief This contains all core related operations |
dan_ackme | 29:b6af04b77a56 | 103 | * |
dan_ackme | 29:b6af04b77a56 | 104 | * @{ |
dan_ackme | 29:b6af04b77a56 | 105 | */ |
dan_ackme | 29:b6af04b77a56 | 106 | |
dan_ackme | 29:b6af04b77a56 | 107 | /** |
dan_ackme | 29:b6af04b77a56 | 108 | * @defgroup api_core_settings Settings Methods |
dan_ackme | 29:b6af04b77a56 | 109 | * @brief API getters/setters for core library settings |
dan_ackme | 29:b6af04b77a56 | 110 | */ |
dan_ackme | 29:b6af04b77a56 | 111 | |
dan_ackme | 29:b6af04b77a56 | 112 | /** |
dan_ackme | 29:b6af04b77a56 | 113 | * @defgroup api_core_send_command Send Command Methods |
dan_ackme | 29:b6af04b77a56 | 114 | * @brief API methods for sending commands to WiConnect WiFi module |
dan_ackme | 29:b6af04b77a56 | 115 | */ |
dan_ackme | 29:b6af04b77a56 | 116 | |
dan_ackme | 29:b6af04b77a56 | 117 | /** |
dan_ackme | 29:b6af04b77a56 | 118 | * @defgroup api_core_misc Miscellaneous Methods |
dan_ackme | 29:b6af04b77a56 | 119 | * @brief Other core methods |
dan_ackme | 29:b6af04b77a56 | 120 | */ |
dan_ackme | 29:b6af04b77a56 | 121 | |
dan_ackme | 29:b6af04b77a56 | 122 | /** |
dan_ackme | 29:b6af04b77a56 | 123 | * @defgroup api_core_types Types |
dan_ackme | 29:b6af04b77a56 | 124 | * @brief Core Types |
dan_ackme | 29:b6af04b77a56 | 125 | */ |
dan_ackme | 29:b6af04b77a56 | 126 | |
dan_ackme | 29:b6af04b77a56 | 127 | |
dan_ackme | 29:b6af04b77a56 | 128 | /** |
dan_ackme | 29:b6af04b77a56 | 129 | * @defgroup api_core_macro Macros |
dan_ackme | 29:b6af04b77a56 | 130 | * @brief Core macros |
dan_ackme | 29:b6af04b77a56 | 131 | */ |
dan_ackme | 29:b6af04b77a56 | 132 | |
dan_ackme | 29:b6af04b77a56 | 133 | /** |
dan_ackme | 29:b6af04b77a56 | 134 | * @defgroup api_core_examples Examples |
dan_ackme | 29:b6af04b77a56 | 135 | * @brief Core examples |
dan_ackme | 34:2616445d0823 | 136 | * @if mbed_sdk |
dan_ackme | 29:b6af04b77a56 | 137 | * * @ref ota/example.cpp |
dan_ackme | 34:2616445d0823 | 138 | * @endif |
dan_ackme | 29:b6af04b77a56 | 139 | */ |
dan_ackme | 29:b6af04b77a56 | 140 | |
dan_ackme | 29:b6af04b77a56 | 141 | // @} |
dan_ackme | 29:b6af04b77a56 | 142 | |
dan_ackme | 29:b6af04b77a56 | 143 | |
dan_ackme | 29:b6af04b77a56 | 144 | // ---------------------------------------------------------------------------- |
dan_ackme | 29:b6af04b77a56 | 145 | |
dan_ackme | 29:b6af04b77a56 | 146 | /** |
dan_ackme | 29:b6af04b77a56 | 147 | * @defgroup api_network Network |
dan_ackme | 29:b6af04b77a56 | 148 | * @brief This contains all network related operations |
dan_ackme | 29:b6af04b77a56 | 149 | * |
dan_ackme | 29:b6af04b77a56 | 150 | * @{ |
dan_ackme | 29:b6af04b77a56 | 151 | */ |
dan_ackme | 29:b6af04b77a56 | 152 | |
dan_ackme | 29:b6af04b77a56 | 153 | /** |
dan_ackme | 29:b6af04b77a56 | 154 | * @defgroup api_network_settings Settings Methods |
dan_ackme | 29:b6af04b77a56 | 155 | * @brief API getters/setters for module network settings |
dan_ackme | 29:b6af04b77a56 | 156 | */ |
dan_ackme | 29:b6af04b77a56 | 157 | |
dan_ackme | 29:b6af04b77a56 | 158 | /** |
dan_ackme | 29:b6af04b77a56 | 159 | * @defgroup api_network_wlan WLAN Methods |
dan_ackme | 29:b6af04b77a56 | 160 | * @brief Methods for joining/leaving a WLAN |
dan_ackme | 29:b6af04b77a56 | 161 | */ |
dan_ackme | 29:b6af04b77a56 | 162 | |
dan_ackme | 29:b6af04b77a56 | 163 | /** |
dan_ackme | 29:b6af04b77a56 | 164 | * @defgroup api_network_setup Web Setup Methods |
dan_ackme | 29:b6af04b77a56 | 165 | * @brief Methods for enabled/disabling module web setup |
dan_ackme | 29:b6af04b77a56 | 166 | */ |
dan_ackme | 29:b6af04b77a56 | 167 | |
dan_ackme | 29:b6af04b77a56 | 168 | /** |
dan_ackme | 29:b6af04b77a56 | 169 | * @defgroup api_network_util Utility Methods |
dan_ackme | 29:b6af04b77a56 | 170 | * @brief Network utility methods |
dan_ackme | 29:b6af04b77a56 | 171 | */ |
dan_ackme | 29:b6af04b77a56 | 172 | |
dan_ackme | 29:b6af04b77a56 | 173 | /** |
dan_ackme | 29:b6af04b77a56 | 174 | * @defgroup api_network_types Types |
dan_ackme | 29:b6af04b77a56 | 175 | * @brief Network Types |
dan_ackme | 29:b6af04b77a56 | 176 | */ |
dan_ackme | 29:b6af04b77a56 | 177 | |
dan_ackme | 29:b6af04b77a56 | 178 | /** |
dan_ackme | 29:b6af04b77a56 | 179 | * @defgroup api_network_macros Macros |
dan_ackme | 29:b6af04b77a56 | 180 | * @brief Network specific macros |
dan_ackme | 29:b6af04b77a56 | 181 | */ |
dan_ackme | 29:b6af04b77a56 | 182 | |
dan_ackme | 29:b6af04b77a56 | 183 | /** |
dan_ackme | 29:b6af04b77a56 | 184 | * @defgroup api_network_examples Examples |
dan_ackme | 29:b6af04b77a56 | 185 | * @brief Network examples |
dan_ackme | 34:2616445d0823 | 186 | * @if mbed_sdk |
dan_ackme | 29:b6af04b77a56 | 187 | * * @ref web_setup/example.cpp |
dan_ackme | 29:b6af04b77a56 | 188 | * * @ref join/example.cpp |
dan_ackme | 34:2616445d0823 | 189 | * * @ref tcp_echo_client/main.cpp |
dan_ackme | 34:2616445d0823 | 190 | * * @ref udp_echo_client/main.cpp |
dan_ackme | 34:2616445d0823 | 191 | * @elseif arduino_sdk |
dan_ackme | 34:2616445d0823 | 192 | * * @ref ConnectNoEncryption/ConnectNoEncryption.cpp |
dan_ackme | 34:2616445d0823 | 193 | * * @ref ConnectWithWPA/ConnectWithWPA.cpp |
dan_ackme | 34:2616445d0823 | 194 | * @endif |
dan_ackme | 29:b6af04b77a56 | 195 | */ |
dan_ackme | 29:b6af04b77a56 | 196 | |
dan_ackme | 29:b6af04b77a56 | 197 | // @} |
dan_ackme | 29:b6af04b77a56 | 198 | |
dan_ackme | 29:b6af04b77a56 | 199 | |
dan_ackme | 29:b6af04b77a56 | 200 | // ---------------------------------------------------------------------------- |
dan_ackme | 29:b6af04b77a56 | 201 | |
dan_ackme | 29:b6af04b77a56 | 202 | /** |
dan_ackme | 29:b6af04b77a56 | 203 | * @defgroup api_socket Socket |
dan_ackme | 29:b6af04b77a56 | 204 | * @brief This contains all socket related operations |
dan_ackme | 29:b6af04b77a56 | 205 | * |
dan_ackme | 29:b6af04b77a56 | 206 | * @{ |
dan_ackme | 29:b6af04b77a56 | 207 | */ |
dan_ackme | 29:b6af04b77a56 | 208 | |
dan_ackme | 29:b6af04b77a56 | 209 | /** |
dan_ackme | 29:b6af04b77a56 | 210 | * @defgroup api_socket_tcp TCP Methods |
dan_ackme | 29:b6af04b77a56 | 211 | * @brief TCP methods |
dan_ackme | 29:b6af04b77a56 | 212 | */ |
dan_ackme | 29:b6af04b77a56 | 213 | |
dan_ackme | 29:b6af04b77a56 | 214 | /** |
dan_ackme | 29:b6af04b77a56 | 215 | * @defgroup api_socket_udp UDP Methods |
dan_ackme | 29:b6af04b77a56 | 216 | * @brief UDP methods |
dan_ackme | 29:b6af04b77a56 | 217 | */ |
dan_ackme | 29:b6af04b77a56 | 218 | |
dan_ackme | 29:b6af04b77a56 | 219 | /** |
dan_ackme | 29:b6af04b77a56 | 220 | * @defgroup api_socket_tls TLS Methods |
dan_ackme | 29:b6af04b77a56 | 221 | * @brief TLS methods |
dan_ackme | 29:b6af04b77a56 | 222 | */ |
dan_ackme | 29:b6af04b77a56 | 223 | |
dan_ackme | 29:b6af04b77a56 | 224 | /** |
dan_ackme | 29:b6af04b77a56 | 225 | * @defgroup api_socket_http HTTP Methods |
dan_ackme | 29:b6af04b77a56 | 226 | * @brief HTTP methods |
dan_ackme | 29:b6af04b77a56 | 227 | */ |
dan_ackme | 29:b6af04b77a56 | 228 | |
dan_ackme | 29:b6af04b77a56 | 229 | /** |
dan_ackme | 29:b6af04b77a56 | 230 | * @defgroup api_socket_misc Miscellaneous Methods |
dan_ackme | 29:b6af04b77a56 | 231 | * @brief Miscellaneous socket methods |
dan_ackme | 29:b6af04b77a56 | 232 | */ |
dan_ackme | 29:b6af04b77a56 | 233 | |
dan_ackme | 29:b6af04b77a56 | 234 | /** |
dan_ackme | 29:b6af04b77a56 | 235 | * @defgroup api_socket_types Types |
dan_ackme | 29:b6af04b77a56 | 236 | * @brief Socket Types |
dan_ackme | 29:b6af04b77a56 | 237 | */ |
dan_ackme | 29:b6af04b77a56 | 238 | |
dan_ackme | 29:b6af04b77a56 | 239 | /** |
dan_ackme | 29:b6af04b77a56 | 240 | * @defgroup api_socket_macro Macros |
dan_ackme | 29:b6af04b77a56 | 241 | * @brief Socket specific macros |
dan_ackme | 29:b6af04b77a56 | 242 | */ |
dan_ackme | 29:b6af04b77a56 | 243 | |
dan_ackme | 29:b6af04b77a56 | 244 | /** |
dan_ackme | 29:b6af04b77a56 | 245 | * @defgroup api_socket_examples Examples |
dan_ackme | 29:b6af04b77a56 | 246 | * @brief Socket examples |
dan_ackme | 34:2616445d0823 | 247 | * @if mbed_sdk |
dan_ackme | 29:b6af04b77a56 | 248 | * * @ref http_get/example.cpp |
dan_ackme | 29:b6af04b77a56 | 249 | * * @ref tcp_server/example.cpp |
dan_ackme | 34:2616445d0823 | 250 | * @elseif arduino_sdk |
dan_ackme | 34:2616445d0823 | 251 | * * @ref SimpleWebServerWiFi/SimpleWebServerWiFi.cpp |
dan_ackme | 34:2616445d0823 | 252 | * * @ref WiFiChatServer/WiFiChatServer.cpp |
dan_ackme | 34:2616445d0823 | 253 | * * @ref WiFiUdpNtpClient/WiFiUdpNtpClient.cpp |
dan_ackme | 34:2616445d0823 | 254 | * * @ref WiFiUdpSendReceiveString/WiFiUdpSendReceiveString.cpp |
dan_ackme | 34:2616445d0823 | 255 | * * @ref WiFiWebClient/WiFiWebClient.cpp |
dan_ackme | 34:2616445d0823 | 256 | * * @ref WiFiWebClientRepeating/WiFiWebClientRepeating.cpp |
dan_ackme | 34:2616445d0823 | 257 | * * @ref WiFiWebServer/WiFiWebServer.cpp |
dan_ackme | 34:2616445d0823 | 258 | * @endif |
dan_ackme | 29:b6af04b77a56 | 259 | * |
dan_ackme | 29:b6af04b77a56 | 260 | */ |
dan_ackme | 29:b6af04b77a56 | 261 | |
dan_ackme | 29:b6af04b77a56 | 262 | // @} |
dan_ackme | 29:b6af04b77a56 | 263 | |
dan_ackme | 29:b6af04b77a56 | 264 | |
dan_ackme | 29:b6af04b77a56 | 265 | // ---------------------------------------------------------------------------- |
dan_ackme | 29:b6af04b77a56 | 266 | |
dan_ackme | 29:b6af04b77a56 | 267 | /** |
dan_ackme | 29:b6af04b77a56 | 268 | * @defgroup api_file File |
dan_ackme | 29:b6af04b77a56 | 269 | * @brief This contains all file related operations |
dan_ackme | 29:b6af04b77a56 | 270 | * |
dan_ackme | 29:b6af04b77a56 | 271 | * @{ |
dan_ackme | 29:b6af04b77a56 | 272 | */ |
dan_ackme | 29:b6af04b77a56 | 273 | |
dan_ackme | 29:b6af04b77a56 | 274 | /** |
dan_ackme | 29:b6af04b77a56 | 275 | * @defgroup api_file_methods Methods |
dan_ackme | 29:b6af04b77a56 | 276 | * @brief File methods |
dan_ackme | 29:b6af04b77a56 | 277 | */ |
dan_ackme | 29:b6af04b77a56 | 278 | |
dan_ackme | 29:b6af04b77a56 | 279 | /** |
dan_ackme | 29:b6af04b77a56 | 280 | * @defgroup api_file_types Types |
dan_ackme | 29:b6af04b77a56 | 281 | * @brief File types |
dan_ackme | 29:b6af04b77a56 | 282 | */ |
dan_ackme | 29:b6af04b77a56 | 283 | |
dan_ackme | 29:b6af04b77a56 | 284 | /** |
dan_ackme | 29:b6af04b77a56 | 285 | * @defgroup api_file_macro Macros |
dan_ackme | 29:b6af04b77a56 | 286 | * @brief API specific macros |
dan_ackme | 29:b6af04b77a56 | 287 | */ |
dan_ackme | 29:b6af04b77a56 | 288 | |
dan_ackme | 29:b6af04b77a56 | 289 | /** |
dan_ackme | 29:b6af04b77a56 | 290 | * @defgroup api_file_examples Examples |
dan_ackme | 29:b6af04b77a56 | 291 | * @brief File examples |
dan_ackme | 29:b6af04b77a56 | 292 | */ |
dan_ackme | 29:b6af04b77a56 | 293 | |
dan_ackme | 29:b6af04b77a56 | 294 | // @} |
dan_ackme | 29:b6af04b77a56 | 295 | |
dan_ackme | 29:b6af04b77a56 | 296 | // ---------------------------------------------------------------------------- |
dan_ackme | 29:b6af04b77a56 | 297 | |
dan_ackme | 29:b6af04b77a56 | 298 | /** |
dan_ackme | 29:b6af04b77a56 | 299 | * @defgroup api_ghm goHACK.me |
dan_ackme | 29:b6af04b77a56 | 300 | * @brief This contains all goHACK.me related operations |
dan_ackme | 29:b6af04b77a56 | 301 | * |
dan_ackme | 29:b6af04b77a56 | 302 | * @{ |
dan_ackme | 29:b6af04b77a56 | 303 | */ |
dan_ackme | 29:b6af04b77a56 | 304 | |
dan_ackme | 29:b6af04b77a56 | 305 | /** |
dan_ackme | 29:b6af04b77a56 | 306 | * @defgroup api_ghm_activate Activation |
dan_ackme | 29:b6af04b77a56 | 307 | * @brief Methods for activating/deactivating the module with http://goHACK.me |
dan_ackme | 29:b6af04b77a56 | 308 | */ |
dan_ackme | 29:b6af04b77a56 | 309 | |
dan_ackme | 29:b6af04b77a56 | 310 | /** |
dan_ackme | 29:b6af04b77a56 | 311 | * @defgroup api_ghm_com Read/Write |
dan_ackme | 29:b6af04b77a56 | 312 | * @brief Methods for reading & writing data from/to http://goHACK.me |
dan_ackme | 29:b6af04b77a56 | 313 | */ |
dan_ackme | 29:b6af04b77a56 | 314 | |
dan_ackme | 29:b6af04b77a56 | 315 | /** |
dan_ackme | 29:b6af04b77a56 | 316 | * @defgroup api_ghm_msg Message |
dan_ackme | 29:b6af04b77a56 | 317 | * @brief Methods for getting, posting, listing, deleting messages wtih http://goHACK.me |
dan_ackme | 29:b6af04b77a56 | 318 | */ |
dan_ackme | 29:b6af04b77a56 | 319 | |
dan_ackme | 29:b6af04b77a56 | 320 | /** |
dan_ackme | 29:b6af04b77a56 | 321 | * @defgroup api_ghm_types Types |
dan_ackme | 29:b6af04b77a56 | 322 | * @brief goHACK.me Types |
dan_ackme | 29:b6af04b77a56 | 323 | */ |
dan_ackme | 29:b6af04b77a56 | 324 | |
dan_ackme | 29:b6af04b77a56 | 325 | /** |
dan_ackme | 29:b6af04b77a56 | 326 | * @defgroup api_ghm_macro Macros |
dan_ackme | 29:b6af04b77a56 | 327 | * @brief API specific macros |
dan_ackme | 29:b6af04b77a56 | 328 | */ |
dan_ackme | 29:b6af04b77a56 | 329 | |
dan_ackme | 29:b6af04b77a56 | 330 | /** |
dan_ackme | 29:b6af04b77a56 | 331 | * @defgroup api_ghm_examples Examples |
dan_ackme | 29:b6af04b77a56 | 332 | * @brief goHACK.me examples |
dan_ackme | 34:2616445d0823 | 333 | * @if mbed_sdk |
dan_ackme | 34:2616445d0823 | 334 | * @elseif arduino_sdk |
dan_ackme | 34:2616445d0823 | 335 | * * @ref GhmLedMatrix/GhmLedMatrix.cpp |
dan_ackme | 34:2616445d0823 | 336 | * @endif |
dan_ackme | 29:b6af04b77a56 | 337 | */ |
dan_ackme | 29:b6af04b77a56 | 338 | |
dan_ackme | 29:b6af04b77a56 | 339 | // @} |
dan_ackme | 29:b6af04b77a56 | 340 | |
dan_ackme | 29:b6af04b77a56 | 341 | // ---------------------------------------------------------------------------- |
dan_ackme | 29:b6af04b77a56 | 342 | |
dan_ackme | 29:b6af04b77a56 | 343 | /** |
dan_ackme | 29:b6af04b77a56 | 344 | * @defgroup conversion_util Conversion Utilities |
dan_ackme | 29:b6af04b77a56 | 345 | * @brief This contains all the conversion utility static functions. |
dan_ackme | 29:b6af04b77a56 | 346 | * |
dan_ackme | 29:b6af04b77a56 | 347 | */ |
dan_ackme | 29:b6af04b77a56 | 348 | |
dan_ackme | 29:b6af04b77a56 | 349 |