The deCONZ namespace. More...

Namespaces
namespace	literals
	Literal to create ZclDataTypeId_t.

Classes
class	Address
	Convenience class to work with network, extended and group addresses. More...

class	ApsController
	Provides APSDE-DATA service and access to node cache. More...

class	ApsDataConfirm
	APSDE-DATA.confirm primitive. More...

class	ApsDataIndication
	APSDE-DATA.indication primitive. More...

class	ApsDataIndicationPrivate

class	ApsDataRequest
	APSDE-DATA.request primitive. More...

class	ApsDataRequestPrivate

class	ApsMemory

class	ApsMemoryPrivate

class	Binding

class	BindingTable

struct	BindReq

struct	DeviceEntry
	Descriptor of a device. More...

class	DeviceEnumerator
	Lists all devices which are available for serial communication. More...

class	DeviceEnumeratorPrivate

class	Enumeration

union	GPCommissioningOptions

class	GpDataIndication
	GPDE-DATA.indication primitive. More...

class	GpDataIndicationPrivate

union	GpExtCommissioningOptions

class	GreenPowerController
	Provides services to access green power functionality. More...

class	GreenPowerControllerPrivate

class	HttpClientHandler

class	ManufacturerCode_t
	A strong typed Zigbee manufacturer code. More...

class	Node
	Represents a ZigBee node with all its descriptors and clusters. More...

class	NodeDescriptor
	Represents a ZigBee node descriptor. More...

class	NodeDescriptorPrivate

class	NodeEventPrivate

class	NodeInterface
	Main interface to create a deCONZ plugin. More...

class	NodeNeighbor

class	NodePrivate

union	NumericUnion
	Holds various numeric values 8-64 bit, signed and unsigned. More...

class	PowerDescriptor
	Represents a ZigBee power descriptor. More...

class	PowerDescriptorPrivate

class	SimpleDescriptor
	Represents a ZigBee simple descriptor. More...

class	SimpleDescriptorPrivate

class	SourceRoute

struct	SteadyTimeRef

struct	SystemTimeRef

struct	TimeMs
	Strong typed milliseconds. More...

struct	TimeSeconds
	Strong typed seconds. More...

class	TouchlinkController
	Provides services to access interpan and touchlink functionality. More...

class	TouchlinkControllerPrivate

class	TouchlinkRequest
	Base class for all touchlink requests. More...

class	TouchlinkRequestPrivate

class	ZclAttribute
	Represents a ZigBee cluster attribute. More...

class	ZclAttributeId_t
	A strong typed ZCL attribute identifier. More...

class	ZclAttributePrivate

class	ZclAttributeSet
	Represents a named group of ZclAttribute. More...

class	ZclAttributeSetPrivate

class	ZclCluster
	Represents a ZigBee cluster (ZCL and non-ZCL). More...

class	ZclClusterId_t
	A strong typed ZCL cluster identifier. More...

class	ZclClusterPrivate

class	ZclCommand
	Represents a ZigBee cluster command (ZCL and non-ZCL). More...

class	ZclCommandId_t
	A strong typed ZCL command identifier. More...

class	ZclCommandPrivate

class	ZclDataBase

class	ZclDataType
	Represents the data type of a ZigBee cluster attribute. More...

class	ZclDataTypeId_t
	A strong typed ZCL data type identifier. More...

class	ZclDataTypePrivate

class	ZclDevice

class	ZclDomain

class	ZclFrame
	Helper to build ZCL based payloads to be transported via ApsDataRequest. More...

class	ZclFramePrivate

class	ZclMemory

class	ZclMemoryPrivate

class	ZclProfile

Enumerations
enum	ApsAddressMode : unsigned char { ApsNoAddress = 0x0 , ApsGroupAddress = 0x1 , ApsNwkAddress = 0x2 , ApsExtAddress = 0x3 , ApsNwkExtAddress = 0x4 }
	Address modes used to specify source and destination addresses. More...

enum	ApsTxOption : unsigned char { ApsTxSecurityEnabledTransmission = 0x01 , ApsTxUseNwk = 0x02 , ApsTxAcknowledgedTransmission = 0x04 , ApsTxFragmentationPermitted = 0x08 }
	Flags used in the ApsDataRequest. More...

enum	FirmwareUpdateState { FirmwareUpdateIdle , FirmwareUpdateReadyToStart , FirmwareUpdateRunning }
	Values for ParamFirmwareUpdateActive.

enum	U8Parameter { ParamCurrentChannel , ParamDeviceType , ParamSecurityMode , ParamPermitJoin , ParamOtauActive , ParamAutoPollingActive , ParamNetworkUpdateId , ParamFirmwareUpdateActive , ParamDeviceConnected , ParamApsAck , ParamPredefinedPanId , ParamCustomMacAddress , ParamStaticNwkAddress }
	Parameters of type uint8_t. More...

enum	U16Parameter { ParamPANID , ParamNwkAddress , ParamHttpPort }
	Parameters of type uint16_t. More...

enum	U32Parameter { ParamChannelMask , ParamFirmwareVersion , ParamFrameCounter }
	Parameters of type uint32_t. More...

enum	U64Parameter { ParamApsUseExtendedPANID , ParamExtendedPANID , ParamMacAddress , ParamTrustCenterAddress }
	Parameters of type uint64_t. More...

enum	StringParameter { ParamDeviceName , ParamDevicePath , ParamHttpRoot }
	Parameters of type QString. More...

enum	ArrayParameter { ParamNetworkKey , ParamTrustCenterLinkKey , ParamSecurityMaterial0 }
	Parameters of type QByteArray. More...

enum	VariantMapParameter { ParamHAEndpoint , ParamLinkKey }
	Parameters of type QVariantMap.

enum	GpDeviceIds { GpDeviceIdOnOffSwitch = 0x02 }

enum	GpCommandIds { GpCommandIdIdentify = 0x00 , GpCommandIdScene0 = 0x10 , GpCommandIdScene1 = 0x11 , GpCommandIdScene2 = 0x12 , GpCommandIdScene3 = 0x13 , GpCommandIdScene4 = 0x14 , GpCommandIdScene5 = 0x15 , GpCommandIdScene6 = 0x16 , GpCommandIdScene7 = 0x17 , GpCommandIdScene8 = 0x18 , GpCommandIdScene9 = 0x19 , GpCommandIdScene10 = 0x1a , GpCommandIdScene11 = 0x1b , GpCommandIdScene12 = 0x1c , GpCommandIdScene13 = 0x1d , GpCommandIdScene14 = 0x1e , GpCommandIdScene15 = 0x1f , GpCommandIdOff = 0x20 , GpCommandIdOn = 0x21 , GpCommandIdToggle = 0x22 , GpCommandIdRelease = 0x23 , GpCommandIdMoveUp = 0x30 , GpCommandIdMoveDown = 0x31 , GpCommandIdStepUp = 0x32 , GpCommandIdStepDown = 0x33 , GpCommandIdLevelControlStop = 0x34 , GpCommandIdMoveUpWithOnOff = 0x35 , GpCommandIdMoveDownWithOnOff = 0x36 , GpCommandIdStepUpWithOnOff = 0x37 , GpCommandIdStepDownWithOnOff = 0x38 , GpCommandIdMoveHueUp = 0x41 , GpCommandIdMoveHueDown = 0x42 , GpCommandIdStepHueUp = 0x43 , GpCommandIdStepHueDown = 0x44 , GpCommandIdMoveSaturationUp = 0x46 , GpCommandIdMoveSaturationDown = 0x47 , GpCommandIdStepSaturationUp = 0x48 , GpCommandIdStepSaturationDown = 0x49 , GpCommandIdMoveColor = 0x4a , GpCommandIdStepColor = 0x4b , GpCommandIdPress1Of1 = 0x60 , GpCommandIdRelease1Of1 = 0x61 , GpCommandIdPress1Of2 = 0x62 , GpCommandIdRelease1Of2 = 0x63 , GpCommandIdPress2Of2 = 0x64 , GpCommandIdRelease2Of2 = 0x65 , GpCommandIdShortPress1Of1 = 0x66 , GpCommandIdShortPress1Of2 = 0x67 , GpCommandIdShortPress2Of2 = 0x68 , GpCommandIdAttributeReporting = 0xa0 , GpCommandIdManufacturerAttributeReporting = 0xa1 , GpCommandIdMultiClusterReporting = 0xa2 , GpCommandIdManufacturerMultiClusterReporting = 0xa3 , GpCommandIdRequestAttributes = 0xa4 , GpCommandIdReadAttributesResponse = 0xa5 , GpCommandIdAnyGPGSensorCommand = 0xaf , GpCommandIdCommissioning = 0xe0 , GpCommandIdDecommissioning = 0xe1 , GpCommandIdSuccess = 0xe2 , GpCommandIdChannelRequest = 0xe3 , GpCommandIdCommissioningReply = 0xf0 , GpCommandIdWriteAttributes = 0xf1 , GpCommandIdReadAttributes = 0xf2 , GpCommandIdChannelConfiguration = 0xf3 }

enum	GppCommandIds { GppCommandIdNotification = 0x00 , GppCommandIdCommissioningNotification = 0x04 }

enum	GppGpdLqi { GppGpdLqiPoor = 0x00 , GppGpdLqiModerate = 0x01 , GppGpdLqiHigh = 0x02 , GppGpdLqiExcellent = 0x03 }

enum	TouchlinkStatus { TouchlinkSuccess = 0x00 , TouchlinkFailed = 0x01 , TouchlinkBusy = 0x02 }
	Status codes used by the touchlink module. More...

enum	LibraryReturnCodes { Success = 0 , ErrorNotConnected , ErrorQueueIsFull , ErrorNodeIsZombie , ErrorNotFound }
	Return codes of the deCONZ library. More...

enum	NwkBroadcastAddress { BroadcastAll = 0xFFFF , BroadcastLowPowerRouters = 0xFFFB , BroadcastRouters = 0xFFFC , BroadcastRxOnWhenIdle = 0xFFFD }
	Special network layer broadcast addresses. More...

enum	SecurityMode { SecModeNoSecurity = 0x00 , SecModePreconfiguredNetworkKey = 0x01 , SecModeNetworkKeyFromTrustCenter = 0x02 , SecModeNoMasterButTrustCeneterLinkKey = 0x03 , SecModeMasterKey = 0x04 }
	Security modes.

enum	Indication { IndicateNone , IndicateReceive , IndicateSend , IndicateSendDone , IndicateDataUpdate , IndicateError }

enum	ZdpState { ZdpSuccess = 0x00 , ZdpInvalidRequestType = 0x80 , ZdpDeviceNotFound = 0x81 , ZdpInvalidEndpoint = 0x82 , ZdpNotActive = 0x83 , ZdpNotSupported = 0x84 , ZdpTimeout = 0x85 , ZdpNoMatch = 0x86 , ZdpNoEntry = 0x88 , ZdpNoDescriptor = 0x89 , ZdpInsufficientSpace = 0x8a , ZdpNotPermitted = 0x8b , ZdpTableFull = 0x8c , ZdpNotAuthorized = 0x8d }
	Common ZigBee Device Profile (ZDP) status codes.

enum	ZclStatus { ZclSuccessStatus = 0x00 , ZclFailureStatus = 0x01 , ZclNotAuthorizedStatus = 0x7e , ZclReservedFieldNotZeroStatus = 0x7f , ZclMalformedCommandStatus = 0x80 , ZclUnsupClusterCommandStatus = 0x81 , ZclUnsupGeneralCommandStatus = 0x82 , ZclUnsupManufClusterCommandStatus = 0x83 , ZclUnsupManufGeneralCommandStatus = 0x84 , ZclInvalidFieldStatus = 0x85 , ZclUnsupportedAttributeStatus = 0x86 , ZclInvalidValueStatus = 0x87 , ZclReadOnlyStatus = 0x88 , ZclInsufficientSpaceStatus = 0x89 , ZclInconstistentStartupStateStatus = 0x90 , ZclDefinedOutOfBandStatus = 0x91 , ZclHardwareFailureStatus = 0xc0 , ZclSoftwareFailureStatus = 0xc1 , ZclCalibrationErrorStatus = 0xc2 , ZclClusterNotSupportedErrorStatus = 0xc3 }
	Common ZigBee Cluster Library (ZCL) status codes.

enum	ApsStatus { ApsSuccessStatus = 0x00 , ApsAsduTooLongStatus = 0xa0 , ApsDefragDeferredStatus = 0xa1 , ApsDefragUnsupportedStatus = 0xa2 , ApsIllegalRequestStatus = 0xa3 , ApsInvalidBindingStatus = 0xa4 , ApsInvalidGroupStatus = 0xa5 , ApsInvalidParameterStatus = 0xa6 , ApsNoAckStatus = 0xa7 , ApsNoBoundDeviceStatus = 0xa8 , ApsNoShortAddressStatus = 0xa9 , ApsNotSupportedStatus = 0xaa , ApsSecuredLinkKeyStatus = 0xab , ApsSecuredNwkKeyStatus = 0xac , ApsSecurityFailStatus = 0xad , ApsTableFullStatus = 0xae , ApsUnsecuredStatus = 0xaf , ApsUnsupportedAttributeStatus = 0xb0 }
	Common Application Support Layer (APS) status codes.

enum	NwkStatus { NwkInvalidParameterStatus = 0xc1 , NwkInvalidRequestStatus = 0xc2 , NwkNotPermittedStatus = 0xc3 , NwkStartupFailureStatus = 0xc4 , NwkAlreadyPresentStatus = 0xc5 , NwkSyncFailureStatus = 0xc6 , NwkNeighborTableFullStatus = 0xc7 , NwkNoNetworkStatus = 0xca , NwkRouteDiscoveryFailedStatus = 0xd0 , NwkRouteErrorStatus = 0xd1 , NwkBroadcastTableFullStatus = 0xd2 }
	Common Network Layer (NWK) status codes.

enum	MacStatus { MacNoChannelAccess = 0xe1 , MacInvalidParameterStatus = 0xe8 , MacNoAckStatus = 0xe9 , MacNoBeaconStatus = 0xea , MacTransactionExpiredStatus = 0xf0 }
	Common Medium Access Control Layer (MAC) status codes.

enum	ApsRequestKeyStatus { ApsRequestKeySuccessStatus = 0x00 , ApsRequestKeyNoShortAddressStatus = 0x01 , ApsRequestKeySecurityFailStatus = 0x02 , ApsRequestKeyNotSendStatus = 0x03 , ApsRequestKeyTimeoutStatus = 0x04 }
	Bitcloud's APSME-REQUEST-KEY.confirm status codes. More...

enum	AddressMode { NoAddress = 0x0 , NwkAddress = 0x1 , ExtAddress = 0x2 , GroupAddress = 0x4 }
	ZigBee device types.

enum	DeviceType { Coordinator , Router , EndDevice , UnknownDevice }
	ZigBee device types.

enum	NeighborPermitJoin { NeighborAcceptJoin , NeighborNotAcceptJoin , NeighborJoinUnknown }

enum	DeviceRelationship { ParentRelation = 0x0 , ChildRelation , SiblingRelation , UnknownRelation , PreviousChildRelation , UnauthenticatedChildRelation }
	Neighbortable relationship between devices.

enum	NetEvent { UnknownEvent , GotGeneralFrame , DeviceStateChanged , GotNetworkConfig , GotBindResponse , GotUnbindResponse , GotMgmtBind , GotNodeDescriptor , GotPowerDescriptor , GotSimpleDescriptor , GotComplexDescriptor , GotUserDescriptor , GotMgmtLqiPart , GotActiveEndpoints , GotLqiRssi , GotZclReadAttributes , GotNetDescriptor , GotNwkAddressList , GotLinkKey , GotApsDataConfirm , GotApsDataIndication , NeighborUpdated , NotifyError , NotifyZdpError , NotifyZclError , NotifyNwkError , NotifyStatus , NotifyText , NodeDataChanged , NodeDeleted }
	Type of a event send by the zmMaster. More...

enum	RequestId { ReqUnknown = 0 , ReqNwkAddr , ReqIeeeAddr , ReqNodeDescriptor , ReqPowerDescriptor , ReqSimpleDescriptor , ReqUserDescriptor , ReqActiveEndpoints , ReqMgmtLqi , ReqMgmtBind , ReqMaxItems }

enum	State { NotInNetwork = 0 , Connecting , InNetwork , Leaving , UnknownState , Touchlink }
	The state of a device or node.

enum	ConnectMode { ConnectModeManual = 0x00 , ConnectModeNormal = 0x01 , ConnectModeZll = 0x02 }
	Defines how the device connects to the network.

enum	CommonState : unsigned char { IdleState = 0 , BusyState , WaitState , ConfirmedState , TimeoutState , FailureState , FinishState , FireAndForgetState }
	Common states for various purposes.

enum	FrequencyBand { UnknownFrequencyBand = 0 , Freq868 = 0x08 , Freq902 = 0x20 , Freq2400 = 0x40 }
	ZigBee frequency band. More...

enum	GraphicalTypes { GraphNodeType = 1 , GraphLinkType = 2 , GraphSocketType = 3 }

enum	StorageLocation { HomeLocation , ApplicationsLocation , ApplicationsDataLocation , DocumentsLocation , ZcldbLocation , ConfigLocation , NodeCacheLocation , RuntimeLocation , DdfLocation , DdfUserLocation }

enum	ZclDataTypeId : unsigned char { ZclNoData = 0x00 , Zcl8BitData = 0x08 , Zcl16BitData = 0x09 , Zcl24BitData = 0x0a , Zcl32BitData = 0x0b , Zcl40BitData = 0x0c , Zcl48BitData = 0x0d , Zcl56BitData = 0x0e , Zcl64BitData = 0x0f , ZclBoolean = 0x10 , Zcl8BitBitMap = 0x18 , Zcl16BitBitMap = 0x19 , Zcl24BitBitMap = 0x1a , Zcl32BitBitMap = 0x1b , Zcl40BitBitMap = 0x1c , Zcl48BitBitMap = 0x1d , Zcl56BitBitMap = 0x1e , Zcl64BitBitMap = 0x1f , Zcl8BitUint = 0x20 , Zcl16BitUint = 0x21 , Zcl24BitUint = 0x22 , Zcl32BitUint = 0x23 , Zcl40BitUint = 0x24 , Zcl48BitUint = 0x25 , Zcl56BitUint = 0x26 , Zcl64BitUint = 0x27 , Zcl8BitInt = 0x28 , Zcl16BitInt = 0x29 , Zcl24BitInt = 0x2a , Zcl32BitInt = 0x2b , Zcl40BitInt = 0x2c , Zcl48BitInt = 0x2d , Zcl56BitInt = 0x2e , Zcl64BitInt = 0x2f , Zcl8BitEnum = 0x30 , Zcl16BitEnum = 0x31 , ZclSemiFloat = 0x38 , ZclSingleFloat = 0x39 , ZclDoubleFloat = 0x3a , ZclOctedString = 0x41 , ZclCharacterString = 0x42 , ZclLongOctedString = 0x43 , ZclLongCharacterString = 0x44 , ZclArray = 0x48 , ZclStruct = 0x4c , ZclTimeOfDay = 0xe0 , ZclDate = 0xe1 , ZclUtcTime = 0xe2 , ZclClusterId = 0xe8 , ZclAttributeId = 0xe9 , ZclBACNetOId = 0xea , ZclIeeeAddress = 0xf0 , Zcl128BitSecurityKey = 0xf1 }
	Various data types as defined in ZigBee ZCL specification. More...

enum	ZclGeneralCommandId : unsigned char { ZclReadAttributesId = 0x00 , ZclReadAttributesResponseId = 0x01 , ZclWriteAttributesId = 0x02 , ZclWriteAttributesUndividedId = 0x03 , ZclWriteAttributesResponseId = 0x04 , ZclWriteAttributesNoResponseId = 0x05 , ZclConfigureReportingId = 0x06 , ZclConfigureReportingResponseId = 0x07 , ZclReadReportingConfigId = 0x08 , ZclReadReportingConfigResponseId = 0x09 , ZclReportAttributesId = 0x0a , ZclDefaultResponseId = 0x0b , ZclDiscoverAttributesId = 0x0c , ZclDiscoverAttributesResponseId = 0x0d , ZclReadAttributesStructuredId = 0x0e , ZclWriteAttributesStructuredId = 0x0f , ZclWriteAttributesStructuredResponseId = 0x10 }
	General ZCL command ids every cluster shall support.

enum	ZclFrameControl : unsigned char { ZclFCProfileCommand = 0x00 , ZclFCClusterCommand = 0x01 , ZclFCManufacturerSpecific = 0x04 , ZclFCDirectionServerToClient = 0x08 , ZclFCDirectionClientToServer = 0x00 , ZclFCEnableDefaultResponse = 0x00 , ZclFCDisableDefaultResponse = 0x10 }
	General ZCL Frame Format. More...

enum	ZclAccess { ZclRead = 0x1 , ZclWrite = 0x2 , ZclReadWrite = 0x3 }
	Allowed access method of a ZclAttribute.

enum	ZclClusterSide { ClientCluster = 0 , ServerCluster = 1 }
	ZCL cluster side where client is a out cluster and server is a in cluster.

enum	MacCapability : unsigned char { MacAlternatePanCoordinator = (1 << 0) , MacDeviceIsFFD = (1 << 1) , MacIsMainsPowered = (1 << 2) , MacReceiverOnWhenIdle = (1 << 3) , MacSecuritySupport = (1 << 6) , MacAllocateAddress = (1 << 7) }
	IEEE 802.15.4 MAC capabilities. More...

enum	PowerMode { ModeOnWhenIdle = 0x00 , ModePeriodic = 0x01 , ModeStimulated = 0x02 }
	Current power mode in node power descriptor. More...

enum	PowerSource { PowerSourceUnknown = 0x00 , PowerSourceMains = 0x01 , PowerSourceRechargeable = 0x02 , PowerSourceDisposable = 0x04 }
	Available power sources in node power descriptor. More...

enum	PowerSourceLevel { PowerLevelCritical = 0x00 , PowerLevel33 = 0x04 , PowerLevel66 = 0x08 , PowerLevel100 = 0x0c }
	Current power source level in node power descriptor. More...

enum	Constants { GP_NwkProtocolVersion = 3 , GP_NwkDataFrame = 0 , GP_NwkMaintenanceFrame = 1 , GP_MinMsduSize = 1 , GP_AutoCommissioningFlag = (1 << 6) , GP_NwkFrameControlExtensionFlag = (1 << 7) }

Functions
const char *	ApsStatusToString (unsigned char status)

DECONZ_DLLSPEC QString	DEV_StableDevicePath (const QString &path)

DECONZ_DLLSPEC QString	DEV_ResolvedDevicePath (const QString &path)

uint	SR_HashUuid (const QString &uuid)

int64_t DECONZ_DLLSPEC	msecSinceEpoch ()
	Returnes milliseconds since Epoch.

SystemTimeRef DECONZ_DLLSPEC	systemTimeRef () noexcept
	Returnes a time point reference in system time as milliseconds since Epoch.

SteadyTimeRef DECONZ_DLLSPEC	steadyTimeRef () noexcept
	Returnes a time point reference in milliseconds which is monotonic increasing.

bool DECONZ_DLLSPEC	isValid (SteadyTimeRef t)

bool DECONZ_DLLSPEC	isValid (SystemTimeRef t)

bool DECONZ_DLLSPEC	operator< (SystemTimeRef a, SystemTimeRef b)

bool DECONZ_DLLSPEC	operator== (SteadyTimeRef a, SteadyTimeRef b)

bool DECONZ_DLLSPEC	operator!= (SteadyTimeRef a, SteadyTimeRef b)

bool DECONZ_DLLSPEC	operator< (SteadyTimeRef a, SteadyTimeRef b)

bool DECONZ_DLLSPEC	operator<= (SteadyTimeRef a, SteadyTimeRef b)

TimeMs DECONZ_DLLSPEC	operator- (SteadyTimeRef a, SteadyTimeRef b)

SteadyTimeRef DECONZ_DLLSPEC	operator+ (SteadyTimeRef a, TimeMs t)

SteadyTimeRef DECONZ_DLLSPEC	operator+ (SteadyTimeRef a, TimeSeconds t)

bool DECONZ_DLLSPEC	operator< (TimeMs a, TimeMs b)

bool DECONZ_DLLSPEC	operator< (TimeSeconds a, TimeSeconds b)

bool DECONZ_DLLSPEC	operator< (TimeSeconds a, TimeMs b)

bool DECONZ_DLLSPEC	operator< (TimeMs a, TimeSeconds b)

TimeSeconds DECONZ_DLLSPEC	operator* (TimeSeconds a, int factor)

TimeMs DECONZ_DLLSPEC	operator* (TimeMs a, int factor)

int DECONZ_DLLSPEC	appArgumentNumeric (const QString &arg, int defaultValue)
	Get the value of a commandline argument.

QString DECONZ_DLLSPEC	appArgumentString (const QString &arg, const QString &defaultValue)
	Get the value of a commandline argument.

QString DECONZ_DLLSPEC	jsonStringFromMap (const QVariantMap &map)

QString DECONZ_DLLSPEC	jsonStringFromList (const QVariantList &ls)

QString DECONZ_DLLSPEC	getStorageLocation (StorageLocation location)

bool DECONZ_DLLSPEC	isVirtualMachine ()

DECONZ_DLLSPEC QDataStream &	operator<< (QDataStream &ds, ZclDataTypeId_t id)
	Writes ZclDataTypeId_t as quint8 to the QDataStream.

DECONZ_DLLSPEC QDataStream &	operator>> (QDataStream &ds, ZclDataTypeId_t &id)
	Reads ZclDataTypeId_t as quint8 from the QDataStream.

constexpr ZclDataTypeId_t DECONZ_DLLSPEC	operator""_dtid (unsigned long long id)

constexpr ZclCommandId_t DECONZ_DLLSPEC	operator""_cmdid (unsigned long long id)

constexpr ZclAttributeId_t DECONZ_DLLSPEC	operator""_atid (unsigned long long id)

constexpr ManufacturerCode_t DECONZ_DLLSPEC	operator""_mfcode (unsigned long long mfcode)

constexpr ZclClusterId_t DECONZ_DLLSPEC	operator""_clid (unsigned long long id)

DECONZ_DLLSPEC ZclCluster	ZCL_InCluster (uint16_t profileId, uint16_t clusterId, uint16_t mfcode)

DECONZ_DLLSPEC ZclCluster	ZCL_OutCluster (uint16_t profileId, uint16_t clusterId, uint16_t mfcode)

DECONZ_DLLSPEC ZclDataType	ZCL_DataType (uint8_t id)

DECONZ_DLLSPEC ZclDataType	ZCL_DataType (const QString &name)

bool	endpointLessThan (const SimpleDescriptor &a, const SimpleDescriptor &b)

QDataStream &	operator<< (QDataStream &ds, ManufacturerCode_t mfcode)

QDataStream &	operator>> (QDataStream &ds, ManufacturerCode_t &mfcode)

QDataStream &	operator<< (QDataStream &ds, ZclAttributeId_t id)

QDataStream &	operator>> (QDataStream &ds, ZclAttributeId_t &id)

QDataStream &	operator<< (QDataStream &ds, ZclClusterId_t id)

QDataStream &	operator>> (QDataStream &ds, ZclClusterId_t &id)

QDataStream &	operator<< (QDataStream &ds, ZclCommandId_t id)

QDataStream &	operator>> (QDataStream &ds, ZclCommandId_t &id)

ZclDataBase *	zclDataBase ()

Detailed Description

The deCONZ namespace.

Various data types as defined in ZigBee ZCL specification.

To handle data type in payloads use deCONZ::ZclDataTypeId_t

Enumeration Type Documentation

◆ ApsAddressMode

enum deCONZ::ApsAddressMode : unsigned char

Address modes used to specify source and destination addresses.

Enumerator
ApsNoAddress	No addressing specified.
ApsGroupAddress	16-bit group address mode
ApsNwkAddress	16-bit network address mode
ApsExtAddress	64-bit extended IEEE address mode
ApsNwkExtAddress	16-bit network address mode and 64-bit extended IEEE address mode (since protocol version 0x010B)

◆ ApsRequestKeyStatus

enum deCONZ::ApsRequestKeyStatus

Bitcloud's APSME-REQUEST-KEY.confirm status codes.

The standard does not have a confirm primitive.

◆ ApsTxOption

enum deCONZ::ApsTxOption : unsigned char

Flags used in the ApsDataRequest.

Enumerator
ApsTxSecurityEnabledTransmission	APS layer security enabled transmission.
ApsTxUseNwk	Use network key security.
ApsTxAcknowledgedTransmission	Enable APS acknowledged transmission.
ApsTxFragmentationPermitted	Allow fragmentation.

◆ ArrayParameter

enum deCONZ::ArrayParameter

Parameters of type QByteArray.

Enumerator
ParamNetworkKey	the 128-bit network key
ParamTrustCenterLinkKey	the 128-bit trust center link key
ParamSecurityMaterial0	the 256-bit security material set 0

◆ LibraryReturnCodes

enum deCONZ::LibraryReturnCodes

Return codes of the deCONZ library.

Enumerator
Success	Success.
ErrorNotConnected	Not connected (device or network)
ErrorQueueIsFull	Queue is full.
ErrorNodeIsZombie	Node is not reachable.
ErrorNotFound	Not found.

◆ MacCapability

enum deCONZ::MacCapability : unsigned char

IEEE 802.15.4 MAC capabilities.

Enumerator
MacAlternatePanCoordinator	Can be a alternate pan coordinator.
MacDeviceIsFFD	Is a full function device.
MacIsMainsPowered	Is mains powered.
MacReceiverOnWhenIdle	Has receiver on when idle.
MacSecuritySupport	Has (high) security support.
MacAllocateAddress	Allocates address.

◆ NetEvent

enum deCONZ::NetEvent

Type of a event send by the zmMaster.

The event may have associated data as described below.

Enumerator
GotGeneralFrame	zmNetEvent::value() holds the deCONZ::GeneralFrame.
DeviceStateChanged	zmNetEvent::value() holds the deCONZ::State.
GotNetworkConfig	zmNetEvent::value() holds a zmNet
GotBindResponse	zmNetEvent::value() holds the deCONZ::ZdpState.
GotUnbindResponse	zmNetEvent::value() holds the deCONZ::ZdpState.
GotMgmtBind	zmNetEvent::value() holds a BindingTable if isValid().
GotNodeDescriptor	zmNetEvent::pod() holds a zmNodeDescriptor.
GotPowerDescriptor	zmNetEvent::pod() holds a zmPowerDescriptor.
GotSimpleDescriptor	zmNetEvent::pod() holds a zmSimpleDescriptor.
GotComplexDescriptor	zmNetEvent::pod() holds a zmComplexDescriptor.
GotUserDescriptor	zmNetEvent::value() holds a QString.
GotMgmtLqiPart	zmNetEvent::pod() holds a zmNeighbor.
GotActiveEndpoints	zmNetEvent::value() holds a QByteArray with endpoints.
GotLqiRssi	zmNetEvent::value() holds a QByteArray with (u8 lqi, u8 rssi).
GotZclReadAttributes	zmNetEvent::value() holds a QByteArray with the ZCL Read Attributes response.
GotNetDescriptor	zmNetEvent::value() holds a zmNet.
GotNwkAddressList	TODO.
GotLinkKey	zmNetEvent::value() holds a deCONZ::ApsRequestKeyStatus status code.
GotApsDataConfirm	zmNetEvent::value() holds a zmApsDataConfirm.
GotApsDataIndication	zmNetEvent::value() holds a zmApsDataIndication.
NeighborUpdated	zmNetEvent::value() holds a zmNeighbor. zmNetEvent::listSize() holds the size of the neighbor table. zmNetEvent::listIndex() holds the index of this neighbor in the table.
NotifyError	zmNetEvent::value() holds a uint error code.
NotifyZdpError	zmNetEvent::value() holds a uint error code.
NotifyZclError	zmNetEvent::value() holds a uint error code.
NotifyNwkError	zmNetEvent::value() holds a uint error code.
NotifyStatus	zmNetEvent::value() holds a uint status code. zmNetEvent::cookie() holds the associated cookie.
NotifyText	zmNetEvent::value() holds a QString.
NodeDataChanged	zmNetEvent::node() holds the node for which the data has changed.
NodeDeleted	zmNetEvent::node() holds the node which is gone.

◆ PowerMode

enum deCONZ::PowerMode

Current power mode in node power descriptor.

Enumerator

ModeOnWhenIdle

Receiver synchronized with the receiver on when idle sub-field of the node descriptor.

ModePeriodic

Receiver comes on periodically as defined by the node power descriptor.

ModeStimulated

Receiver comes on when stimulated, e.g.

by a user pressing a button.

◆ PowerSource

enum deCONZ::PowerSource

Available power sources in node power descriptor.

Enumerator
PowerSourceMains	Constant (mains) power.
PowerSourceRechargeable	Rechargeable battery.
PowerSourceDisposable	Disposable battery.

◆ PowerSourceLevel

enum deCONZ::PowerSourceLevel

Current power source level in node power descriptor.

Enumerator
PowerLevelCritical	Critical.
PowerLevel33	33%
PowerLevel66	66%
PowerLevel100	100%

◆ StringParameter

enum deCONZ::StringParameter

Parameters of type QString.

Enumerator
ParamDeviceName	name of the connetced device (RaspBee, ConBee, ...)
ParamDevicePath	/dev/ttyUSB0, /dev/ttyAMA0, COM49, ...
ParamHttpRoot	the http server root directory

◆ TouchlinkStatus

enum deCONZ::TouchlinkStatus

Status codes used by the touchlink module.

Enumerator
TouchlinkSuccess	Success.
TouchlinkFailed	Failed.
TouchlinkBusy	Busy.

◆ U16Parameter

enum deCONZ::U16Parameter

Parameters of type uint16_t.

Enumerator
ParamPANID	the short PANID
ParamNwkAddress	the network address of the device
ParamHttpPort	the http server port

◆ U32Parameter

enum deCONZ::U32Parameter

Parameters of type uint32_t.

Enumerator
ParamChannelMask	the 32-bit bitmap with enabled channels set as bit
ParamFirmwareVersion	the firmware version of the connected device, special value 1 means bootloader but no firmware
ParamFrameCounter	the current outgoing frame counter

◆ U64Parameter

enum deCONZ::U64Parameter

Parameters of type uint64_t.

Enumerator
ParamApsUseExtendedPANID	the extended PANID to use during join
ParamExtendedPANID	the current extended PANID
ParamMacAddress	the MAC address of the device
ParamTrustCenterAddress	the MAC address of the trust center

◆ U8Parameter

enum deCONZ::U8Parameter

Parameters of type uint8_t.

Enumerator
ParamCurrentChannel	the current operation channel
ParamDeviceType	deCONZ::Coordinator or deCONZ::Router
ParamSecurityMode	one of the deCONZ::SecurityMode values
ParamPermitJoin	permit join duration
ParamOtauActive	otau server: 1 = activated, 0 = deactivated
ParamAutoPollingActive	Automatic polling of ZDP / REST Plugin: 1 = activated, 0 = deactivated.
ParamNetworkUpdateId	network update id
ParamFirmwareUpdateActive	values from FirmwareUpdateState enum
ParamDeviceConnected	device connected state: 1 = connected, 0 = disconnected
ParamApsAck	aps ack enabled/disabled
ParamPredefinedPanId	Predefined PanId enabled/disabled.
ParamCustomMacAddress	custom Mac Address enabled/disabled
ParamStaticNwkAddress	static NwkAddress enabled/disabled

◆ ZclFrameControl

enum deCONZ::ZclFrameControl : unsigned char

General ZCL Frame Format.

Bits ---— Header -------------— 8 Frame control 0/16 Manufacturer code 8 Transaction sequence 8 Command Id ---— ZCL payload ----------—

Variable Frame payload

Frame control flags used in ZCL frame header.

Function Documentation

◆ steadyTimeRef()

SteadyTimeRef deCONZ::steadyTimeRef ( )

noexcept

Returnes a time point reference in milliseconds which is monotonic increasing.

This is best used for timeouts and measure relative times.

◆ systemTimeRef()

SystemTimeRef deCONZ::systemTimeRef ( )