docu/c/kdrive__express__error_8h_source.html

//

// Copyright (c) 2002-2022 WEINZIERL ENGINEERING GmbH

// All rights reserved.

//

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT

// SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY,

// WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

//


#ifndef __KDRIVE_EXPRESS_ERROR_H__

#define __KDRIVE_EXPRESS_ERROR_H__


#include "kdrive_express_config.h"


/*************************************

 ** Error Codes

 **************************************/


#define KDRIVE_ERROR_NONE                                                               (0x0000)

#define KDRIVE_UNKNOWN_ERROR                                                    (0x0001)

#define KDRIVE_POCO_ERROR                                                               (0x0002)

#define KDRIVE_TIMEOUT_ERROR                                                    (0x0003)

#define KDRIVE_SOCKET_ERROR                                                             (0x0004)

#define KDRIVE_UNSUPPORTED_DEVICE_ERROR                                 (0x0005)

#define KDRIVE_BUFFER_TOO_SMALL_ERROR                                   (0x0006)

#define KDRIVE_AP_DESCRIPTOR_NOT_FOUND_ERROR                    (0x0007)

#define KDRIVE_SP_DESCRIPTOR_NOT_FOUND_ERROR                    (0x0008)

#define KDRIVE_UNSUPPORTED_ERROR                                                (0x0009)

#define KDRIVE_INVALID_LICENSE_ERROR                                    (0x000A)

#define KDRIVE_OBJSER_DESCRIPTOR_NOT_FOUND_ERROR                (0x000B)

// 0x000C reserved. Was KDRIVE_FORMATER_DESCRIPTOR_NOT_FOUND_ERROR */

#define KDRIVE_GODIAG_DESCRIPTOR_NOT_FOUND_ERROR                (0x000D)

#define KDRIVE_RANGE_ERROR                                                              (0x000E)

#define KDRIVE_DATA_FORMAT_ERROR                                (0x000F)

#define KDRIVE_KEYRING_DESCRIPTOR_NOT_FOUND_ERROR               (0x0010)

#define KDRIVE_AP_ACCESS_PORT_ERROR                                             (0x1000)

#define KDRIVE_AP_NOT_FOUND_AVAILABLE_PORTS_ERROR               (0x1001)

#define KDRIVE_AP_PORT_NOT_OPEN_ERROR                                   (0x1002)

#define KDRIVE_AP_UNSUPPORTED_PORT_TYPE_ERROR                   (0x1003)

#define KDRIVE_AP_UNSUPPORTED_PROTOCOL_ERROR                    (0x1004)

#define KDRIVE_AP_UNSUPPORTED_LAYER_ERROR                               (0x1005)

#define KDRIVE_AP_PROTOCOL_WRITE_VALIDATION_ERROR               (0x1006)

#define KDRIVE_AP_LDM_MGMT_PROPERTY_ERROR                               (0x1007)

#define KDRIVE_AP_LDM_WRITE_ERROR                                               (0x1008)

#define KDRIVE_AP_NO_RESPONSE_LOCAL_DEVICE_ERROR                (0x1009)

#define KDRIVE_AP_L_DATA_CONFIRM_TIMEOUT_ERROR                  (0x100A)

#define KDRIVE_AP_KNX_NET_IP_ERROR                                              (0x100B)

#define KDRIVE_AP_HOST_PROTOCOL_TYPE_ERROR                              (0x100C)

#define KDRIVE_AP_VERSION_NOT_SUPPORTED_ERROR                   (0x100D)

#define KDRIVE_AP_SEQUENCE_NUMBER_ERROR                                 (0x100E)

#define KDRIVE_AP_CONNECTION_TYPE_ERROR                                 (0x100F)

#define KDRIVE_AP_CONNECTION_OPTION_ERROR                               (0x1010)

#define KDRIVE_AP_NO_MORE_CONNECTIONS_ERROR                             (0x1011)

#define KDRIVE_AP_TUNNELING_LAYER_ERROR                                 (0x1012)

#define KDRIVE_AP_CONNECTION_ID_ERROR                                   (0x1013)

#define KDRIVE_AP_DATA_CONNECTION_ERROR                                 (0x1014)

#define KDRIVE_AP_KNX_CONNECTION_ERROR                                  (0x1015)

#define KDRIVE_AP_INVALID_TELEGRAM_ERROR                                (0x1016)

#define KDRIVE_AP_TELEGRAM_TIMEOUT_ERROR                                (0x1017)

#define KDRIVE_AP_NO_PREFERRED_PROTOCOL_FOUND_ERROR             (0x1023)

#define KDRIVE_AP_NO_PREFERRED_LAYER_FOUND_ERROR                (0x1024)

#define KDRIVE_AP_PROTOCOL_NOT_SET_ERROR                                (0x1025)

#define KDRIVE_AP_INTERFACE_NOT_SET_ERROR                               (0x1026)

#define KDRIVE_AP_NO_MORE_UNIQUE_CONNECTIONS_ERROR              (0x1027)

#define KDRIVE_AP_AUTHORISATION_ERROR                                   (0x1028)

#define KDRIVE_AP_TUNNELLING_ADDRESS_ERROR                              (0x1029)

#define KDRIVE_AP_CONNECTION_IN_USE_ERROR                               (0x102A)

#define KDRIVE_AP_AUTHENTICATION_CODE_INVALID_ERROR             (0x102B)

#define KDRIVE_AP_AUTHENTICATION_FAILED_ERROR                   (0x102C)

#define KDRIVE_AP_RAW_CONFIRM_TIMEOUT_ERROR                             (0x10F0)

#define KDRIVE_SP_SERVICES_ERROR                                                (0x2000)

#define KDRIVE_SP_UNKNOWN_SERVICE_TYPE_ERROR                    (0x2001)

#define KDRIVE_SP_SERVICE_PORT_NOT_SET_ERROR                    (0x2002)

#define KDRIVE_SP_OPERATION_CANCELLED_ERROR                             (0x2003)

#define KDRIVE_SP_NEGATIVE_CONFIRM_ERROR                                (0x2004)

#define KDRIVE_SP_NO_RESPONSE_FROM_DEVICE_ERROR             (0x2004)    /*!* No response from device */

#define KDRIVE_SP_INVALID_INPUT_PARAMETER_ERROR                 (0x2005)

#define KDRIVE_SP_DEVICE_ERROR                                                  (0x2006)

#define KDRIVE_SP_OBJECT_TYPE_NOT_SUPPORTED_ERROR               (0x2007)

#define KDRIVE_SP_PROPERTY_ID_NOT_SUPPORTED_ERROR               (0x2008)

#define KDRIVE_SP_NO_DEVICE_IN_PROG_MODE_ERROR                  (0x2009)

#define KDRIVE_SP_MORE_DEVICES_IN_PROG_MODE_ERROR               (0x200A)

#define KDRIVE_SP_WRITE_IND_ADDR_FAILED_ERROR                   (0x200B)

#define KDRIVE_SP_WRITE_DOMAIN_ADDR_FAILED_ERROR                (0x200C)

#define KDRIVE_SP_ACCESS_PORT_NOT_SET_ERROR                             (0x200D)

#define KDRIVE_SP_NEGATIVE_RESPONSE_ERROR                               (0x200E)

#define KDRIVE_SP_IND_ADDR_ALREADY_USED_ERROR                   (0x2011)

#define KDRIVE_SP_MEMORY_ERROR                                                  (0x20A1)

#define KDRIVE_SP_COMMAND_INVALID_ERROR                                 (0x20A2)

#define KDRIVE_SP_COMMAND_IMPOSSIBLE_ERROR                              (0x20A3)

#define KDRIVE_SP_LENGTH_EXCEEDS_MAX_APDU_ERROR                 (0x20A4)

#define KDRIVE_SP_DATA_OVERFLOW_ERROR                                   (0x20A5)

#define KDRIVE_SP_DATA_MIN_ERROR                                                (0x20A6)

#define KDRIVE_SP_DATA_MAX_ERROR                                                (0x20A7)

#define KDRIVE_SP_DATA_VOID_ERROR                                               (0x20A8)

#define KDRIVE_SP_TEMPORARILY_NOT_AVAILABLE_ERROR               (0x20A9)

#define KDRIVE_SP_ACCESS_WRITE_ONLY_ERROR                               (0x20AA)

#define KDRIVE_SP_ACCESS_READ_ONLY_ERROR                                (0x20AB)

#define KDRIVE_SP_ACCESS_DENIED_ERROR                                   (0x20AC)

#define KDRIVE_SP_ADDRESS_VOID_ERROR                                    (0x20AD)

#define KDRIVE_SP_DATA_TYPE_CONFLICT_ERROR                              (0x20AE)

#define KDRIVE_KER_PROTOCOL_ERROR                                               (0x3000)        /*!* kdriveKernel error */

#define KDRIVE_KER_REPEATED_ERROR                                               (0x3001)        /*!* Telegram Repeated */

#define KDRIVE_KER_SEQUENCE_NUMBER_ERROR                                (0x3002)        /*!* Sequence Number Error */

#define KDRIVE_KER_IGNORED_ERROR                                                (0x3003)        /*!* Telegram Ignored */

#define KDRIVE_KER_DISCONNECTED_ERROR                                   (0x3004)        /*!* Connection Disconnected */

#define KDRIVE_KER_REJECTED_ERROR                                               (0x3005)        /*!* Telegram Rejected */

#define KDRIVE_KER_NO_LAYERS_DEFINED_ERROR                              (0x3006)        /*!* No layers defined */

#define KDRIVE_KER_NO_RESPONSE_FROM_DEVICE_ERROR                (0x3007)        /*!* No response from device */

#define KDRIVE_KER_PACKET_ERROR                                                 (0x3008)        /*!* Packet type not supported */

#define KDRIVE_KER_NO_MORE_CONNECTIONS_ERROR                    (0x3009)        /*!* No more connections allowed */

#define KDRIVE_KER_CONNECTION_FAILED_ERROR                              (0x300A)        /*!* Could not open transport layer connection */

#define KDRIVE_KER_CONFIRM_TIMEOUT_ERROR                                (0x300B)        /*!* No confirm from device (T-Ack missing) */


#define KDRIVE_OBJSER_OBJECTSERVER_ERROR                                (0x4000)

#define KDRIVE_OBJSER_OBJ_EXIST_ERROR                                   (0x4001)

#define KDRIVE_OBJSER_OBJ_NOT_FOUND_ERROR                               (0x4002)

#define KDRIVE_OBJSER_DATA_FORMAT_ERROR                                 (0x4003)

#define KDRIVE_OBJSER_INVALID_AP_ERROR                                  (0x4008)

#ifdef __cplusplus

extern "C" {

#endif


kdriveExpress_API bool_t kdrive_is_negative_response_error(error_t e);


kdriveExpress_API void kdrive_get_error_message(error_t e, char* str, uint32_t str_len);


typedef void (*kdrive_error_callback)(error_t e, void* user_data);


kdriveExpress_API void kdrive_register_error_callback(kdrive_error_callback c, void* user_data);


#ifdef __cplusplus

}

#endif


#endif /* __KDRIVE_EXPRESS_ERROR_H__ */

kdrive_express_config.h

kdriveExpress_API
#define kdriveExpress_API
Definition: kdrive_express_config.h:88

uint32_t
unsigned int uint32_t
32 bit unsigned char
Definition: kdrive_express_config.h:31

error_t
int32_t error_t
Definition: kdrive_express_config.h:46

bool_t
int32_t bool_t
Definition: kdrive_express_config.h:57

kdrive_register_error_callback
kdriveExpress_API void kdrive_register_error_callback(kdrive_error_callback c, void *user_data)
Registers the error callback function.

kdrive_error_callback
void(* kdrive_error_callback)(error_t e, void *user_data)
Error Callback function type (pointer to function definition)
Definition: kdrive_express_error.h:157

kdrive_get_error_message
kdriveExpress_API void kdrive_get_error_message(error_t e, char *str, uint32_t str_len)
Gets the error message.

kdrive_is_negative_response_error
kdriveExpress_API bool_t kdrive_is_negative_response_error(error_t e)
Returns whether the given kdrive error code is a negative response error like KDRIVE_SP_NEGATIVE_RESP...