![]() |
WiConnect Host Library- API Reference Guide | ||
The entire Wiconnect Library is contained within the 'wiconnect' namespace. More...
Classes | |
class | Callback |
Generic callback function. More... | |
class | FileInterface |
The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. More... | |
class | FileList |
WiConnect WiFi module file listing. More... | |
class | FunctionPointer |
Generic function pointer. More... | |
struct | GhmElement |
goHACK.me stream or control value More... | |
struct | GhmElementArray |
Array of goHACK.me stream or control values. More... | |
class | GhmInterface |
The provides an interface for http://goHACK.me. More... | |
class | GhmMessage |
Contains single entry from goHACK.me message listing. More... | |
class | GhmMessageList |
List of goHACK.me messages. More... | |
struct | HttpSocketArgs |
Struct for hold HTTP socket configuration. More... | |
class | LogFunc |
Logging callback function. More... | |
struct | MacAddress |
Network MAC Address type. More... | |
class | 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... | |
class | QueuedCommand |
Class which contains command for asynchronous processing. More... | |
class | ReaderFunc |
Generic data reading callback function. More... | |
class | ScanResult |
Contains single entry from WiFi scan results. More... | |
class | ScanResultList |
List of WiFi network scan results. More... | |
class | SerialConfig |
Host<->Wiconnect Module serial configuration. More... | |
class | SocketInterface |
The provides an interface for creating TCP/UDP/TLS/HTTP client sockets. A client socket connects to a remote server. More... | |
struct | Ssid |
Network SSID type. More... | |
class | Wiconnect |
The root WiConnect library class. This class inheriets all WiConnect functionality. More... | |
class | WiconnectFile |
WiConnect WiFi module file object. More... | |
class | WiconnectSocket |
Connection object to remote server. More... | |
class | WiconnectUdpServer |
UDP Server Listening socket. More... | |
Typedefs | |
typedef int8_t(* | PinToGpioMapper )(Pin pin) |
Function pointer for mapping from a host pin to a WiConnect Module GPIO. More... | |
typedef unsigned long | TimerTimeout |
Timeout type. | |
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. | |
typedef PinName | Pin |
Pin name on HOST. | |
The entire Wiconnect Library is contained within the 'wiconnect' namespace.
ACKme WiConnect Host Library is licensed under the BSD licence:
Copyright (c)2014 ACKme Networks. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
typedef int8_t(* wiconnect::PinToGpioMapper)(Pin pin) |
Function pointer for mapping from a host pin to a WiConnect Module GPIO.
[in] | pin | A host pin |
Definition at line 207 of file WiconnectTypes.h.