Skip to content

Commit

Permalink
Improve zcl attribute report configuration (1)
Browse files Browse the repository at this point in the history 
This commit is a test for power and basic cluster only to
improve current philips hue motion sensor issues.

The zcl sequence number of the request/response tracks if
configuration is already done but no reports were received yet.

Prior many configuration and bind requests were send until reports fly in.
  • Loading branch information
@manup
manup committed Feb 4, 2018
1 parent 33a7b2a commit a650d37
Show file tree
Hide file tree
Showing 5 changed files with 180 additions and 24 deletions.
189 changes: 166 additions & 23 deletions bindings.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,67 @@ void DeRestPluginPrivate::handleMgmtBindRspIndication(const deCONZ::ApsDataIndic
}
}

/*! Handle incoming ZCL configure reporting response.
*/
void DeRestPluginPrivate::handleZclConfigureReportingResponseIndication(const deCONZ::ApsDataIndication &ind, deCONZ::ZclFrame &zclFrame)
{
QDateTime now = QDateTime::currentDateTime();
std::vector<RestNodeBase*> allNodes;
for (Sensor &s : sensors)
{
allNodes.push_back(&s);
}

for (LightNode &l : nodes)
{
allNodes.push_back(&l);
}

for (RestNodeBase * restNode : allNodes)
{
if (restNode->address().ext() != ind.srcAddress().ext())
{
continue;
}

QDataStream stream(zclFrame.payload());
stream.setByteOrder(QDataStream::LittleEndian);

while (!stream.atEnd())
{
quint8 status;
quint8 direction;
quint16 attrId;
stream >> status;
if (stream.status() == QDataStream::ReadPastEnd)
{
break;
}

// optional fields
stream >> direction;
stream >> attrId;

for (NodeValue &val : restNode->zclValues())
{
if (val.zclSeqNum != zclFrame.sequenceNumber())
{
continue;
}

if (val.minInterval == 0 && val.maxInterval == 0)
{
continue;
}

DBG_Printf(DBG_INFO, "ZCL configure reporting rsp seq: %u 0x%016llX for cluster 0x%04X attr 0x%04X status 0x%02X\n", zclFrame.sequenceNumber(), ind.srcAddress().ext(), ind.clusterId(), val.attributeId, status);
// mark as succefully configured
val.timestampLastConfigured = now;
}
}
}
}

/*! Handle bind/unbind response.
\param ind a ZDP Bind/Unbind_rsp
*/
Expand Down Expand Up @@ -585,7 +646,7 @@ bool DeRestPluginPrivate::sendConfigureReportingRequest(BindingTask &bt, const s
apsReq.setTxOptions(deCONZ::ApsTxAcknowledgedTransmission);

deCONZ::ZclFrame zclFrame;
zclFrame.setSequenceNumber(zclSeq++);
zclFrame.setSequenceNumber(requests.front().zclSeqNum);
zclFrame.setCommandId(deCONZ::ZclConfigureReportingId);

if (requests.front().manufacturerCode)
Expand Down Expand Up @@ -666,8 +727,11 @@ bool DeRestPluginPrivate::sendConfigureReportingRequest(BindingTask &bt)
return false;
}

QDateTime now = QDateTime::currentDateTime();
ConfigureReportingRequest rq;

rq.zclSeqNum = zclSeq++; // to match in configure reporting response handler

if (bt.binding.clusterId == OCCUPANCY_SENSING_CLUSTER_ID)
{
rq.dataType = deCONZ::Zcl8BitBitMap;
Expand Down Expand Up @@ -730,28 +794,48 @@ bool DeRestPluginPrivate::sendConfigureReportingRequest(BindingTask &bt)
}
else if (bt.binding.clusterId == POWER_CONFIGURATION_CLUSTER_ID)
{
Sensor *sensor = static_cast<Sensor *>(bt.restNode);
Sensor *sensor = dynamic_cast<Sensor *>(bt.restNode);

// add values if not already present
deCONZ::NumericUnion dummy;
dummy.u64 = 0;
if (bt.restNode->getZclValue(POWER_CONFIGURATION_CLUSTER_ID, 0x0021).attributeId != 0x0021)
{
bt.restNode->setZclValue(NodeValue::UpdateInvalid, BASIC_CLUSTER_ID, 0x0021, dummy);
}

NodeValue &val = bt.restNode->getZclValue(POWER_CONFIGURATION_CLUSTER_ID, 0x0021);
val.zclSeqNum = rq.zclSeqNum;

rq.dataType = deCONZ::Zcl8BitUint;
rq.attributeId = 0x0021; // battery percentage remaining
if (sensor && sensor->modelId() == QLatin1String("SML001")) // Hue motion sensor
{
rq.minInterval = 7200; // value used by Hue bridge
rq.maxInterval = 7200; // value used by Hue bridge
val.minInterval = 7200; // value used by Hue bridge
val.maxInterval = 7200; // value used by Hue bridge
rq.reportableChange8bit = 0; // value used by Hue bridge
}
else if (sensor && sensor->modelId().startsWith(QLatin1String("RWL02"))) // Hue dimmer switch
{
rq.minInterval = 300; // value used by Hue bridge
rq.maxInterval = 300; // value used by Hue bridge
val.minInterval = 300; // value used by Hue bridge
val.maxInterval = 300; // value used by Hue bridge
rq.reportableChange8bit = 0; // value used by Hue bridge
}
else
{
rq.minInterval = 300;
rq.maxInterval = 60 * 45;
val.minInterval = 300;
val.maxInterval = 60 * 45;
rq.reportableChange8bit = 1;
}

if (val.timestampLastReport.isValid() && (val.timestampLastReport.secsTo(now) < val.maxInterval * 1.5))
{
return false;
}

rq.minInterval = val.minInterval;
rq.maxInterval = val.maxInterval;

return sendConfigureReportingRequest(bt, {rq});
}
else if (bt.binding.clusterId == ONOFF_CLUSTER_ID)
Expand Down Expand Up @@ -823,23 +907,69 @@ bool DeRestPluginPrivate::sendConfigureReportingRequest(BindingTask &bt)
else if (bt.binding.clusterId == BASIC_CLUSTER_ID &&
(bt.restNode->address().ext() & macPrefixMask) == philipsMacPrefix)
{
Sensor *sensor = dynamic_cast<Sensor*>(bt.restNode);
if (!sensor)
{
return false;
}

// only process for presence sensor: don't issue configuration for temperature and illuminance sensors
// TODO check if just used for SML001 sensor or also hue dimmer switch?
if (sensor->type() != QLatin1String("ZHAPresence"))
{
return false;
}

deCONZ::NumericUnion dummy;
dummy.u64 = 0;
// add usertest value if not already present
if (bt.restNode->getZclValue(BASIC_CLUSTER_ID, 0x0032).attributeId != 0x0032)
{
bt.restNode->setZclValue(NodeValue::UpdateInvalid, BASIC_CLUSTER_ID, 0x0032, dummy);
}
// ledindication value if not already present
if (bt.restNode->getZclValue(BASIC_CLUSTER_ID, 0x0033).attributeId != 0x0033)
{
bt.restNode->setZclValue(NodeValue::UpdateInvalid, BASIC_CLUSTER_ID, 0x0033, dummy);
}

NodeValue &val = bt.restNode->getZclValue(BASIC_CLUSTER_ID, 0x0032);

val.zclSeqNum = rq.zclSeqNum;
val.minInterval = 5;
val.maxInterval = 7200;

if (val.timestampLastReport.isValid() && (val.timestampLastReport.secsTo(now) < val.maxInterval * 1.5))
{
return false;
}

// already configured? wait for report ...
if (val.timestampLastConfigured.isValid() && (val.timestampLastConfigured.secsTo(now) < val.maxInterval * 1.5))
{
return false;
}

rq.dataType = deCONZ::ZclBoolean;
rq.attributeId = 0x0032; // usertest
rq.minInterval = 5; // value used by Hue bridge
rq.maxInterval = 7200; // value used by Hue bridge
rq.minInterval = val.minInterval; // value used by Hue bridge
rq.maxInterval = val.maxInterval; // value used by Hue bridge
rq.manufacturerCode = VENDOR_PHILIPS;

if (sendConfigureReportingRequest(bt, {rq}))
{
rq = ConfigureReportingRequest();
rq.dataType = deCONZ::ZclBoolean;
rq.attributeId = 0x0033; // ledindication
rq.minInterval = 5; // value used by Hue bridge
rq.maxInterval = 7200; // value used by Hue bridge
rq.manufacturerCode = VENDOR_PHILIPS;
return sendConfigureReportingRequest(bt, {rq});
}
return false;
NodeValue &val2 = bt.restNode->getZclValue(BASIC_CLUSTER_ID, 0x0033);
val2.zclSeqNum = rq.zclSeqNum;
val2.minInterval = 5;
val2.maxInterval = 7200;

ConfigureReportingRequest rq2;
rq2 = ConfigureReportingRequest();
rq2.dataType = deCONZ::ZclBoolean;
rq2.attributeId = 0x0033; // ledindication
rq2.minInterval = val2.minInterval; // value used by Hue bridge
rq2.maxInterval = val2.maxInterval; // value used by Hue bridge
rq2.manufacturerCode = VENDOR_PHILIPS;

return sendConfigureReportingRequest(bt, {rq, rq2});
}
return false;
}
Expand Down Expand Up @@ -1079,6 +1209,11 @@ void DeRestPluginPrivate::checkSensorBindingsForAttributeReporting(Sensor *senso
else if (*i == POWER_CONFIGURATION_CLUSTER_ID)
{
val = sensor->getZclValue(*i, 0x0021); // battery percentage remaining

if (val.timestampLastConfigured.isValid() && val.timestampLastConfigured.secsTo(now) < (val.maxInterval * 1.5))
{
continue;
}
}
else if (*i == VENDOR_CLUSTER_ID)
{
Expand All @@ -1089,19 +1224,27 @@ void DeRestPluginPrivate::checkSensorBindingsForAttributeReporting(Sensor *senso
}
else if (*i == BASIC_CLUSTER_ID)
{
if (sensor->modelId() == QLatin1String("SML001")) // Hue motion sensor
if (sensor->modelId() == QLatin1String("SML001") && // Hue motion sensor
sensor->type() == QLatin1String("ZHAPresence"))
{
val = sensor->getZclValue(*i, 0x0032); // usertest
// val = sensor->getZclValue(*i, 0x0033); // ledindication

if (val.timestampLastConfigured.isValid() && val.timestampLastConfigured.secsTo(now) < (val.maxInterval * 1.5))
{
continue;
}
}
else
{
continue;
}
}

quint16 maxInterval = (val.maxInterval > 0) ? (val.maxInterval * 1.5) : (60 * 45);

if (val.timestampLastReport.isValid() &&
val.timestampLastReport.secsTo(now) < (60 * 45)) // got update in timely manner
val.timestampLastReport.secsTo(now) < maxInterval) // got update in timely manner
{
DBG_Printf(DBG_INFO_L2, "binding for attribute reporting of cluster 0x%04X seems to be active\n", (*i));
continue;
Expand Down
1 change: 1 addition & 0 deletions bindings.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ class ConfigureReportingRequest
{
}

quint8 zclSeqNum;
quint8 direction;
quint8 dataType;
quint16 attributeId;
Expand Down
5 changes: 5 additions & 0 deletions de_web_plugin.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,10 @@ void DeRestPluginPrivate::apsdeDataIndication(const deCONZ::ApsDataIndication &i
{
handleZclAttributeReportIndication(ind, zclFrame);
}
else if (zclFrame.isProfileWideCommand() && zclFrame.commandId() == deCONZ::ZclConfigureReportingResponseId)
{
handleZclConfigureReportingResponseIndication(ind, zclFrame);
}
}
else if (ind.profileId() == ZDP_PROFILE_ID)
{
Expand Down Expand Up @@ -6276,6 +6280,7 @@ void DeRestPluginPrivate::sendZclDefaultResponse(const deCONZ::ApsDataIndication
apsReq.setProfileId(ind.profileId());
apsReq.setRadius(0);
apsReq.setClusterId(ind.clusterId());
//apsReq.setTxOptions(deCONZ::ApsTxAcknowledgedTransmission);

deCONZ::ZclFrame outZclFrame;
outZclFrame.setSequenceNumber(zclFrame.sequenceNumber());
Expand Down
1 change: 1 addition & 0 deletions de_web_plugin_private.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1027,6 +1027,7 @@ public Q_SLOTS:
void handleMgmtLqiRspIndication(const deCONZ::ApsDataIndication &ind);
void handleDEClusterIndication(const deCONZ::ApsDataIndication &ind, deCONZ::ZclFrame &zclFrame);
void handleZclAttributeReportIndication(const deCONZ::ApsDataIndication &ind, deCONZ::ZclFrame &zclFrame);
void handleZclConfigureReportingResponseIndication(const deCONZ::ApsDataIndication &ind, deCONZ::ZclFrame &zclFrame);
void sendZclDefaultResponse(const deCONZ::ApsDataIndication &ind, deCONZ::ZclFrame &zclFrame, quint8 status);
void taskToLocalData(const TaskItem &task);

Expand Down
8 changes: 7 additions & 1 deletion rest_node_base.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ class NodeValue
NodeValue() :
updateType(UpdateInvalid),
clusterId(0),
attributeId(0)
attributeId(0),
minInterval(0),
maxInterval(0)
{
value.u64 = 0;
}
Expand All @@ -35,9 +37,13 @@ class NodeValue
QDateTime timestamp;
QDateTime timestampLastReport;
QDateTime timestampLastReadRequest;
QDateTime timestampLastConfigured;
UpdateType updateType;
quint16 clusterId;
quint16 attributeId;
quint16 minInterval;
quint16 maxInterval;
quint8 zclSeqNum; // sequence number for configure reporting
deCONZ::NumericUnion value;
};

Expand Down

0 comments on commit a650d37

Please sign in to comment.