deCONZ C++ API v2.6.1
Loading...
Searching...
No Matches
APS

Services to send and receive arbitrary data. More...

Classes

class  deCONZ::Address
 Convenience class to work with network, extended and group addresses. More...
 
class  deCONZ::ApsDataRequest
 APSDE-DATA.request primitive. More...
 
class  deCONZ::ApsDataConfirm
 APSDE-DATA.confirm primitive. More...
 
class  deCONZ::ApsDataIndication
 APSDE-DATA.indication primitive. More...
 
class  deCONZ::ApsController
 Provides APSDE-DATA service and access to node cache. More...
 
class  deCONZ::Node
 Represents a ZigBee node with all its descriptors and clusters. More...
 
class  deCONZ::NodeInterface
 Main interface to create a deCONZ plugin. More...
 

Enumerations

enum  deCONZ::NwkBroadcastAddress { deCONZ::BroadcastAll = 0xFFFF , deCONZ::BroadcastLowPowerRouters = 0xFFFB , deCONZ::BroadcastRouters = 0xFFFC , deCONZ::BroadcastRxOnWhenIdle = 0xFFFD }
 Special network layer broadcast addresses. More...
 
enum  deCONZ::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  deCONZ::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  deCONZ::MacStatus {
  MacNoChannelAccess = 0xe1 , MacInvalidParameterStatus = 0xe8 , MacNoAckStatus = 0xe9 , MacNoBeaconStatus = 0xea ,
  MacTransactionExpiredStatus = 0xf0
}
 Common Medium Access Control Layer (MAC) status codes.
 

Detailed Description

Services to send and receive arbitrary data.

Application Support Layer (APS)

The Application Support Layer (APS) as defined in ZigBee specification (ZigBee Document 053474r19), provides an asynchronous interface for sending and receiving data to and from other nodes in the network.

Applications can use the deCONZ::ApsController service in order to send deCONZ::ApsDataRequest to the network as well as register for incoming deCONZ::ApsDataConfirm and deCONZ::ApsDataIndication events via the Qt signal/slot mechanism.

msc_inline_mscgraph_1

The APS is not limited to any specific ZigBee profile like Home Automation or Smart Energy, the application is responsible to specify related profile ids, cluster ids and payload data.

It is possible to send and receive ZCL based packets as well as non-ZCL based proprietary ones.

Enumeration Type Documentation

◆ NwkBroadcastAddress

Special network layer broadcast addresses.

Enumerator
BroadcastAll 

Broadcast to all nodes including end devices.

BroadcastLowPowerRouters 

Broadcast only to low power routers.

BroadcastRouters 

Broadcast only to routers.

BroadcastRxOnWhenIdle 

Broadcast to all nodes which have the RxOnWhenIdle flag set.