deCONZ C++ API v2.6.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
deCONZ::ZclCluster Class Reference
ZCL

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

#include <zcl.h>

Public Member Functions

 ZclCluster ()
 Constructor.
 
 ZclCluster (const ZclCluster &other)
 Copy constructor.
 
 ZclCluster (uint16_t id, const QString &name, const QString &description=QString())
 Constructor used by ZCLDB parser.
 
ZclCluster & operator= (const ZclCluster &other)
 Copy assignment constructor.
 
 ~ZclCluster ()
 Deconstructor.
 
uint16_t id () const
 Returns the cluster identifier.
 
ZclClusterId_t id_t () const
 Returns strong typed cluster identifier.
 
void setId (uint16_t id)
 Sets the cluster identifier.
 
uint16_t oppositeId () const
 Returns the opposite cluster identifier (server/client) which is the same for ZCL based clusters.
 
void setOppositeId (uint16_t id)
 Sets the opposite cluster identifier.
 
uint16_t manufacturerCode () const
 Returns the manufacturer code, default = 0.
 
ManufacturerCode_t manufacturerCode_t () const
 Returns the strong typed manufacturer code (preferred), default = 0.
 
void setManufacturerCode (uint16_t manufacturerCode)
 Sets the manufacturer code.
 
void setManufacturerCode (ManufacturerCode_t manufacturerCode)
 Sets the strong typed manufacturer code (preferred).
 
const QString & name () const
 Returns the cluster name.
 
const QString & description () const
 Returns the cluster description.
 
void setDescription (const QString &description)
 Sets the cluster description.
 
bool isValid () const
 Returns true if this cluster has valid data.
 
bool isZcl () const
 Returns true if this cluster is ZCL based.
 
void setIsZcl (bool isZcl)
 Sets the cluster is ZCL based flag.
 
bool isServer () const
 Returns true if this is a server (in) cluster.
 
bool isClient () const
 Returns true if this is a client (out) cluster.
 
void setIsServer (bool isServer)
 Sets the is a server (in) cluster flag, this also effects the isClient() method.
 
std::vector< ZclAttribute > & attributes ()
 Returns the modifiable attributes list.
 
const std::vector< ZclAttribute > & attributes () const
 Returns the modifiable attributes list.
 
std::vector< ZclAttributeSet > & attributeSets ()
 Returns the const attribute sets list.
 
const std::vector< ZclAttributeSet > & attributeSets () const
 Returns the const attribute sets list.
 
bool readCommand (const ZclFrame &zclFrame)
 Reads a ZCL based command from a ZCL frame.
 
bool readCommand (const ApsDataIndication &ind)
 Reads a non-ZCL based single command (like ZDP) from APSDE-DATA.indication.
 
std::vector< ZclCommand > & commands ()
 Returns the modifiable list of commands.
 
const std::vector< ZclCommand > & commands () const
 Returns the const list of commands.
 

Detailed Description

Represents a ZigBee cluster (ZCL and non-ZCL).

See also
SimpleDescriptor::inClusters(), SimpleDescriptor::outClusters()

Member Function Documentation

◆ id_t()

ZclClusterId_t deCONZ::ZclCluster::id_t ( ) const

Returns strong typed cluster identifier.

Since
v2.6.1

◆ manufacturerCode_t()

ManufacturerCode_t deCONZ::ZclCluster::manufacturerCode_t ( ) const

Returns the strong typed manufacturer code (preferred), default = 0.

Since
v2.6.1

◆ setManufacturerCode()

void deCONZ::ZclCluster::setManufacturerCode ( ManufacturerCode_t  manufacturerCode)

Sets the strong typed manufacturer code (preferred).

Since
v2.6.1
The documentation for this class was generated from the following files: