knx
ETS configurable knx-stack
knx_types.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  SecurityControl
 

Enumerations

enum  FrameFormat { ExtendedFrame = 0 , StandardFrame = 0x80 }
 
enum  Priority { LowPriority = 0xC , NormalPriority = 0x4 , UrgentPriority = 0x8 , SystemPriority = 0x0 }
 
enum  AckType { AckDontCare = 0 , AckRequested = 0x2 }
 
enum  AddressType { IndividualAddress = 0 , GroupAddress = 0x80 }
 
enum  MessageCode {
  L_data_req = 0x11 , L_data_con = 0x2E , L_data_ind = 0x29 , M_PropRead_req = 0xFC ,
  M_PropRead_con = 0xFB , M_PropWrite_req = 0xF6 , M_PropWrite_con = 0xF5 , M_PropInfo_ind = 0xF7 ,
  M_FuncPropCommand_req = 0xF8 , M_FuncPropCommand_con = 0xFA , M_FuncPropStateRead_req = 0xF9 , M_FuncPropStateRead_con = 0xFA ,
  M_Reset_req = 0xF1 , M_Reset_ind = 0xF0
}
 
enum  cEmiErrorCode {
  Unspecified_Error = 0x00 , Out_Of_Range = 0x01 , Out_Of_Max_Range = 0x02 , Out_Of_Min_Range = 0x03 ,
  Memory_Error = 0x04 , Read_Only = 0x05 , Illegal_Command = 0x06 , Void_DP = 0x07 ,
  Type_Conflict = 0x08 , Prop_Index_Range_Error = 0x09 , Value_temp_not_writeable = 0x0A
}
 
enum  ReturnCodes {
  Success = 0x00 , SuccessWithCrc = 0x01 , MemoryError = 0xF1 , InvalidCommand = 0xF2 ,
  ImpossibleCommand = 0xF3 , ExceedsMaxApduLength = 0xF4 , DataOverflow = 0xF5 , OutOfMinRange = 0xF6 ,
  OutOfMaxRange = 0xF7 , DataVoid = 0xF8 , TemporarilyNotAvailable = 0xF9 , AccessWriteOnly = 0xFA ,
  AccessReadOnly = 0xFB , AccessDenied = 0xFC , AddressVoid = 0xFD , DataTypeConflict = 0xFE ,
  GenericError = 0xFF
}
 
enum  Repetition { NoRepitiion = 0 , WasRepeated = 0 , RepetitionAllowed = 0x20 , WasNotRepeated = 0x20 }
 
enum  SystemBroadcast { SysBroadcast = 0 , Broadcast = 0x10 }
 
enum  Confirm { ConfirmNoError = 0 , ConfirmError = 1 }
 
enum  HopCountType { UnlimitedRouting , NetworkLayerParameter }
 
enum  TpduType {
  DataBroadcast , DataGroup , DataInduvidual , DataConnected ,
  Connect , Disconnect , Ack , Nack
}
 
enum  ApduType {
  GroupValueRead = 0x000 , GroupValueResponse = 0x040 , GroupValueWrite = 0x080 , IndividualAddressWrite = 0x0c0 ,
  IndividualAddressRead = 0x100 , IndividualAddressResponse = 0x140 , IndividualAddressSerialNumberRead = 0x3dc , IndividualAddressSerialNumberResponse = 0x3dd ,
  IndividualAddressSerialNumberWrite = 0x3de , SystemNetworkParameterRead = 0x1c8 , SystemNetworkParameterResponse = 0x1c9 , SystemNetworkParameterWrite = 0x1ca ,
  DomainAddressWrite = 0x3e0 , DomainAddressRead = 0x3e1 , DomainAddressResponse = 0x3e2 , DomainAddressSelectiveRead = 0x3e3 ,
  DomainAddressSerialNumberRead = 0x3ec , DomainAddressSerialNumberResponse = 0x3ed , DomainAddressSerialNumberWrite = 0x3ee , ADCRead = 0x0180 ,
  ADCResponse = 0x01C0 , PropertyValueExtRead = 0x1CC , PropertyValueExtResponse = 0x1CD , PropertyValueExtWriteCon = 0x1CE ,
  PropertyValueExtWriteConResponse = 0x1CF , PropertyValueExtWriteUnCon = 0x1D0 , PropertyExtDescriptionRead = 0x1D2 , PropertyExtDescriptionResponse = 0x1D3 ,
  FunctionPropertyExtCommand = 0x1D4 , FunctionPropertyExtState = 0x1D5 , FunctionPropertyExtStateResponse = 0x1D6 , MemoryExtWrite = 0x1FB ,
  MemoryExtWriteResponse = 0x1FC , MemoryExtRead = 0x1FD , MemoryExtReadResponse = 0x1FE , MemoryRead = 0x200 ,
  MemoryResponse = 0x240 , MemoryWrite = 0x280 , UserMemoryRead = 0x2C0 , UserMemoryResponse = 0x2C1 ,
  UserMemoryWrite = 0x2C2 , UserManufacturerInfoRead = 0x2C5 , UserManufacturerInfoResponse = 0x2C6 , FunctionPropertyCommand = 0x2C7 ,
  FunctionPropertyState = 0x2C8 , FunctionPropertyStateResponse = 0x2C9 , DeviceDescriptorRead = 0x300 , DeviceDescriptorResponse = 0x340 ,
  Restart = 0x380 , RestartMasterReset = 0x381 , AuthorizeRequest = 0x3d1 , AuthorizeResponse = 0x3d2 ,
  KeyWrite = 0x3d3 , KeyResponse = 0x3d4 , PropertyValueRead = 0x3d5 , PropertyValueResponse = 0x3d6 ,
  PropertyValueWrite = 0x3d7 , PropertyDescriptionRead = 0x3d8 , PropertyDescriptionResponse = 0x3d9 , SecureService = 0x3F1
}
 
enum  DataSecurity { None , Auth , AuthConf }
 
enum  RestartType { BasicRestart = 0x0 , MasterReset = 0x1 }
 
enum  EraseCode {
  Void = 0x00 , ConfirmedRestart = 0x01 , FactoryReset = 0x02 , ResetIA = 0x03 ,
  ResetAP = 0x04 , ResetParam = 0x05 , ResetLinks = 0x06 , FactoryResetWithoutIA = 0x07
}
 
enum  DptMedium { KNX_TP1 = 0x00 , KNX_PL110 = 0x01 , KNX_RF = 0x02 , KNX_IP = 0x05 }
 

Enumeration Type Documentation

◆ AckType

enum AckType
Enumerator
AckDontCare 

We don't care about DataLinkLayer acknowledgement.

AckRequested 

We want a DataLinkLayer acknowledgement.

Definition at line 17 of file knx_types.h.

◆ AddressType

Enumerator
IndividualAddress 
GroupAddress 

Definition at line 23 of file knx_types.h.

◆ ApduType

enum ApduType
Enumerator
GroupValueRead 
GroupValueResponse 
GroupValueWrite 
IndividualAddressWrite 
IndividualAddressRead 
IndividualAddressResponse 
IndividualAddressSerialNumberRead 
IndividualAddressSerialNumberResponse 
IndividualAddressSerialNumberWrite 
SystemNetworkParameterRead 
SystemNetworkParameterResponse 
SystemNetworkParameterWrite 
DomainAddressWrite 
DomainAddressRead 
DomainAddressResponse 
DomainAddressSelectiveRead 
DomainAddressSerialNumberRead 
DomainAddressSerialNumberResponse 
DomainAddressSerialNumberWrite 
ADCRead 
ADCResponse 
PropertyValueExtRead 
PropertyValueExtResponse 
PropertyValueExtWriteCon 
PropertyValueExtWriteConResponse 
PropertyValueExtWriteUnCon 
PropertyExtDescriptionRead 
PropertyExtDescriptionResponse 
FunctionPropertyExtCommand 
FunctionPropertyExtState 
FunctionPropertyExtStateResponse 
MemoryExtWrite 
MemoryExtWriteResponse 
MemoryExtRead 
MemoryExtReadResponse 
MemoryRead 
MemoryResponse 
MemoryWrite 
UserMemoryRead 
UserMemoryResponse 
UserMemoryWrite 
UserManufacturerInfoRead 
UserManufacturerInfoResponse 
FunctionPropertyCommand 
FunctionPropertyState 
FunctionPropertyStateResponse 
DeviceDescriptorRead 
DeviceDescriptorResponse 
Restart 
RestartMasterReset 
AuthorizeRequest 
AuthorizeResponse 
KeyWrite 
KeyResponse 
PropertyValueRead 
PropertyValueResponse 
PropertyValueWrite 
PropertyDescriptionRead 
PropertyDescriptionResponse 
SecureService 

Definition at line 132 of file knx_types.h.

◆ cEmiErrorCode

Enumerator
Unspecified_Error 
Out_Of_Range 
Out_Of_Max_Range 
Out_Of_Min_Range 
Memory_Error 
Read_Only 
Illegal_Command 
Void_DP 
Type_Conflict 
Prop_Index_Range_Error 
Value_temp_not_writeable 

Definition at line 54 of file knx_types.h.

◆ Confirm

enum Confirm
Enumerator
ConfirmNoError 
ConfirmError 

Definition at line 108 of file knx_types.h.

◆ DataSecurity

Enumerator
None 
Auth 
AuthConf 

Definition at line 207 of file knx_types.h.

◆ DptMedium

enum DptMedium
Enumerator
KNX_TP1 
KNX_PL110 
KNX_RF 
KNX_IP 

Definition at line 238 of file knx_types.h.

◆ EraseCode

enum EraseCode
Enumerator
Void 
ConfirmedRestart 
FactoryReset 
ResetIA 
ResetAP 
ResetParam 
ResetLinks 
FactoryResetWithoutIA 

Definition at line 226 of file knx_types.h.

◆ FrameFormat

Enumerator
ExtendedFrame 
StandardFrame 

Definition at line 3 of file knx_types.h.

◆ HopCountType

Enumerator
UnlimitedRouting 

NPDU::hopCount is set to 7. This means that the frame never expires. This could be a problem if your bus contains a circle.

NetworkLayerParameter 

use NetworkLayer::hopCount as NPDU::hopCount

Definition at line 114 of file knx_types.h.

◆ MessageCode

Enumerator
L_data_req 
L_data_con 
L_data_ind 
M_PropRead_req 
M_PropRead_con 
M_PropWrite_req 
M_PropWrite_con 
M_PropInfo_ind 
M_FuncPropCommand_req 
M_FuncPropCommand_con 
M_FuncPropStateRead_req 
M_FuncPropStateRead_con 
M_Reset_req 
M_Reset_ind 

Definition at line 29 of file knx_types.h.

◆ Priority

enum Priority
Enumerator
LowPriority 

Normal priority of group communication.

NormalPriority 

More important telegrams like central functions.

UrgentPriority 

Used for alarms.

SystemPriority 

Mainly used by ETS for device programming.

Definition at line 9 of file knx_types.h.

◆ Repetition

enum Repetition
Enumerator
NoRepitiion 
WasRepeated 
RepetitionAllowed 
WasNotRepeated 

Definition at line 94 of file knx_types.h.

◆ RestartType

Enumerator
BasicRestart 
MasterReset 

Definition at line 220 of file knx_types.h.

◆ ReturnCodes

Enumerator
Success 
SuccessWithCrc 
MemoryError 
InvalidCommand 
ImpossibleCommand 
ExceedsMaxApduLength 
DataOverflow 
OutOfMinRange 
OutOfMaxRange 
DataVoid 
TemporarilyNotAvailable 
AccessWriteOnly 
AccessReadOnly 
AccessDenied 
AddressVoid 
DataTypeConflict 
GenericError 

Definition at line 71 of file knx_types.h.

◆ SystemBroadcast

Enumerator
SysBroadcast 
Broadcast 

Definition at line 102 of file knx_types.h.

◆ TpduType

enum TpduType
Enumerator
DataBroadcast 
DataGroup 
DataInduvidual 
DataConnected 
Connect 
Disconnect 
Ack 
Nack 

Definition at line 120 of file knx_types.h.