deCONZ C++ API v2.6.1
Loading...
Searching...
No Matches
deCONZ::ZclCommand Class Reference

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

#include <zcl.h>

Public Member Functions

 ZclCommand ()
 Constructor.
 
 ZclCommand (const ZclCommand &other)
 Copy constructor.
 
 ZclCommand (ZclCommand &&other) noexcept
 Move constructor.
 
ZclCommandoperator= (const ZclCommand &other)
 Copy assignment constructor.
 
ZclCommandoperator= (ZclCommand &&other) noexcept
 Move assignment constructor.
 
 ZclCommand (uint8_t id, const QString &name, bool required, bool recv, const QString &description=QString())
 Constructor used by ZCLDB parser.
 
 ~ZclCommand ()
 Deconstructor.
 
uint8_t id () const
 Returns the command identifier.
 
ZclCommandId_t id_t () const
 Returns the strong typed command identifier.
 
void setId (uint8_t id)
 Sets the command identifier.
 
uint16_t manufacturerId () const
 Returns the manufacturer identifier.
 
void setManufacturerId (uint16_t id)
 Sets the manufacturer identifier.
 
bool isValid () const
 Returns true if this command has valid data.
 
uint8_t responseId () const
 Returns the response command identifier.
 
void setResponseId (uint8_t id)
 Sets the response command identifier.
 
bool hasResponse () const
 Returns true if this command expects a response.
 
bool directionReceived () const
 Returns true if the command will be received.
 
bool directionSend () const
 Returns false if the command will be send.
 
const QString & name () const
 Returns the name of the command.
 
const QString & description () const
 Returns the description of the command.
 
void setDescription (const QString &description)
 Sets the description of the command.
 
bool isProfileWide () const
 Returns true if the command is profile wide (not cluster specific).
 
void setIsProfileWide (bool profileWide)
 Sets the is profile wide flag.
 
bool disableDefaultResponse () const
 Returns true if the disable default response flag is set.
 
void setDisableDefaultResponse (bool disable)
 Sets the disable default response flag.
 
const std::vector< ZclAttribute > & parameters () const
 Returns the const list of command parameters.
 
std::vector< ZclAttribute > & parameters ()
 Returns the modifiable list of command parameters.
 
bool readFromStream (QDataStream &stream)
 Reads the command parameters from stream.
 
bool writeToStream (QDataStream &stream) const
 Writes the command parameters to stream.
 

Detailed Description

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

Member Function Documentation

◆ id_t()

ZclCommandId_t deCONZ::ZclCommand::id_t ( ) const

Returns the strong typed command identifier.

Since
v2.6.1

The documentation for this class was generated from the following files: