QKnx Namespace
Contains miscellaneous identifiers used throughout the QtKnx library. More...
| Header: | #include <QKnx> |
| qmake: | QT += knx |
Namespaces
Types
| enum class | EmiType { Unknown, EMI1, EMI2, cEMI } |
| flags | EmiTypes |
| enum class | InterfaceFeature { Unknown, SupportedEmiType, HostDeviceDescriptorType0, BusConnectionStatus, KnxManufacturerCode, …, InterfaceFeatureInfoServiceEnable } |
| enum class | MediumStatus { Unknown, CommunicationPossible, CommunicationImpossible } |
| enum class | MediumType { Unknown, TP, PL, RF, NetIP } |
| enum class | ReturnCode { Success, SuccessWithCrc, MemoryError, CommandInvalid, CommandImpossible, …, Error } |
Functions
| bool | isInterfaceFeature(QKnx::InterfaceFeature feature) |
Type Documentation
enum class QKnx::EmiType
flags QKnx::EmiTypes
This enum describes the various external message interface (EMI) types supported by KNX bus.
| Constant | Value | Description |
|---|---|---|
QKnx::EmiType::Unknown | 0x00 | The supported EMI type is unknown. |
QKnx::EmiType::EMI1 | 0x01 | The supported EMI is type 1 used by bus coupler units (BCU) model type 1. |
QKnx::EmiType::EMI2 | 0x02 | The supported EMI is type 2 used by bus coupler units (BCU) model type 2. |
QKnx::EmiType::cEMI | 0x04 | The supported EMI type is known as common EMI and a generic structure for medium independent KNX messages. |
This enum was introduced or modified in Qt 5.12.
The EmiTypes type is a typedef for QFlags<EmiType>. It stores an OR combination of EmiType values.
enum class QKnx::InterfaceFeature
This enumeration contains the values to identify an interface feature service (also known as device feature).
| Constant | Value | Description |
|---|---|---|
QKnx::InterfaceFeature::Unknown | 0x00 | The used feature service is unknown. |
QKnx::InterfaceFeature::SupportedEmiType | 0x01 | Getting the supported EMI type(s). |
QKnx::InterfaceFeature::HostDeviceDescriptorType0 | 0x02 | Getting the local device descriptor type 0 for possible local device management. |
QKnx::InterfaceFeature::BusConnectionStatus | 0x03 | Getting and informing on the bus connection status. |
QKnx::InterfaceFeature::KnxManufacturerCode | 0x04 | Getting the manufacturer code of the bus access server. |
QKnx::InterfaceFeature::ActiveEmiType | 0x05 | Getting and setting the EMI type to use. |
QKnx::InterfaceFeature::IndividualAddress | 0x06 | Getting the individual address used by the bus interface. |
QKnx::InterfaceFeature::MaximumApduLength | 0x07 | Getting the maximal APDU-length that can be transported over a KNXnet/IP tunneling connection. |
QKnx::InterfaceFeature::InterfaceFeatureInfoServiceEnable | 0x08 | Controlling the use of the info feature service by the interface. |
This enum was introduced or modified in Qt 5.12.
enum class QKnx::MediumStatus
This enum type holds the medium status if the KNXnet/IP router or server supports extended device information.
| Constant | Value | Description |
|---|---|---|
QKnx::MediumStatus::Unknown | 0xff | The medium status is unknown. Most likely the discovered KNXnet/IP router or server does not support extended device information. |
QKnx::MediumStatus::CommunicationPossible | 0x00 | Communication to a KNX twisted pair 1 (TP1) network via the discovered KNXnet/IP router or server is possible. |
QKnx::MediumStatus::CommunicationImpossible | 0x01 | Communication to a KNX TP1 network via the discovered KNXnet/IP router or server is not possible. |
This enum was introduced or modified in Qt 5.12.
enum class QKnx::MediumType
This enum describes the various medium types supported by KNX bus.
| Constant | Value | Description |
|---|---|---|
QKnx::MediumType::Unknown | 0x00 | The supported medium type is unknown. |
QKnx::MediumType::TP | 0x01 | The supported medium type is twisted pair 1. |
QKnx::MediumType::PL | 0x04 | The supported medium type is power-line 110. |
QKnx::MediumType::RF | 0x10 | The supported medium type is radio frequency. |
QKnx::MediumType::NetIP | 0x20 | The supported medium type is KNXnet/IP. |
enum class QKnx::ReturnCode
This enumeration contains the generic return codes used in the KNX specification.
| Constant | Value | Description |
|---|---|---|
QKnx::ReturnCode::Success | 0x00 | The service, function, or command was executed successfully, without additional information. |
QKnx::ReturnCode::SuccessWithCrc | 0x01 | Positive confirmation of a message with CRC16-CCITT (beginning after the APCI octet, over received data including address and number of data octets). |
QKnx::ReturnCode::MemoryError | 0xf1 | Memory cannot be accessed at all or only with faults. |
QKnx::ReturnCode::CommandInvalid | 0xf2 | The command is not supported by this server. |
QKnx::ReturnCode::CommandImpossible | 0xf3 | The command is supported and well formatted, but it cannot be executed, because a dependency is not fulfilled. |
QKnx::ReturnCode::LengthExceedsMaxApduLength | 0xf4 | The requested data will not fit into a frame supported by this server. This return code indicates device limitations of the maximum supported frame length while accessing the resources of the device, such as properties, function properties, and memory. |
QKnx::ReturnCode::DataOverflow | 0xf5 | An attempt was made to write data beyond what is reserved for the addressed resource. |
QKnx::ReturnCode::DataMin | 0xf6 | The write value was too low. If the value is lower than the lowest supported value, then preferably this value shall be given instead of Value not supported. |
QKnx::ReturnCode::DataMax | 0xf7 | The write value was too high. If the value is higher than the highest supported value, then preferably this value shall be given instead of Value not supported. |
QKnx::ReturnCode::DataVoid | 0xf8 | The service or the function (property) is supported, but the requested data is not valid for this receiver. This value shall also be given if the requested data contains an enumeration value that is not supported, within the supported ranges. |
QKnx::ReturnCode::TemporarilyNotAvailable | 0xf9 | The data could be written, but it is not possible at the time, because another management client (MaC) is accessing the data or the data is currently processed by a management server (MaS) (for example, being flashed or being renewed). |
QKnx::ReturnCode::AccessWriteOnly | 0xfa | Read access was attempted to a write only service or resource. This means resources such as properties, function properties, or memory that can be written, but that cannot be read. |
QKnx::ReturnCode::AccessReadOnly | 0xfb | Write access was attempted to a read only service or resource. This means resources such as properties, function properties, or memory that can be read, but that cannot be written. |
QKnx::ReturnCode::AccessDenied | 0xfc | The access to the data or function was denied because of authorization reasons, authorize request, or KNX security. |
QKnx::ReturnCode::AddressVoid | 0xfd | The interface object or the property is not present, or the index is out of range. |
QKnx::ReturnCode::DataTypeConflict | 0xfe | Write access with a wrong data type (datapoint length). |
QKnx::ReturnCode::Error | 0xff | The service, function, or command has failed without additional information about the problem. |
This enum was introduced or modified in Qt 5.12.
Function Documentation
bool QKnx::isInterfaceFeature(QKnx::InterfaceFeature feature)
Returns true if the specified feature is a part of the InterfaceFeature enumeration; otherwise returns false.
This function was introduced in Qt 5.12.
© 2024 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.
