Z-Stack Manufacturer Specific Clusters

Hi Yikay,

Thanks for answering, but unfortunately this is too vague to be useful. Maybe you can be a little more specific.

Of course, I've defined some cluster ID's and Attribute ID's in header files (not zcl.h, but my app headers).

Now, which callback functions are 'related' to what, and how are they called at all by only adding a few #define's in a header file?

And, how is the manufacturer specific bit in the ZCL Header going to be set? How is the manufacturer code in the header going to be matched (as you know, no match = error).

How is this mfg specific cluster going to show up in the Simple Descriptor?

Anyway, it seems that Z-Stack unfortunately does not support this, looking in zcl.c in the zcl_ProcessMessageMSG function, there's

if ( inMsg.hdr.fc.manuSpecific )
    {
      // We don't support any manufacturer specific command
      status = ZCL_STATUS_UNSUP_MANU_GENERAL_COMMAND;

Well. That's clear, thanks but no thanks, Z-Stack... It seems I'm going to have to add this basic Zigbee feature myself then?

EDIT:

Looking deeper into Z-Stack, the MFS feature seems to be almost-finished. That means it has been quite easy to fix:

What needs to be done in the first place is to add logic in zcl_ProcessMessageMSG:

  // Is this a foundation type message
  if ( !interPanMsg && zcl_ProfileCmd( inMsg.hdr.fc.type ) )
  {
    // Do support Manufacturer Specific frames (sdk 20140812)
    if  ( ( ( inMsg.hdr.fc.manuSpecific ) && ( inMsg.hdr.manuCode != MANUFACTURER_ID_CODE ) ) ||
            ( !inMsg.hdr.fc.manuSpecific && (pkt->clusterId >= ZCL_MFS_CLUSTER_START_ID) ) )
    {
      status = ZCL_STATUS_UNSUP_MANU_GENERAL_COMMAND;
    }
    else if ( ( inMsg.hdr.commandID <= ZCL_CMD_MAX ) &&
              ( zclCmdTable[inMsg.hdr.commandID].pfnParseInProfile != NULL ) )

and

  else  // Not a foundation type message, so it must be specific to the cluster ID.
  {
    // Do support Manufacturer Specific frames (sdk 20140812)
    if  ( ( ( inMsg.hdr.fc.manuSpecific ) && ( inMsg.hdr.manuCode != MANUFACTURER_ID_CODE ) ) ||
            ( !inMsg.hdr.fc.manuSpecific && (pkt->clusterId >= ZCL_MFS_CLUSTER_START_ID) ) )
    {
      status = ZCL_STATUS_UNSUP_MANU_CLUSTER_COMMAND;
    }
    else if ( pInPlugin && pInPlugin->pfnIncomingHdlr )

and a few lines later:

    if ( status == ZFailure )
    {
/*
      // Unsupported message
      if ( inMsg.hdr.fc.manuSpecific )
      {
        status = ZCL_STATUS_UNSUP_MANU_CLUSTER_COMMAND;
      }
      else */ // Do support Manufacturer Specific frames (sdk 20140812)
      {
        status = ZCL_STATUS_UNSUP_CLUSTER_COMMAND;
      }

This is the basic logic. For this example I choose not to get too tied up in the exception-upon-exception way that ZIgbee specification is defined, so just define ZCL_MFS_CLUSTER_START_ID as 0xFC00 (spec. table 2.13) and forgo the ability to re-define existing cluster ID's as manufacturer specific in private profiles.

Now looking at static CONST zclCmdItems_t zclCmdTable[] there are a lot of functions defined, we're interested in the Responses. All of them need changing, I'll just highlight one of them, zclProcessInReadCmd.

This function calls zcl_SendReadRsp which needs an extra parameter:

ZStatus_t zcl_SendReadRsp( uint8 srcEP, afAddrType_t *dstAddr,
                           uint16 clusterID, zclReadRspCmd_t *readRspCmd,
                           uint8 direction, uint8 disableDefaultRsp, uint8 seqNum, uint16 manuCode )

and it needs to pass it at the end of the function:

    status = zcl_SendCommand( srcEP, dstAddr, clusterID, ZCL_CMD_READ_RSP, FALSE,
                              direction, disableDefaultRsp, manuCode, seqNum, len, buf );
    zcl_mem_free( buf );
  }

the manuCode parameter was simply 0 before. Back to zclProcessInReadCmd, at the end:

  // Build and send Read Response command
  zcl_SendReadRsp( pInMsg->msg->endPoint, &(pInMsg->msg->srcAddr), pInMsg->msg->clusterId,
                   readRspCmd, !pInMsg->hdr.fc.direction,
                   true, pInMsg->hdr.transSeqNum, pInMsg->hdr.manuCode );
  zcl_mem_free( readRspCmd );

And so on for all the other functions. If you also want to send to manufacturer specific clusters from the device, the commands need to be changed as well. There's also a macro in zcl.h, zcl_DefaultRspCmd where I've removed the manuSpec checking part. Doesn't look like that's required.

You can now add manufacturer specific clusters to the big CONST zclAttrRec_t zllApp_Attrs[APP_NUM_ATTRIBUTES] in your application and everything else is handled automatically. Just make sure that cluster ID is 0xFC00 - 0xFFFF.

Sjef.