request: ability to print error codes

[larsonmpdx]

below is what I'm using internally, I'd like to see this or a C version in the SDK so I don't need to maintain it.

//` see https://github.com/aws/aws-iot-device-sdk-embedded-C/blob/master/include/aws_iot_error.h
std::string getAWSIotErrorName(IoT_Error_t rc)
{
   switch (rc)
   {
     /** Returned when the Network physical layer is connected */
            case NETWORK_PHYSICAL_LAYER_CONNECTED: return "NETWORK_PHYSICAL_LAYER_CONNECTED";
    /** Returned when the Network is manually disconnected */
            case NETWORK_MANUALLY_DISCONNECTED: return "NETWORK_MANUALLY_DISCONNECTED";
    /** Returned when the Network is disconnected and the reconnect attempt is in progress */
            case NETWORK_ATTEMPTING_RECONNECT: return "NETWORK_ATTEMPTING_RECONNECT";
    /** Return value of yield function to indicate auto-reconnect was successful */
            case NETWORK_RECONNECTED: return "NETWORK_RECONNECTED";
    /** Returned when a read attempt is made on the TLS buffer and it is empty */
            case MQTT_NOTHING_TO_READ: return "MQTT_NOTHING_TO_READ";
    /** Returned when a connection request is successful and packet response is connection accepted */
            case MQTT_CONNACK_CONNECTION_ACCEPTED: return "MQTT_CONNACK_CONNECTION_ACCEPTED";
    /** Success return value - no error occurred */
            case SUCCESS: return "SUCCESS";
    /** A generic error. Not enough information for a specific error code */
            case FAILURE: return "FAILURE";
    /** A required parameter was passed as null */
            case NULL_VALUE_ERROR: return "NULL_VALUE_ERROR";
    /** The TCP socket could not be established */
            case TCP_CONNECTION_ERROR: return "TCP_CONNECTION_ERROR";
    /** The TLS handshake failed */
            case SSL_CONNECTION_ERROR: return "SSL_CONNECTION_ERROR";
    /** Error associated with setting up the parameters of a Socket */
            case TCP_SETUP_ERROR: return "TCP_SETUP_ERROR";
    /** A timeout occurred while waiting for the TLS handshake to complete. */
            case NETWORK_SSL_CONNECT_TIMEOUT_ERROR: return "NETWORK_SSL_CONNECT_TIMEOUT_ERROR";
    /** A Generic write error based on the platform used */
            case NETWORK_SSL_WRITE_ERROR: return "NETWORK_SSL_WRITE_ERROR";
    /** SSL initialization error at the TLS layer */
            case NETWORK_SSL_INIT_ERROR: return "NETWORK_SSL_INIT_ERROR";
    /** An error occurred when loading the certificates.  The certificates could not be located or are incorrectly formatted. */
            case NETWORK_SSL_CERT_ERROR: return "NETWORK_SSL_CERT_ERROR";
    /** SSL Write times out */
            case NETWORK_SSL_WRITE_TIMEOUT_ERROR: return "NETWORK_SSL_WRITE_TIMEOUT_ERROR";
    /** SSL Read times out */
            case NETWORK_SSL_READ_TIMEOUT_ERROR: return "NETWORK_SSL_READ_TIMEOUT_ERROR";
    /** A Generic error based on the platform used */
            case NETWORK_SSL_READ_ERROR: return "NETWORK_SSL_READ_ERROR";
    /** Returned when the Network is disconnected and reconnect is either disabled or physical layer is disconnected */
            case NETWORK_DISCONNECTED_ERROR: return "NETWORK_DISCONNECTED_ERROR";
    /** Returned when the Network is disconnected and the reconnect attempt has timed out */
            case NETWORK_RECONNECT_TIMED_OUT_ERROR: return "NETWORK_RECONNECT_TIMED_OUT_ERROR";
    /** Returned when the Network is already connected and a connection attempt is made */
            case NETWORK_ALREADY_CONNECTED_ERROR: return "NETWORK_ALREADY_CONNECTED_ERROR";
    /** Network layer Error Codes */
    /** Network layer Random number generator seeding failed */
            case NETWORK_MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED: return "NETWORK_MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED";
    /** A generic error code for Network layer errors */
            case NETWORK_SSL_UNKNOWN_ERROR: return "NETWORK_SSL_UNKNOWN_ERROR";
    /** Returned when the physical layer is disconnected */
            case NETWORK_PHYSICAL_LAYER_DISCONNECTED: return "NETWORK_PHYSICAL_LAYER_DISCONNECTED";
    /** Returned when the root certificate is invalid */
            case NETWORK_X509_ROOT_CRT_PARSE_ERROR: return "NETWORK_X509_ROOT_CRT_PARSE_ERROR";
    /** Returned when the device certificate is invalid */
            case NETWORK_X509_DEVICE_CRT_PARSE_ERROR: return "NETWORK_X509_DEVICE_CRT_PARSE_ERROR";
    /** Returned when the private key failed to parse */
            case NETWORK_PK_PRIVATE_KEY_PARSE_ERROR: return "NETWORK_PK_PRIVATE_KEY_PARSE_ERROR";
    /** Returned when the network layer failed to open a socket */
            case NETWORK_ERR_NET_SOCKET_FAILED: return "NETWORK_ERR_NET_SOCKET_FAILED";
    /** Returned when the server is unknown */
            case NETWORK_ERR_NET_UNKNOWN_HOST: return "NETWORK_ERR_NET_UNKNOWN_HOST";
    /** Returned when connect request failed */
            case NETWORK_ERR_NET_CONNECT_FAILED: return "NETWORK_ERR_NET_CONNECT_FAILED";
    /** Returned when there is nothing to read in the TLS read buffer */
            case NETWORK_SSL_NOTHING_TO_READ: return "NETWORK_SSL_NOTHING_TO_READ";
    /** A connection could not be established. */
            case MQTT_CONNECTION_ERROR: return "MQTT_CONNECTION_ERROR";
    /** A timeout occurred while waiting for the TLS handshake to complete */
            case MQTT_CONNECT_TIMEOUT_ERROR: return "MQTT_CONNECT_TIMEOUT_ERROR";
    /** A timeout occurred while waiting for the TLS request complete */
            case MQTT_REQUEST_TIMEOUT_ERROR: return "MQTT_REQUEST_TIMEOUT_ERROR";
    /** The current client state does not match the expected value */
            case MQTT_UNEXPECTED_CLIENT_STATE_ERROR: return "MQTT_UNEXPECTED_CLIENT_STATE_ERROR";
    /** The client state is not idle when request is being made */
            case MQTT_CLIENT_NOT_IDLE_ERROR: return "MQTT_CLIENT_NOT_IDLE_ERROR";
    /** The MQTT RX buffer received corrupt or unexpected message  */
            case MQTT_RX_MESSAGE_PACKET_TYPE_INVALID_ERROR: return "MQTT_RX_MESSAGE_PACKET_TYPE_INVALID_ERROR";
    /** The MQTT RX buffer received a bigger message. The message will be dropped  */
            case MQTT_RX_BUFFER_TOO_SHORT_ERROR: return "MQTT_RX_BUFFER_TOO_SHORT_ERROR";
    /** The MQTT TX buffer is too short for the outgoing message. Request will fail  */
            case MQTT_TX_BUFFER_TOO_SHORT_ERROR: return "MQTT_TX_BUFFER_TOO_SHORT_ERROR";
    /** The client is subscribed to the maximum possible number of subscriptions  */
            case MQTT_MAX_SUBSCRIPTIONS_REACHED_ERROR: return "MQTT_MAX_SUBSCRIPTIONS_REACHED_ERROR";
    /** Failed to decode the remaining packet length on incoming packet */
            case MQTT_DECODE_REMAINING_LENGTH_ERROR: return "MQTT_DECODE_REMAINING_LENGTH_ERROR";
    /** Connect request failed with the server returning an unknown error */
            case MQTT_CONNACK_UNKNOWN_ERROR: return "MQTT_CONNACK_UNKNOWN_ERROR";
    /** Connect request failed with the server returning an unacceptable protocol version error */
            case MQTT_CONNACK_UNACCEPTABLE_PROTOCOL_VERSION_ERROR: return "MQTT_CONNACK_UNACCEPTABLE_PROTOCOL_VERSION_ERROR";
    /** Connect request failed with the server returning an identifier rejected error */
            case MQTT_CONNACK_IDENTIFIER_REJECTED_ERROR: return "MQTT_CONNACK_IDENTIFIER_REJECTED_ERROR";
    /** Connect request failed with the server returning an unavailable error */
            case MQTT_CONNACK_SERVER_UNAVAILABLE_ERROR: return "MQTT_CONNACK_SERVER_UNAVAILABLE_ERROR";
    /** Connect request failed with the server returning a bad userdata error */
            case MQTT_CONNACK_BAD_USERDATA_ERROR: return "MQTT_CONNACK_BAD_USERDATA_ERROR";
    /** Connect request failed with the server failing to authenticate the request */
            case MQTT_CONNACK_NOT_AUTHORIZED_ERROR: return "MQTT_CONNACK_NOT_AUTHORIZED_ERROR";
    /** An error occurred while parsing the JSON string.  Usually malformed JSON. */
            case JSON_PARSE_ERROR: return "JSON_PARSE_ERROR";
    /** Shadow: The response Ack table is currently full waiting for previously published updates */
            case SHADOW_WAIT_FOR_PUBLISH: return "SHADOW_WAIT_FOR_PUBLISH";
    /** Any time an snprintf writes more than size value; this error will be returned */
            case SHADOW_JSON_BUFFER_TRUNCATED: return "SHADOW_JSON_BUFFER_TRUNCATED";
    /** Any time an snprintf encounters an encoding error or not enough space in the given buffer */
            case SHADOW_JSON_ERROR: return "SHADOW_JSON_ERROR";
    /** Mutex initialization failed */
            case MUTEX_INIT_ERROR: return "MUTEX_INIT_ERROR";
    /** Mutex lock request failed */
            case MUTEX_LOCK_ERROR: return "MUTEX_LOCK_ERROR";
    /** Mutex unlock request failed */
            case MUTEX_UNLOCK_ERROR: return "MUTEX_UNLOCK_ERROR";
    /** Mutex destroy failed */
            case MUTEX_DESTROY_ERROR: return "MUTEX_DESTROY_ERROR";

      default:
        std::stringstream buffer;
        buffer << "unknown error: " << rc;
        return buffer.str();
   }
}

[chaurah]

Hi @larsonmpdx,
Thank you for this suggestion. We are working on improving SDK error reporting in the next version and this or something similar will definitely be a part of the code. Please do let us know if you have any other thoughts on how we can improve the SDK.

Rahul