Qt KNX C++ Classes

List of C++ classes that enable access to a KNX network. More...

Namespaces

QKnx::NetIp::CemiServer

QKnx::NetIp::CemiServer namespace defines enumerations related to KNXnet/IP communication with a cEMI server

QKnx::NetIp

QKnx::NetIp namespace defines constants, methods, and enumerations related to KNXnet/IP communication

QKnx

Contains miscellaneous identifiers used throughout the QtKnx library

SrpBuilders

Contains various builders for creating the search request parameters (SRP) included in an extended search request

Classes

QKnxLinkLayerFrame::Builder

QKnxLinkLayerFrame::Builder class provides the means to create a KNX link layer frame

QKnxDeviceManagementFrame::FunctionPropertyCommandBuilder

QKnxDeviceManagementFrame::FunctionPropertyCommandBuilder class provides the means to create valid device management function property command service frames

QKnxDeviceManagementFrame::FunctionPropertyStateReadBuilder

QKnxDeviceManagementFrame::FunctionPropertyStateReadBuilder class provides the means to create valid device management function property state read service

QKnxAddress::Group

QKnxAddress::Group class represents a KNX group address to be used as broadcast address

QKnxAddress::Individual

QKnxAddress::Individual class represents a KNX individual address for an unregistered KNX device

SrpBuilders::MacAddress

SrpBuilders::MacAddress class provides the means to create the Select By MAC Address SRP for the extended search request

SrpBuilders::ProgrammingMode

SrpBuilders::ProgrammingMode class provides the means to create the Select By Programming Mode SRP for the extended search request

QKnxDeviceManagementFrame::PropertyInfoBuilder

QKnxDeviceManagementFrame::PropertyInfoBuilder class provides the means to create a valid device management property info indication frame

QKnxDeviceManagementFrame::PropertyReadBuilder

QKnxDeviceManagementFrame::PropertyReadBuilder class provides the means to create valid device management property read service frames

QKnxDeviceManagementFrame::PropertyWriteBuilder

QKnxDeviceManagementFrame::PropertyWriteBuilder class provides the means to create valid device management property write service frames

QAbstractKnxTime

Abstract base class for datapoint types that contain time information

QKnx1Bit

Boolean datapoint type, such as switch on or off

QKnx1BitControlled

Boolean datapoint type with a control part

QKnx1Byte

Fixed size datapoint type with the length of 1 byte

QKnx2BitSet

Fixed size datapoint type with the length of 2 bits

QKnx2ByteFloat

Datapoint type for a 2-byte float value

QKnx2ByteSignedValue

Datapoint type with a 2-byte signed value

QKnx2ByteUnsignedValue

Datapoint type with a 2-byte unsigned value

QKnx32BitSet

Datapoint type with the 32-bit set

QKnx3BitControlled

Datapoint type with a control part

QKnx4ByteFloat

Datapoint type for a 4-byte float value

QKnx4ByteSignedValue

Datapoint type with a 4-byte signed value

QKnx4ByteUnsignedValue

Datapoint type with a 4-byte unsigned value

QKnx8BitSet

Datapoint type with binary-coded values in all fields

QKnx8BitSignedValue

Datapoint type with an 8-bit signed value

QKnx8BitUnsignedValue

Datapoint type with an 8-bit unsigned value

QKnxActuatorConnectType

Datapoint type for storing the actuator connection type

QKnxAdditionalInfo

Represents the additional information that can be placed inside a KNX cEMI frame

QKnxAddress

Represents a 16-bit KNX address value

QKnxAlarmClassType

Datapoint type for storing the alarm class type

QKnxAlarmReaction

Fixed size datapoint type for storing the alarm reaction

QKnxApplicationArea

Datapoint type for storing the application area

QKnxBeaufortWindForceScale

Datapoint type for storing the Beaufort wind force scale

QKnxBuildingMode

Datapoint type for storing the building mode

QKnxByteArray

Array of unsigned bytes

QKnxChar

Datapoint type that encodes a character

QKnxChar88591

Datapoint type that encodes an ISO 8859-1 character

QKnxCharASCII

Datapoint type that encodes an ASCII character

QKnxCharString

Datapoint type that encodes a string

QKnxCharString88591

Datapoint type that encodes a string of ISO 8859-1 characters

QKnxCharStringASCII

Datapoint type that encodes a string of ASCII characters

QKnxCombinedInfoOnOff

Datapoint type for storing combined information about the on and off states of a multiple-channel binary actuator

QKnxControlBlinds

Datapoint type for controlling blinds

QKnxControlDimming

Datapoint type for controlling dimming

QKnxControlField

Represents an 8-bit KNX control field

QKnxDatapointType

Base class for datapoint types with specific properties

QKnxDatapointTypeFactory

Used to create QKnxDatapointType objects based on their main number and sub number

QKnxDate

Datapoint type for a date

QKnxDateTime

Datapoint type for the date and time

QKnxDeviceControl

Datapoint type for device control

QKnxDeviceManagementFrame

Represents a cEMI frame dedicated to KNXnet/IP device management

QKnxElectricalEnergy

Datapoint type for electrical energy

QKnxEntranceAccess

Datapoint type for controlling entrance access

QKnxErrorClassHvac

Datapoint type for storing errors in heating, ventilation, and air conditioning (HVAC)

QKnxErrorClassSystem

Datapoint type for storing system errors

QKnxExtendedControlField

Represents an 8-bit extended KNX control field

QKnxFixedSizeDatapointType

Base class for datapoint types with a fixed size

QKnxGeneralStatus

Datapoint type for general status

QKnxGroupAddressInfo

Contains information about a single KNX group address object used inside a KNX installation

QKnxGroupAddressInfos

Access to information about group addresses used inside a KNX project

QKnxInterfaceObjectProperty

Holds the properties of a KNX interface object

QKnxInterfaceObjectPropertyDataType

Holds information about the data type of the properties of a KNX interface object

QKnxInterfaceObjectType

Holds the type of a KNX interface object

QKnxLightApplicationMode

Datapoint type for storing the light application mode

QKnxLinkLayerFrame

Frame that is sent over a communication channel established between a KNXnet/IP client and a KNXnet/IP server

QKnxNetIpConfigDibProxy

The means to read the IP configuration from the generic QKnxNetIpDib class and to create a KNXnet/IP current IP configuration (DIB) structure based on the information

QKnxNetIpConnectRequestProxy

The means to read a connection request from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpConnectResponseProxy

The means to read a connection response from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpConnectionHeader

KNXnet/IP frame connection header

QKnxNetIpConnectionStateRequestProxy

The means to read a KNXnet/IP connection state request from the generic QKnxNetIpFrame class and to create a connection state request frame based on the information

QKnxNetIpConnectionStateResponseProxy

The means to read a KNXnet/IP connection state response from the generic QKnxNetIpFrame class and to create a connection state response frame based on the information

QKnxNetIpCrd

Stores the data block returned with a KNXnet/IP connection request frame

QKnxNetIpCrdProxy

The means to read the KNXnet/IP connection response data (CRD) from the generic QKnxNetIpCrd class and to create a KNXnet/IP CRD structure based on the information

QKnxNetIpCri

Stores the additional information needed by communication channels to fulfill a connection request

QKnxNetIpCriProxy

The means to read the connection request information (CRI) from the generic QKnxNetIpCri class and to create a KNXnet/IP CRI structure based on the information

QKnxNetIpCurrentConfigDibProxy

The means to read the current IP configuration from the generic QKnxNetIpDib class and to create a KNXnet/IP current IP configuration (DIB) structure based on the information

QKnxNetIpDescriptionRequestProxy

The means to read a description request from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpDescriptionResponseProxy

The means to read a description response from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpDeviceConfigurationAcknowledgeProxy

The means to read a device configuration acknowledgment from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpDeviceConfigurationRequestProxy

The means to read a device configuration request from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpDeviceDibProxy

The means to read the device information of a KNXnet/IP device from the generic QKnxNetIpDib class and to create a KNXnet/IP device information block (DIB) structure

QKnxNetIpDeviceManagement

Enables the opening and handling of a device management connection from a KNXnet/IP client to a KNXnet/IP server

QKnxNetIpDib

Stores a specific block of device information that is used when responding to a KNXnet/IP description request

QKnxNetIpDisconnectRequestProxy

The means to read a KNXnet/IP disconnection request from the generic QKnxNetIpFrame class and to create a disconnection request frame based on the information

QKnxNetIpDisconnectResponseProxy

The means to read a KNXnet/IP disconnection response from the generic QKnxNetIpFrame class and to create a disconnection response frame based on the information

QKnxNetIpEndpointConnection

Serves as base class for derived classes to enable the opening and handling of a client connection to a KNXnet/IP server

QKnxNetIpExtendedDeviceDibProxy

The means to read the extended device information of a KNXnet/IP device from the generic QKnxNetIpDib class and to create a KNXnet/IP extended device information block (DIB) structure

QKnxNetIpFrame

Represents the base for all KNXnet/IP related communication

QKnxNetIpFrameHeader

KNXnet/IP frame header

QKnxNetIpHpai

Stores the address information required to uniquely identify a communication channel on the host protocol

QKnxNetIpHpaiProxy

The means to read the KNXnet/IP host address protocol information (HPAI) from the generic QKnxNetIpHpai class and to create such a structure

QKnxNetIpKnxAddressesDibProxy

The means to read all assigned individual addresses of a KNXnet/IP device from the generic QKnxNetIpDib class and to create a KNXnet/IP addresses device information block (DIB) structure

QKnxNetIpManufacturerDibProxy

The means to read the manufacturer specific device information from the generic QKnxNetIpDib class and to create a KNXnet/IP manufacturer specific device information block (DIB) structure

QKnxNetIpRoutingBusyProxy

The means to read a router busy message from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpRoutingIndicationProxy

The means to read a routing indication from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpRoutingLostMessageProxy

The means to read a routing-lost message from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpRoutingSystemBroadcastProxy

The means to introspect a generic routing system broadcast QKnxNetIpFrame and to create a KNXnet/IP frame based on the information

QKnxNetIpSearchRequestProxy

The means to read a search request from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpSearchResponseProxy

The means to read a search response from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpSecureWrapperProxy

The means to introspect secure wrapper data inside the generic QKnxNetIpFrame class and to create a KNXnet/IP secure wrapper frame from provided data

QKnxNetIpSecuredServiceFamiliesDibProxy

The means to introspect the supported service families and required security version inside the generic QKnxNetIpDib class and to create a KNXnet/IP device information block (DIB) structure based on the information

QKnxNetIpServerDescriptionAgent

Establishes a point-to-point connection with a KNXnet/IP server and requests its description

QKnxNetIpServerDiscoveryAgent

Discovers KNXnet/IP servers by sending a search request in the network that the client is connected to

QKnxNetIpServerInfo

Stores information about a KNXnet/IP server

QKnxNetIpServiceFamiliesDibProxy

The means to read the supported service families and versions from the generic QKnxNetIpDib class and to create a KNXnet/IP device information block (DIB) structure based on the information

QKnxNetIpSessionAuthenticateProxy

The means to introspect session authentication data inside the generic QKnxNetIpFrame class and to create a KNXnet/IP session authentication frame from provided data

QKnxNetIpSessionRequestProxy

The means to introspect session request data inside the generic QKnxNetIpFrame class and to create a KNXnet/IP session request frame from provided data

QKnxNetIpSessionResponseProxy

The means to introspect session response data inside the generic QKnxNetIpFrame class and to create a KNXnet/IP session response frame from provided data

QKnxNetIpSessionStatusProxy

The means to introspect secure session status data inside the generic QKnxNetIpFrame class and to create a KNXnet/IP secure session status frame from provided data

QKnxNetIpStruct

Represents a generic data structure encapsulated in a KNXnet/IP frame

QKnxNetIpStructHeader

KNXnet/IP structure header

QKnxNetIpTimerNotifyProxy

The means to introspect timer notify data inside the generic QKnxNetIpFrame class and to create a KNXnet/IP timer notify frame from provided data

QKnxNetIpTunnel

Enables the opening and handling of a KNXnet/IP client connection to a KNXnet/IP server

QKnxNetIpTunnelingAcknowledgeProxy

The means to read a tunneling acknowledgment from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpTunnelingFeatureGetProxy

The means to access the information carried by a generic tunneling feature-get service QKnxNetIpFrame frame and to create a KNXnet/IP frame based on the information

QKnxNetIpTunnelingFeatureInfoProxy

The means to access the information carried by a generic tunneling feature-info service QKnxNetIpFrame frame and to create a KNXnet/IP frame based on the information

QKnxNetIpTunnelingFeatureResponseProxy

The means to access the information carried by a generic tunneling feature-response service QKnxNetIpFrame frame and to create a KNXnet/IP frame based on the information

QKnxNetIpTunnelingFeatureSetProxy

The means to access the information carried by a generic tunneling feature-set service QKnxNetIpFrame frame and to create a KNXnet/IP frame based on the information

QKnxNetIpTunnelingInfoDibProxy

The means to read the maximum ADPU length supported by a KNXnet/IP tunneling interface and tunneling slot information from the generic QKnxNetIpDib class and to create a KNXnet/IP tunneling information block (DIB) structure

QKnxNetIpTunnelingRequestProxy

The means to read a tunneling request from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information

QKnxNetIpTunnelingSlotInfo

Contains information about the individual address that is currently assigned to the tunneling slot as well as the current state of the tunneling slot

QKnxOccupyMode

Datapoint type for storing the occupy mode

QKnxOnOffAction

Fixed size datapoint type for storing the on/off action

QKnxPriority

Datapoint type for storing priority

QKnxPsuMode

Datapoint type for storing the bus power supply unit mode

QKnxSceneControl

Datapoint type for a scene control

QKnxSceneInfo

Datapoint type for scene information

QKnxSceneNumber

Datapoint type for a scene number

QKnxScloMode

Datapoint type for storing the system clock (SCLO) mode

QKnxSecuredServiceInfo

Contains the supported service family and the corresponding required security version

QKnxSensorSelect

Datapoint type for storing the sensor mode

QKnxServiceInfo

Contains the supported service and the corresponding service family version

QKnxStatusMode3

Datapoint type for a status mode 3

QKnxTime

Holds time information

QKnxTime24

Holds time information

QKnxTimeBase

Base class for datapoint types that contain time information

QKnxTimeDelay

Datapoint type for storing a time delay

QKnxTimeOfDay

Datapoint type for the time of day

QKnxTpdu

Represents a TPDU, which is the part of a link layer frame to be read by the network, transport, and application layers

QKnxUpDownAction

QKnxOnOffAction class is a fixed size datapoint type for storing the up/down action

QKnxUtf8

Datapoint type for a UTF-8 string

QKnxUtf8String

Datapoint type for a UTF-8 string

QKnxValue4UCount

Datapoint type with a 4-byte unsigned value

QKnxVarString

Datapoint type that encodes a variable length string

QKnxVarString88591

Datapoint type that encodes a variable length string of ISO 8859-1 characters

QKnxVariableSizeDatapointType

Base class for datapoint types with a variable size

SrpBuilders::RequestDibs

SrpBuilders::RequestDibs class provides the means to create the Request DIBs SRP for the extended search request

QKnxDeviceManagementFrame::ResetBuilder

QKnxDeviceManagementFrame::ResetBuilder class provides the means to build valid device management reset service frames

SrpBuilders::SupportedFamily

SrpBuilders::SupportedFamily class provides the means to create a Select By Service SRP for an extended search request

Detailed Description

Note: The Qt KNX module is currently available as a Technology Preview and therefore the API and functionality provided by the module may be subject to change at any time without prior notice.

To use these classes in your application, use the following include statement:

#include <QtKnx/QtKnx>

To link against the module, add this line to your qmake .pro file:

QT += knx

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.