kdriveExpress SDK 22.1.1
kdrive_express_defs.h File Reference

kdriveExpress Defines More...

Go to the source code of this file.

Macros

#define KDRIVE_MAX_GROUP_VALUE_LEN   (14)
 The Maximum Length of a Datapoint Value in a GroupValue Telegram. More...
 
#define KDRIVE_SN_LEN   (6)
 The Length of a KNX Serial Number. More...
 
#define KDRIVE_DA_LEN   (6)
 The Length of a KNX Domain Address. More...
 
#define KDRIVE_MAC_LEN   (6)
 The Length of a MAC Address. More...
 
#define KDRIVE_SEC_KEY_LEN   (16)
 The Length of a security backbone key. More...
 
#define KDRIVE_MAX_SEC_PASSWORD_LEN   (20 + 1)
 The Maximum Length of a Security Password with Null-termination. More...
 
#define KDRIVE_INVALID_DESCRIPTOR   (-1)
 Indicates an invalid descriptor. More...
 
#define KDRIVE_DPT16_LENGTH   (14)
 The length of a KNX character string for DPT-16 is 112 bits or 14 bytes. More...
 
#define KDRIVE_MAX_IP_ADDRESS_LEN   (16)
 The max length of a formated ip address string e.g. More...
 
#define KDRIVE_MAX_DEVICE_NAME_LEN   (121)
 The max length of a device friendly name (30 char); (inclusive 1 byte for zero + max utf8 char) More...
 
#define KDRIVE_CEMI_L_DATA_REQ   (0x11)
 cEMI message code for L_Data.req More...
 
#define KDRIVE_CEMI_L_DATA_CON   (0x2E)
 cEMI message code for L_Data.con More...
 
#define KDRIVE_CEMI_L_DATA_IND   (0x29)
 cEMI message code for L_Data.ind More...
 
#define KDRIVE_LAYER_UNKNOWN   (0x0000)
 Unknown. More...
 
#define KDRIVE_LAYER_NONE   (0x8000)
 "No layer" More...
 
#define KDRIVE_LAYER_LINK   (0x0001)
 Link Layer. More...
 
#define KDRIVE_LAYER_BUSMON   (0x0002)
 Busmonitor. More...
 
#define KDRIVE_LAYER_RAW   (0x0004)
 Raw. More...
 
#define KDRIVE_LAYER_TLL   (0x0020)
 cEMI Transport Layer Local More...
 
#define KDRIVE_MEDIUM_TP   (0x02)
 Medium TP 1. More...
 
#define KDRIVE_MEDIUM_PL   (0x04)
 Medium PL 110. More...
 
#define KDRIVE_MEDIUM_RF   (0x10)
 Medium RF. More...
 
#define KDRIVE_MEDIUM_IP   (0x20)
 Medium IP. More...
 
#define KDRIVE_KNX_BUS_STATE_UNKNOWN   (0)
 KNX bus state: Unknown. More...
 
#define KDRIVE_KNX_BUS_STATE_DISCONNECTED   (1)
 KNX bus state: Disconnected. More...
 
#define KDRIVE_KNX_BUS_STATE_CONNECTED   (2)
 KNX bus state: Connected. More...
 
#define KDRIVE_PACKET_DIR_RX   (0)
 Packet Direction: Rx. More...
 
#define KDRIVE_PACKET_DIR_TX   (1)
 Packet Direction: Tx. More...
 
#define KDRIVE_TUNNEL_SLOT_STATUS_FREE   (0x01)
 Tunneling slot status Free: 0 = not free; 1 = free. More...
 
#define KDRIVE_TUNNEL_SLOT_STATUS_AUTH   (0x02)
 Tunneling slot status Authorised: 0 = authorisation is required; 1 = no authorisation is required. More...
 
#define KDRIVE_TUNNEL_SLOT_STATUS_USABLE   (0x04)
 Tunneling slot status Usable: 0 = This slot is not usable; 1 = This slot is usable. More...
 
#define KDRIVE_BITS(length)   ((length) * 8)
 converts the length of a byte buffer into length in bits More...
 

Detailed Description

kdriveExpress Defines

Author
Copyright (c) 2002-2022 WEINZIERL ENGINEERING GmbH

Macro Definition Documentation

◆ KDRIVE_BITS

#define KDRIVE_BITS (   length)    ((length) * 8)

converts the length of a byte buffer into length in bits

◆ KDRIVE_CEMI_L_DATA_CON

#define KDRIVE_CEMI_L_DATA_CON   (0x2E)

cEMI message code for L_Data.con

◆ KDRIVE_CEMI_L_DATA_IND

#define KDRIVE_CEMI_L_DATA_IND   (0x29)

cEMI message code for L_Data.ind

Examples
kdrive_express_ip_tunneling.c, and kdrive_express_usb.c.

◆ KDRIVE_CEMI_L_DATA_REQ

#define KDRIVE_CEMI_L_DATA_REQ   (0x11)

cEMI message code for L_Data.req

◆ KDRIVE_DA_LEN

#define KDRIVE_DA_LEN   (6)

The Length of a KNX Domain Address.

Examples
kdrive_express_services.c.

◆ KDRIVE_DPT16_LENGTH

#define KDRIVE_DPT16_LENGTH   (14)

The length of a KNX character string for DPT-16 is 112 bits or 14 bytes.

Examples
kdrive_express_dpt.c.

◆ KDRIVE_INVALID_DESCRIPTOR

◆ KDRIVE_KNX_BUS_STATE_CONNECTED

#define KDRIVE_KNX_BUS_STATE_CONNECTED   (2)

KNX bus state: Connected.

◆ KDRIVE_KNX_BUS_STATE_DISCONNECTED

#define KDRIVE_KNX_BUS_STATE_DISCONNECTED   (1)

KNX bus state: Disconnected.

◆ KDRIVE_KNX_BUS_STATE_UNKNOWN

#define KDRIVE_KNX_BUS_STATE_UNKNOWN   (0)

KNX bus state: Unknown.

◆ KDRIVE_LAYER_BUSMON

#define KDRIVE_LAYER_BUSMON   (0x0002)

Busmonitor.

◆ KDRIVE_LAYER_LINK

#define KDRIVE_LAYER_LINK   (0x0001)

Link Layer.

◆ KDRIVE_LAYER_NONE

#define KDRIVE_LAYER_NONE   (0x8000)

"No layer"

◆ KDRIVE_LAYER_RAW

#define KDRIVE_LAYER_RAW   (0x0004)

Raw.

◆ KDRIVE_LAYER_TLL

#define KDRIVE_LAYER_TLL   (0x0020)

cEMI Transport Layer Local

◆ KDRIVE_LAYER_UNKNOWN

#define KDRIVE_LAYER_UNKNOWN   (0x0000)

Unknown.

◆ KDRIVE_MAC_LEN

#define KDRIVE_MAC_LEN   (6)

The Length of a MAC Address.

◆ KDRIVE_MAX_DEVICE_NAME_LEN

#define KDRIVE_MAX_DEVICE_NAME_LEN   (121)

The max length of a device friendly name (30 char); (inclusive 1 byte for zero + max utf8 char)

◆ KDRIVE_MAX_GROUP_VALUE_LEN

#define KDRIVE_MAX_GROUP_VALUE_LEN   (14)

The Maximum Length of a Datapoint Value in a GroupValue Telegram.

Examples
kdrive_express_dpt.c, kdrive_express_ip_tunneling.c, and kdrive_express_usb.c.

◆ KDRIVE_MAX_IP_ADDRESS_LEN

#define KDRIVE_MAX_IP_ADDRESS_LEN   (16)

The max length of a formated ip address string e.g.

192.168.234.123; (inclusive 1 byte for zero)

◆ KDRIVE_MAX_SEC_PASSWORD_LEN

#define KDRIVE_MAX_SEC_PASSWORD_LEN   (20 + 1)

The Maximum Length of a Security Password with Null-termination.

◆ KDRIVE_MEDIUM_IP

#define KDRIVE_MEDIUM_IP   (0x20)

Medium IP.

◆ KDRIVE_MEDIUM_PL

#define KDRIVE_MEDIUM_PL   (0x04)

Medium PL 110.

◆ KDRIVE_MEDIUM_RF

#define KDRIVE_MEDIUM_RF   (0x10)

Medium RF.

◆ KDRIVE_MEDIUM_TP

#define KDRIVE_MEDIUM_TP   (0x02)

Medium TP 1.

◆ KDRIVE_PACKET_DIR_RX

#define KDRIVE_PACKET_DIR_RX   (0)

Packet Direction: Rx.

◆ KDRIVE_PACKET_DIR_TX

#define KDRIVE_PACKET_DIR_TX   (1)

Packet Direction: Tx.

◆ KDRIVE_SEC_KEY_LEN

#define KDRIVE_SEC_KEY_LEN   (16)

The Length of a security backbone key.

◆ KDRIVE_SN_LEN

#define KDRIVE_SN_LEN   (6)

The Length of a KNX Serial Number.

Examples
kdrive_express_dpt.c, kdrive_express_services.c, and kdrive_express_usb.c.

◆ KDRIVE_TUNNEL_SLOT_STATUS_AUTH

#define KDRIVE_TUNNEL_SLOT_STATUS_AUTH   (0x02)

Tunneling slot status Authorised: 0 = authorisation is required; 1 = no authorisation is required.

Examples
kdrive_express_ip_tunneling_enumerate.c.

◆ KDRIVE_TUNNEL_SLOT_STATUS_FREE

#define KDRIVE_TUNNEL_SLOT_STATUS_FREE   (0x01)

Tunneling slot status Free: 0 = not free; 1 = free.

Examples
kdrive_express_ip_tunneling_enumerate.c.

◆ KDRIVE_TUNNEL_SLOT_STATUS_USABLE

#define KDRIVE_TUNNEL_SLOT_STATUS_USABLE   (0x04)

Tunneling slot status Usable: 0 = This slot is not usable; 1 = This slot is usable.

Examples
kdrive_express_ip_tunneling_enumerate.c.