Download ZigBee Cluster Library User Guide

Chapter 17
Colour Control Cluster
eCLD_ColourControlCommandStepColourCommandSend
teZCL_Status
eCLD_ColourControlCommandStepColourCommandSend(
uint8 u8SourceEndPointId,
uint8 u8DestinationEndPointId,
tsZCL_Address *psDestinationAddress,
uint8 *pu8TransactionSequenceNumber,
tsCLD_ColourControl_StepColourCommandPayload
*psPayload);
Description
This function sends a Step Colour command to instruct a device to change its ‘current
x’ and ‘current y’ attribute values by a specified ‘step’ value for each attribute in a
continuous manner within a given time (where x and y are the chromaticities from the
CIE xyY colour space). The step sizes and transition time are specified in the payload
of the command (see Section 17.6.2), and each step size can be positive (increase)
or negative (decrease).
The device receiving this message will generate a callback event on the endpoint on
which the Colour Control cluster was registered. The device must first ensure that
‘chromaticities x and y’ mode is selected by setting the ‘colour mode’ attribute to
0x01, if required. It can then move the ‘current x’ and ‘current y’ values as requested.
You are required to provide a pointer to a location to receive a Transaction Sequence
Number (TSN) for the request. The TSN in the response will be set to match the TSN
in the request, allowing an incoming response to be paired with a request. This is
useful when sending more than one request to the same destination endpoint.
This function can only be used when the ‘current x’ and ‘current y’ values attributes
are enabled in the Colour Control cluster.
Parameters
u8SourceEndPointId
u8DestinationEndPointId
psDestinationAddress
Number of the local endpoint through which to
send the request. This parameter is used both to
send the message and to identify the instance of
the shared structure holding the required
attribute values
Number of the endpoint on the remote node to
which the request will be sent. This parameter is
ignored when sending to address types
eZCL_AMBOUND and eZCL_AMGROUP
Pointer to a structure holding the address of the
node to which the request will be sent
pu8TransactionSequenceNumber Pointer to a location to receive the Transaction
Sequence Number (TSN) of the request
psPayload
304
Pointer to a structure containing the payload for
this message (see Section 17.6.2)
© NXP Laboratories UK 2013
JN-UG-3077 v1.9