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

Core Types. More...

Data Structures

class  SerialConfig
 Host<->Wiconnect Module serial configuration. More...
class  Callback
 Generic callback function. More...
class  LogFunc
 Logging callback function. More...
class  QueuedCommand
 Class which contains command for asynchronous processing. More...
class  ReaderFunc
 Generic data reading callback function. More...
class  Wiconnect
 The root WiConnect library class. More...

Typedefs

typedef PinName Pin
 Pin name on HOST.

Enumerations

enum  WiconnectResult {
  WICONNECT_ABORTED = 3, WICONNECT_IDLE = 2, WICONNECT_PROCESSING = 1, WICONNECT_SUCCESS = 0,
  WICONNECT_ERROR = -1, WICONNECT_CMD_RESPONSE_ERROR = -2, WICONNECT_NULL_BUFFER = -3, WICONNECT_NOT_INITIALIZED = -4,
  WICONNECT_OVERFLOW = -5, WICONNECT_TIMEOUT = -6, WICONNECT_RESPONSE_PARSE_ERROR = -8, WICONNECT_ANOTHER_CMD_EXECUTING = -9,
  WICONNECT_BAD_ARG = -10, WICONNECT_UNSUPPORTED = -11, WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL = -12, WICONNECT_DUPLICATE = -13,
  WICONNECT_NOT_FOUND = -14, WICONNECT_PINNAME_TO_GPIO_NO_MAPPING = -15, WICONNECT_NOT_CONNECTED = -16, WICONNECT_UNDERFLOW = -17,
  WICONNECT_MONITOR_NOT_AVAILABLE = -18, WICONNECT_NOT_OPENED_FOR_READING = -19, WICONNECT_FIRMWARE_OUTDATED = -20
}
 

API Result code.

More...

Detailed Description

Core Types.


Typedef Documentation

typedef PinName Pin

Pin name on HOST.

Definition at line 142 of file sdk.h.


Enumeration Type Documentation

enum WiconnectResult

API Result code.

Enumerator:
WICONNECT_ABORTED 

Command was aborted.

WICONNECT_IDLE 

Library not processing any commands.

WICONNECT_PROCESSING 

Library processing current command.

WICONNECT_SUCCESS 

Command successfully completed.

WICONNECT_ERROR 

Generic error.

WICONNECT_CMD_RESPONSE_ERROR 

Module returned error code.

WICONNECT_NULL_BUFFER 

Null buffer supplied.

WICONNECT_NOT_INITIALIZED 

Library not initialed.

WICONNECT_OVERFLOW 

Buffer overflowed.

WICONNECT_TIMEOUT 

Command timed out.

WICONNECT_RESPONSE_PARSE_ERROR 

Failed to parse module response.

WICONNECT_ANOTHER_CMD_EXECUTING 

Currently executing another command.

WICONNECT_BAD_ARG 

Bad argument supplied.

WICONNECT_UNSUPPORTED 

Command / parameter not supported.

WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL 

The pinToGpioMapper hasn't been set.

WICONNECT_DUPLICATE 

Duplicate value.

WICONNECT_NOT_FOUND 

Not found.

WICONNECT_PINNAME_TO_GPIO_NO_MAPPING 

No mapping found for given pin.

WICONNECT_NOT_CONNECTED 

Not connected.

WICONNECT_UNDERFLOW 

Data underflow.

WICONNECT_MONITOR_NOT_AVAILABLE 

Background processing monitor is not available (i.e in use)

WICONNECT_NOT_OPENED_FOR_READING 

The file is not open for reading.

WICONNECT_FIRMWARE_OUTDATED 

The WiFi module's firmware is out-dated. See updateFirmware() to update the firmware.

Definition at line 166 of file WiconnectTypes.h.