The ESP-AT MQTT library project
A simple wrapper to the MQTT functionality found in the ESP-AT interpreter
Classes | Macros | Typedefs | Enumerations
AT.h File Reference
#include <inttypes.h>
#include <Arduino.h>
Include dependency graph for AT.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  AT_Class
 EspAT MQTT AT_Class definition. More...
 

Macros

#define AT_ERROR(x)   (x & 0x00ff0000)
 

Typedefs

typedef uint32_t at_status_t
 The return value of an AT operation. More...
 

Enumerations

enum  status_code_e {
  ESP_AT_SUB_OK = 0x00000000, ESP_AT_SUB_COMMON_ERROR = 0x01010000, ESP_AT_SUB_NO_TERMINATOR = 0x01020000, ESP_AT_SUB_NO_AT = 0x01030000,
  ESP_AT_SUB_PARA_LENGTH_MISMATCH = 0x01040000, ESP_AT_SUB_PARA_TYPE_MISMATCH = 0x01050000, ESP_AT_SUB_PARA_NUM_MISMATCH = 0x01060000, ESP_AT_SUB_PARA_INVALID = 0x01070000,
  ESP_AT_SUB_PARA_PARSE_FAIL = 0x01080000, ESP_AT_SUB_UNSUPPORT_CMD = 0x01090000, ESP_AT_SUB_CMD_EXEC_FAIL = 0x010a0000, ESP_AT_SUB_CMD_PROCESSING = 0x010b0000,
  ESP_AT_SUB_CMD_OP_ERROR = 0x010c0000, ESP_AT_SUB_CMD_ERROR = 0x010d0000, ESP_AT_SUB_CMD_TIMEOUT = 0x010e0000, ESP_AT_SUB_CMD_CONN_SYNCH = 0x010f0000,
  ESP_AT_SUB_CMD_CONN_ASYNCH = 0x01100000, ESP_AT_SUB_CMD_LAST_COMMAND
}
 Status codes that the AT handler can return. More...
 

Typedef Documentation

◆ at_status_t

typedef uint32_t at_status_t

The return value of an AT operation.

This value is represented by a member of the enum status_code_e. The caller can use the AT_ERROR macro to check for a specifik status code.

Enumeration Type Documentation

◆ status_code_e

Status codes that the AT handler can return.

These are basically the same return (error) codes that the ESP-AT module returns when an error is detected but we have added a few to simplify upper layer handling.

Enumerator
ESP_AT_SUB_OK 

All is good in life and no errors have been detected.

ESP_AT_SUB_COMMON_ERROR 

A generic error has occured, no more info is available.

ESP_AT_SUB_NO_TERMINATOR 

The At interpretor did not detect a terminator.

ESP_AT_SUB_NO_AT 

Command was not prepended with "AT".

ESP_AT_SUB_PARA_LENGTH_MISMATCH 

Mismatch in the parameter length.

ESP_AT_SUB_PARA_TYPE_MISMATCH 

Wrong parameter type.

ESP_AT_SUB_PARA_NUM_MISMATCH 

Incorrect number of parameters.

ESP_AT_SUB_PARA_INVALID 

Invalid parameter value.

ESP_AT_SUB_PARA_PARSE_FAIL 

Failed to parse parameter.

ESP_AT_SUB_UNSUPPORT_CMD 

Found unsupported command.

ESP_AT_SUB_CMD_EXEC_FAIL 

Command execution failed.

ESP_AT_SUB_CMD_PROCESSING 

Error in command processing, this error always occur before a MQTT error happens.

ESP_AT_SUB_CMD_OP_ERROR 

Error while performing and operation.

ESP_AT_SUB_CMD_ERROR 

Generic command error.

ESP_AT_SUB_CMD_TIMEOUT 

AT_Class timout waiting for a reply from the interpreter.

ESP_AT_SUB_CMD_CONN_SYNCH 

MQTT connection was synchronous.

ESP_AT_SUB_CMD_CONN_ASYNCH 

MQTT connection was asynchronous, a callback will be issued when the connection is made.