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

Core Types. More...

Classes

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

Typedefs

typedef PinName wiconnect::Pin
 Pin name on HOST.
 

Enumerations

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

Detailed Description

Core Types.

Enumeration Type Documentation

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.

Examples:
tcp_server/example.cpp, and web_setup/example.cpp.

Definition at line 166 of file WiconnectTypes.h.