Implement scene cluster

Author: ThatMishakov

makefiles/src.mk

@@ -19,6 +19,7 @@ $(BUILD_PATH)/$(SRC_DIR)/zigbee/basic_cluster.o \
 $(BUILD_PATH)/$(SRC_DIR)/zigbee/group_cluster.o \
 $(BUILD_PATH)/$(SRC_DIR)/zigbee/switch_cluster.o \
 $(BUILD_PATH)/$(SRC_DIR)/zigbee/relay_cluster.o \
+$(BUILD_PATH)/$(SRC_DIR)/zigbee/scene_cluster.o \
 $(BUILD_PATH)/$(SRC_DIR)/zigbee/endpoint.o \
 $(BUILD_PATH)/$(SRC_DIR)/zigbee/bdb_callbacks.o \
 $(BUILD_PATH)/$(SRC_DIR)/zigbee/general.o \

src/app_cfg.h

@@ -87,6 +87,7 @@ extern "C" {
 //#define ZCL_IAS_ZONE_SUPPORT			    1
 #define ZCL_POLL_CTRL_SUPPORT     0
 #define ZCL_GROUP_SUPPORT         1
+#define ZCL_SCENE_SUPPORT         1
 #define ZCL_OTA_SUPPORT           1
 #define TOUCHLINK_SUPPORT         0
 #define FIND_AND_BIND_SUPPORT     0

src/device_config/config_parser.c

@@ -3,6 +3,7 @@
 #include "zigbee/group_cluster.h"
 #include "zigbee/relay_cluster.h"
 #include "zigbee/switch_cluster.h"
+#include "zigbee/scene_cluster.h"
 #include "zigbee/general.h"
 #include "ota.h"
 
@@ -43,6 +44,10 @@ u8 switch_clusters_cnt = 0;
 zigbee_relay_cluster relay_clusters[4];
 u8 relay_clusters_cnt = 0;
 
+// Each relay cluster should have one scene cluster
+zigbee_scene_cluster scene_clusters[4];
+#define relay_clusters_cnt switch_clusters_cnt
+
 zigbee_endpoint endpoints[10];
 
 
@@ -234,9 +239,14 @@ void parse_config()
   }
   for (int index = 0; index < relay_clusters_cnt; index++)
   {
+    relay_clusters[index].scene_cluster = scene_clusters + index;
+    scene_clusters[index].relay_cluster = relay_clusters + index;
+
     relay_cluster_add_to_endpoint(&relay_clusters[index], &endpoints[switch_clusters_cnt + index]);
     // Group cluster is stateless, safe to add to multiple endpoints
     group_cluster_add_to_endpoint(&group_cluster, &endpoints[switch_clusters_cnt + index]);
+
+    scene_cluster_add_to_endpoint(scene_clusters + index, &endpoints[switch_clusters_cnt + index]);
   }
 
   for (int index = 0; index < total_endpoints; index++)

src/zigbee/relay_cluster.c

@@ -7,7 +7,7 @@
 #include "custom_zcl/zcl_onoff_indicator.h"
 #include "base_components/millis.h"
 
-
+#include "scene_cluster.h"
 
 status_t relay_cluster_callback(zigbee_relay_cluster *cluster, zclIncomingAddrInfo_t *pAddrInfo, u8 cmdId, void *cmdPayload);
 status_t relay_cluster_callback_trampoline(zclIncomingAddrInfo_t *pAddrInfo, u8 cmdId, void *cmdPayload);
@@ -90,12 +90,13 @@ void relay_cluster_add_to_endpoint(zigbee_relay_cluster *cluster, zigbee_endpoin
 
   // Identify stuff
   SETUP_ATTR_FOR_TABLE(cluster->identify_attr_infos, 0, ZCL_ATTRID_IDENTIFY_TIME, ZCL_DATA_TYPE_UINT16, ACCESS_CONTROL_READ | ACCESS_CONTROL_WRITE, cluster->identify_time);
+  SETUP_ATTR_FOR_TABLE(cluster->identify_attr_infos, 1, ZCL_ATTRID_GLOBAL_CLUSTER_REVISION, ZCL_DATA_TYPE_UINT16, ACCESS_CONTROL_READ, zcl_attr_global_clusterRevision);
 
   zigbee_endpoint_add_cluster(endpoint, 1, ZCL_CLUSTER_GEN_IDENTIFY);
   info = zigbee_endpoint_reserve_info(endpoint);
   info->clusterId = ZCL_CLUSTER_GEN_IDENTIFY;
   info->manuCode  = MANUFACTURER_CODE_NONE;
-  info->attrNum   = 1;
+  info->attrNum   = 2;
   info->attrTbl   = cluster->identify_attr_infos;
   info->clusterRegisterFunc = zcl_identify_register;
   info->clusterAppCb        = identify_cluster_callback_trampoline;
@@ -258,11 +259,16 @@ void relay_cluster_restore_relay_state(zigbee_relay_cluster *cluster)
   }
 }
 
-static void relay_cluster_set_on_off(zigbee_relay_cluster *cluster, enum relay_state state)
+void relay_cluster_set_on_off(zigbee_relay_cluster *cluster, enum relay_state state, bool from_scene)
 {
   bool on = state == RELAY_ON ? true : false;
   cluster->on_off = on;
 
+  if (cluster->scene_cluster && !from_scene)
+  {
+    cluster->scene_cluster->scene_valid = false;
+  }
+
   if (relay_cluster_control_phys_relay(cluster))
   {
     if (on)
@@ -287,15 +293,15 @@ void relay_cluster_on(zigbee_relay_cluster *cluster)
     cluster->off_wait_time = 0;
   }
 
-  relay_cluster_set_on_off(cluster, RELAY_ON);
+  relay_cluster_set_on_off(cluster, RELAY_ON, false);
 }
 
 void relay_cluster_off(zigbee_relay_cluster *cluster)
 {
   cluster->on_wait_time = 0;
   cluster->on_off_count_from = millis();
 
-  relay_cluster_set_on_off(cluster, RELAY_OFF);
+  relay_cluster_set_on_off(cluster, RELAY_OFF, false);
 }
 
 void relay_cluster_toggle(zigbee_relay_cluster *cluster)
@@ -342,7 +348,7 @@ void relay_cluster_on_with_timed_off(zigbee_relay_cluster *cluster, zcl_onoffCtr
 
   if (!cluster_on)
   {
-    relay_cluster_set_on_off(cluster, RELAY_ON);
+    relay_cluster_set_on_off(cluster, RELAY_ON, false);
   }
 }
 

src/zigbee/relay_cluster.h

@@ -20,7 +20,7 @@ enum relay_state {
   RELAY_ON = 1,
 };
 
-typedef struct
+typedef struct zigbee_relay_cluster
 {
   u8            relay_idx;
   u8            endpoint;
@@ -42,10 +42,12 @@ typedef struct
   u16 toggles_left;
 
   u16           identify_time;
-  zclAttrInfo_t identify_attr_infos[1];
+  zclAttrInfo_t identify_attr_infos[2];
 
   bool on_off;
   bool indicator_led_on;
+
+  struct zigbee_scene_cluster *scene_cluster;
 } zigbee_relay_cluster;
 
 void relay_cluster_add_to_endpoint(zigbee_relay_cluster *cluster, zigbee_endpoint *endpoint);
@@ -65,4 +67,7 @@ void gen_identify_callback_attr_write_trampoline(u8 clusterId, zclWriteCmd_t *pW
 bool relay_cluster_is_on(zigbee_relay_cluster *cluster);
 bool relay_cluster_is_identifying(zigbee_relay_cluster *cluster);
 
+bool relay_cluster_get_on_off(zigbee_relay_cluster *cluster);
+void relay_cluster_set_on_off(zigbee_relay_cluster *cluster, bool new_state, bool from_scene);
+
 #endif

src/zigbee/scene_cluster.c

@@ -0,0 +1,101 @@
+#include "scene_cluster.h"
+#include "relay_cluster.h"
+#include "cluster_common.h"
+
+zigbee_scene_cluster *scene_cluster_by_endpoint[10] = {};
+
+static void store_scene(zcl_sceneEntry_t *scene_entry, zigbee_scene_cluster *cluster);
+static void recall_scene(zcl_sceneEntry_t *scene_entry, zigbee_scene_cluster *cluster);
+
+static const u8 scene_name_support = 0x01;
+
+void scene_cluster_add_to_endpoint(zigbee_scene_cluster *cluster, zigbee_endpoint *endpoint)
+{
+    SETUP_ATTR(0, ZCL_ATTRID_SCENE_SCENE_COUNT, ZCL_DATA_TYPE_UINT8, ACCESS_CONTROL_READ, cluster->scene_count);
+    SETUP_ATTR(1, ZCL_ATTRID_SCENE_CURRENT_SCENE, ZCL_DATA_TYPE_UINT8, ACCESS_CONTROL_READ, cluster->current_scene);
+    SETUP_ATTR(2, ZCL_ATTRID_SCENE_CURRENT_GROUP, ZCL_DATA_TYPE_UINT16, ACCESS_CONTROL_READ, cluster->current_group);
+    SETUP_ATTR(3, ZCL_ATTRID_SCENE_SCENE_VALID, ZCL_DATA_TYPE_BOOLEAN, ACCESS_CONTROL_READ, cluster->scene_valid);
+    SETUP_ATTR(4, ZCL_ATTRID_SCENE_NAME_SUPPORT, ZCL_DATA_TYPE_BITMAP8, ACCESS_CONTROL_READ, scene_name_support);
+    SETUP_ATTR(5, ZCL_ATTRID_SCENE_LAST_CONFIG_BY, ZCL_DATA_TYPE_IEEE_ADDR, ACCESS_CONTROL_READ, cluster->last_configured_by);
+    SETUP_ATTR(6, ZCL_ATTRID_GLOBAL_CLUSTER_REVISION, ZCL_DATA_TYPE_UINT16, ACCESS_CONTROL_READ, zcl_attr_global_clusterRevision);
+
+    zigbee_endpoint_add_cluster(endpoint, 1, ZCL_CLUSTER_GEN_SCENES);
+    zcl_specClusterInfo_t *info = zigbee_endpoint_reserve_info(endpoint);
+    info->clusterId = ZCL_CLUSTER_GEN_SCENES;
+    info->manuCode = MANUFACTURER_CODE_NONE;
+    info->attrNum = SCENE_CLUSTER_ATTR_NUM;
+    info->attrTbl = cluster->attr_infos;
+    info->clusterRegisterFunc = zcl_scene_register;
+    info->clusterAppCb = scene_cluster_callback;
+}
+
+status_t scene_cluster_callback(zclIncomingAddrInfo_t *pAddrInfo, u8 cmdId, void *cmdPayload)
+{
+    zigbee_scene_cluster *cluster = scene_cluster_by_endpoint[pAddrInfo->dstEp];
+
+    status_t status = ZCL_STA_SUCCESS;
+
+    if (pAddrInfo->dirCluster == ZCL_FRAME_CLIENT_SERVER_DIR)
+    {
+        switch (cmdId)
+        {
+        case ZCL_CMD_SCENE_STORE_SCENE:
+            store_scene(cmdPayload, cluster);
+            break;
+        case ZCL_CMD_SCENE_RECALL_SCENE:
+            recall_scene(cmdPayload, cluster);
+            break;
+        default:
+            break;
+        }
+    }
+    else
+    {
+        status = ZCL_STA_UNSUP_CLUSTER_COMMAND;
+    }
+
+    return status;
+}
+
+static void recall_scene(zcl_sceneEntry_t *scene_entry, zigbee_scene_cluster *cluster)
+{
+    u8 *pData = scene_entry->extField;
+    u16 clusterID = 0xFFFF;
+    u8 extLen = 0;
+
+    while (pData < scene_entry->extField + scene_entry->extFieldLen) {
+        clusterID = BUILD_U16(pData[0], pData[1]);
+        pData += 2;//cluster id
+
+        extLen = *pData++;//length
+
+        if (clusterID == ZCL_CLUSTER_GEN_ON_OFF && cluster->relay_cluster) {
+            if (extLen >= 1) {
+                u8 onOff = *pData++;
+
+                relay_cluster_set_on_off(cluster->relay_cluster, onOff, true);
+                extLen--;
+            }
+        }
+
+        pData += extLen;
+    }
+}
+
+static void store_scene(zcl_sceneEntry_t *scene_entry, zigbee_scene_cluster *cluster)
+{
+    u8 extLen = 0;
+
+    if (cluster->relay_cluster) {
+        bool on_off = cluster->relay_cluster->on_off;
+
+        scene_entry->extField[extLen++] = LO_UINT16(ZCL_CLUSTER_GEN_ON_OFF);
+        scene_entry->extField[extLen++] = HI_UINT16(ZCL_CLUSTER_GEN_ON_OFF);
+        scene_entry->extField[extLen++] = sizeof(u8);
+        scene_entry->extField[extLen++] = on_off;
+    }
+
+    // Add other clusters to save here...
+
+    scene_entry->extFieldLen = extLen;
+}

src/zigbee/scene_cluster.h

@@ -0,0 +1,28 @@
+#ifndef _SCENE_CLUSTER_H_
+#define _SCENE_CLUSTER_H_
+
+#include "tl_common.h"
+#include "zb_common.h"
+#include "zcl_include.h"
+#include "endpoint.h"
+
+#define SCENE_CLUSTER_ATTR_NUM 7
+
+typedef struct zigbee_scene_cluster
+{
+    u8 scene_count;
+    u8 current_scene;
+    u16 current_group;
+    bool scene_valid;
+    addrExt_t last_configured_by;
+
+    struct zigbee_relay_cluster *relay_cluster;
+
+    zclAttrInfo_t attr_infos[SCENE_CLUSTER_ATTR_NUM];
+} zigbee_scene_cluster;
+
+void scene_cluster_add_to_endpoint(zigbee_scene_cluster *cluster, zigbee_endpoint *endpoint);
+
+status_t scene_cluster_callback(zclIncomingAddrInfo_t *pAddrInfo, u8 cmdId, void *cmdPayload);
+
+#endif