Enums Reference
Every public enum in the kbox-stack KNX library with its exact enumerator names and values — address and data types, LED and flash results, stack errors, property ids, log levels, and the telegram enums.
These enums are part of the portable public API and match the KNX wire format. Values are given exactly as declared; where the C++ header assigns an explicit value, it is shown, otherwise the value is the zero-based ordinal.
Enumerator names use the C-style EnumName_Member convention (unscoped enums),
so you write e.g. KnxTelegramApciEnum_GroupValueWrite.
KnxAddressTypeEnum
Selects individual vs group addressing on a KnxAddress / telegram.
| Enumerator | Value |
|---|---|
KnxAddressTypeEnum_Individual | 0 |
KnxAddressTypeEnum_Group | 1 |
KnxDataTypeEnum
The storage class of a DeviceObject / KnxData value.
| Enumerator | Value |
|---|---|
KnxDataTypeEnum_Bit | 0 |
KnxDataTypeEnum_Byte | 1 |
KnxDataTypeEnum_Float | 2 |
KnxDataTypeEnum_ByteArray | 3 |
KnxDataTypeEnum_NA | 255 |
LedModesEnum
Drive mode for the KNX status LED (see ILed).
| Enumerator | Value |
|---|---|
LedModesEnum_Regular | 0 |
LedModesEnum_Blink | 1 |
LedModesEnum_SosBlink | 2 |
FlashOperationResultEnum
Result of an IFlash erase/write operation.
| Enumerator | Value |
|---|---|
FlashOperationResultEnum_EraseOK | 0 |
FlashOperationResultEnum_EraseError | 1 |
FlashOperationResultEnum_WriteOK | 2 |
FlashOperationResultEnum_WriteError | 3 |
FlashOperationResultEnum_ExceededMaxSize | 4 |
FlashOperationResultEnum_AddressOutOfRange | 5 |
StackErrorTypeEnum
Fatal sizing / persistence failures reported through the onStackError
callback. The correct reaction is a safe stop — see the
Integration Contract · Error contract.
| Enumerator | Value |
|---|---|
StackErrorTypeEnum_MACHINE_STATE_SIZE_ERROR | 0 |
StackErrorTypeEnum_SEGMET1_SIZE_ERROR | 1 |
StackErrorTypeEnum_SEGMET2_SIZE_ERROR | 2 |
StackErrorTypeEnum_SEGMET3_SIZE_ERROR | 3 |
StackErrorTypeEnum_SEGMET4_SIZE_ERROR | 4 |
StackErrorTypeEnum_SEGMENT_TOO_LARGE_FOR_FILL | 5 |
StackErrorTypeEnum_SEGMENT_FILL_WRITE_FAILED | 6 |
StackErrorTypeEnum_MACHINE_STATE_PERSIST_ERROR | 7 |
StackErrorTypeEnum_PROGRAM_VERSION_PERSIST_ERROR | 8 |
StackErrorTypeEnum_SECURE_STORAGE_INVALID | 9 |
StackErrorTypeEnum_FLASH_LAYOUT_INVALID | 10 |
The SEGMET1..4 enumerator names are spelled exactly as in the header. A size
error means a table size in StackParameters is smaller than the ETS project
needs.
SECURE_STORAGE_INVALID and FLASH_LAYOUT_INVALID are both fatal,
non-recoverable conditions: the consumer's onStackError handler should halt
or reset the device rather than start any new work. The stack narrows the
blast radius on its own side (Process() early-returns, and
SaveUserData/LoadUserData/UserDataCapacity() become no-ops), but this is
defense-in-depth only — it does not substitute for the consumer's own
halt/reset decision.
PropertyIdTypeEnum
Interface-object property ids (KNX PIDs) the stack recognises. Values are the standard KNX property ids.
| Enumerator | Value |
|---|---|
PropertyIdTypeEnum_PID_OBJECT_TYPE | 1 |
PropertyIdTypeEnum_PID_GROUP_OBJECT_REFERENCE | 4 |
PropertyIdTypeEnum_PID_LOAD_STATE_CONTROL | 5 |
PropertyIdTypeEnum_PID_RUN_STATE_CONTROL | 6 |
PropertyIdTypeEnum_PID_TABLE_REFERENCE | 7 |
PropertyIdTypeEnum_PID_SERIAL_NUMBER | 11 |
PropertyIdTypeEnum_PID_MANUFACTURER_ID | 12 |
PropertyIdTypeEnum_PID_PROGRAM_VERSION | 13 |
PropertyIdTypeEnum_PID_DEVICE_CONTROL | 14 |
PropertyIdTypeEnum_PID_ORDER_INFO | 15 |
PropertyIdTypeEnum_PID_PEI_TYPE | 16 |
PropertyIdTypeEnum_PID_TABLE | 23 |
PropertyIdTypeEnum_PID_VERSION | 25 |
PropertyIdTypeEnum_PID_MCB_TABLE | 27 |
PropertyIdTypeEnum_PID_ROUTING_COUNT | 51 |
PropertyIdTypeEnum_PID_PROGMODE | 54 |
PropertyIdTypeEnum_PID_MAX_APDULENGTH | 56 |
PropertyIdTypeEnum_PID_SUBNET_ADDR | 57 |
PropertyIdTypeEnum_PID_DEVICE_ADDR | 58 |
PropertyIdTypeEnum_PID_HARDWARE_TYPE | 78 |
LogLevelEnum
Severity for the logging subsystem. See Logging.
| Enumerator | Value |
|---|---|
LogLevelEnum_NA | 0 |
LogLevelEnum_Info | 1 |
LogLevelEnum_Warning | 2 |
LogLevelEnum_Error | 3 |
LogLevelEnum_Stack | 4 |
LogLevelEnum_Verbose | 5 |
Telegram enums
These enums describe the fields of a KNX telegram, used by KnxTelegram and
KnxTelegramBuilder. They are grouped here to keep the page scannable.