kdrive_express_dpt.h

Go to the documentation of this file.

//
// Copyright (c) 2002-2023 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_DPT_H__
#define __KDRIVE_EXPRESS_DPT_H__
 
#include "kdrive_express_config.h"
#include "kdrive_express_defs.h"
 
#define KDRIVE_MAX_DP_TYPE_ID_LEN               (13) 
#define KDRIVE_MAX_DP_TYPE_NAME_LEN             (30) 
#define KDRIVE_DPT1_SIZE_IN_BITS                (1)  
#define KDRIVE_DPT2_SIZE_IN_BITS                (2)  
#define KDRIVE_DPT3_SIZE_IN_BITS                (4)  
#define KDRIVE_DPT4_SIZE_IN_BITS                (8)  
#define KDRIVE_DPT5_SIZE_IN_BITS                (8)  
#define KDRIVE_DPT6_SIZE_IN_BITS                (8)  
#define KDRIVE_DPT7_SIZE_IN_BITS                (16) 
#define KDRIVE_DPT8_SIZE_IN_BITS                (16) 
#define KDRIVE_DPT9_SIZE_IN_BITS                (16) 
#define KDRIVE_DPT10_SIZE_IN_BITS               (24) 
#define KDRIVE_DPT11_SIZE_IN_BITS               (24) 
#define KDRIVE_DPT12_SIZE_IN_BITS               (32) 
#define KDRIVE_DPT13_SIZE_IN_BITS               (32) 
#define KDRIVE_DPT14_SIZE_IN_BITS               (32) 
#define KDRIVE_DPT15_SIZE_IN_BITS               (32) 
#define KDRIVE_DPT16_SIZE_IN_BITS               (112) 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************
** Datapoint
***************************************************************/
 
typedef struct datapoint_type_t
{
        char id[KDRIVE_MAX_DP_TYPE_ID_LEN]; 
        char name[KDRIVE_MAX_DP_TYPE_NAME_LEN]; 
        int32_t size_in_bit; 
} datapoint_type_t;
 
kdriveExpress_API error_t kdrive_dpt_get_dpt_descriptor(char* dpt_id, datapoint_type_t* dpt_desc);
 
/**************************************************************
** Encode and Decode
***************************************************************/
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt1(uint8_t* data,
        uint32_t* length, bool_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt1(const uint8_t* data,
        uint32_t length, bool_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt2(uint8_t* data,
        uint32_t* length, bool_t control, bool_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt2(const uint8_t* data,
        uint32_t length, bool_t* control, bool_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt3(uint8_t* data,
        uint32_t* length, bool_t control, uint8_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt3(const uint8_t* data,
        uint32_t length, bool_t* control, uint8_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt4(uint8_t* data,
        uint32_t* length, uint8_t character);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt4(const uint8_t* data,
        uint32_t length, uint8_t* character);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt5(uint8_t* data,
        uint32_t* length, uint8_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt5(const uint8_t* data,
        uint32_t length, uint8_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt6(uint8_t* data,
        uint32_t* length, int8_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt6(const uint8_t* data,
        uint32_t length, int8_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt7(uint8_t* data,
        uint32_t* length, uint16_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt7(const uint8_t* data,
        uint32_t length, uint16_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt8(uint8_t* data,
        uint32_t* length, int16_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt8(const uint8_t* data,
        uint32_t length, int16_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt9(uint8_t* data,
        uint32_t* length, float32_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt9(const uint8_t* data,
        uint32_t length, float32_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt10_local(uint8_t* data, uint32_t* length);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt10_utc(uint8_t* data, uint32_t* length);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt10(uint8_t* data, uint32_t* length,
        int32_t day, int32_t hour, int32_t minute, int32_t second);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt10(const uint8_t* data, uint32_t length,
        int32_t* day, int32_t* hour, int32_t* minute, int32_t* second);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt11_local(uint8_t* data, uint32_t* length);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt11_utc(uint8_t* data, uint32_t* length);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt11(uint8_t* data, uint32_t* length,
        int32_t year, int32_t month, int32_t day);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt11_knx(uint8_t* data, uint32_t* length,
        int32_t year, int32_t month, int32_t day);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt11_yyyy(uint8_t* data, uint32_t* length,
        int32_t year, int32_t month, int32_t day);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt11(const uint8_t* data, uint32_t length,
        int32_t* year, int32_t* month, int32_t* day);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt11_knx(const uint8_t* data, uint32_t length,
        int32_t* year, int32_t* month, int32_t* day);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt11_yyyy(const uint8_t* data, uint32_t length,
        int32_t* year, int32_t* month, int32_t* day);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt12(uint8_t* data,
        uint32_t* length, uint32_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt12(const uint8_t* data,
        uint32_t length, uint32_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt13(uint8_t* data,
        uint32_t* length, int32_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt13(const uint8_t* data,
        uint32_t length, int32_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt14(uint8_t* data,
        uint32_t* length, float32_t value);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt14(const uint8_t* data,
        uint32_t length, float32_t* value);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt15(uint8_t* data, uint32_t* length,
        int32_t accessCode, bool_t error, bool_t permission,
        bool_t direction, bool_t encrypted, int32_t index);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt15(const uint8_t* data, uint32_t length,
        int32_t* accessCode, bool_t* error, bool_t* permission,
        bool_t* direction, bool_t* encrypted, int32_t* index);
 
kdriveExpress_API error_t kdrive_dpt_encode_dpt16(uint8_t* data,
        uint32_t* length, const char value[KDRIVE_DPT16_LENGTH + 1]);
 
kdriveExpress_API error_t kdrive_dpt_decode_dpt16(const uint8_t* data,
        uint32_t length, char value[KDRIVE_DPT16_LENGTH + 1]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __KDRIVE_EXPRESS_DPT_H__ */