GH-33: Thermostat Fan Control Mode CC

Forwarded: #33
Bug-SiliconLabs: UIC-3061
Bug-Github: #33

Author: silabs-borisl

applications/zpc/components/zpc_attribute_store/include/attribute_store_defined_attribute_types.h

@@ -692,6 +692,20 @@ DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_SETPOINT_MAX_VALUE_SCALE,
                  ((COMMAND_CLASS_THERMOSTAT_SETPOINT << 8) | 0x09))
 
 /////////////////////////////////////////////////
+// Thermostat Fan Mode Command Class
+/// zwave_cc_version_t
+DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_VERSION,
+                 ZWAVE_CC_VERSION_ATTRIBUTE(COMMAND_CLASS_THERMOSTAT_FAN_MODE))
+/// Current Fan mode
+DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_CURRENT_MODE,
+                 ((COMMAND_CLASS_THERMOSTAT_FAN_MODE << 8) | 0x02))
+/// Supported Fans modes
+DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_SUPPORTED_MODES,
+                 ((COMMAND_CLASS_THERMOSTAT_FAN_MODE << 8) | 0x03))
+/// Off flag (v2+)
+DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_OFF_FLAG,
+                 ((COMMAND_CLASS_THERMOSTAT_FAN_MODE << 8) | 0x05))
+/////////////////////////////////////////////////
 // Wakeup command class
 DEFINE_ATTRIBUTE(ATTRIBUTE_COMMAND_CLASS_WAKE_UP_VERSION,
                  ZWAVE_CC_VERSION_ATTRIBUTE(COMMAND_CLASS_WAKE_UP_V2))

applications/zpc/components/zpc_attribute_store/include/command_class_types/zwave_command_class_thermostat_fan_types.h

@@ -0,0 +1,56 @@
+/******************************************************************************
+ * # License
+ * <b>Copyright 2023 Silicon Laboratories Inc. www.silabs.com</b>
+ ******************************************************************************
+ * The licensor of this software is Silicon Laboratories Inc. Your use of this
+ * software is governed by the terms of Silicon Labs Master Software License
+ * Agreement (MSLA) available at
+ * www.silabs.com/about-us/legal/master-software-license-agreement. This
+ * software is distributed to you in Source Code format and is governed by the
+ * sections of the MSLA applicable to Source Code.
+ *
+ *****************************************************************************/
+
+/**
+ * @defgroup zpc_attribute_store_command_classes_types Type definitions for attribute storage of Command Classes
+ * @ingroup zpc_attribute_store
+ * @brief Type definitions for Command Classes, used for @ref attribute_store storage.
+ *
+ */
+
+/**
+ * @defgroup zwave_command_class_thermostat_fan_mode_types Type definitions for attribute storage of the Sound Switch Command Class
+ * @ingroup zpc_attribute_store_command_classes_types
+ * @brief Type definitions for the Sound Switch Command Class.
+ *
+ * @{
+ */
+
+#ifndef ZWAVE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_TYPES_H
+#define ZWAVE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_TYPES_H
+
+#include <stdint.h>
+
+
+// Fan Mode CC
+///> Off flag (version >= 2). uint8_t
+typedef uint8_t thermostat_fan_mode_off_flag_t;
+///> Fan mode. uint8_t
+typedef uint8_t thermostat_fan_mode_t;
+///> Supported mode bitmask. uint32_t
+typedef uint32_t thermostat_fan_supported_modes_t;
+
+// Fan State CC
+///> Fan state. uint8_t
+typedef uint8_t thermostat_fan_state_t;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif  //ZWAVE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_TYPES_H
+/** @} end zwave_command_class_thermostat_fan_mode_types */

applications/zpc/components/zpc_attribute_store/src/zpc_attribute_store_type_registration.cpp

@@ -302,6 +302,17 @@ static const std::vector<attribute_schema_t> attribute_schema = {
   {ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_SETPOINT_MIN_VALUE_SCALE,   "Min Value Scale",   ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_SETPOINT_TYPE,   U32_STORAGE_TYPE},
   {ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_SETPOINT_MAX_VALUE,   "Max Value",   ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_SETPOINT_TYPE,   I32_STORAGE_TYPE},
   {ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_SETPOINT_MAX_VALUE_SCALE,   "Max Value Scale",   ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_SETPOINT_TYPE,   U32_STORAGE_TYPE},
+
+
+  /////////////////////////////////////////////////////////////////////
+  //         Thermostat Fan Mode Command Class attributes
+  /////////////////////////////////////////////////////////////////////
+  {ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_VERSION,   "Thermostat Fan Mode Version",   ATTRIBUTE_ENDPOINT_ID,   U8_STORAGE_TYPE},
+  {ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_CURRENT_MODE,   "Thermostat Current Fan Mode",   ATTRIBUTE_ENDPOINT_ID,   U8_STORAGE_TYPE},
+  // We use u32 since it store some 8bit mask. This should be resilient to future version of Thermostat Fan Mode
+  {ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_SUPPORTED_MODES,  "Thermostat Supported Fan Mode Bitmask",   ATTRIBUTE_ENDPOINT_ID,   U32_STORAGE_TYPE},
+  {ATTRIBUTE_COMMAND_CLASS_THERMOSTAT_FAN_MODE_OFF_FLAG, "Thermostat Fan Off Flag",   ATTRIBUTE_ENDPOINT_ID,   U8_STORAGE_TYPE },
+
   /////////////////////////////////////////////////////////////////////
   //         Supervision Command Class attributes
   /////////////////////////////////////////////////////////////////////

applications/zpc/components/zwave_command_classes/CMakeLists.txt

@@ -45,6 +45,7 @@ add_library(
   src/zwave_command_class_switch_color.c
   src/zwave_command_class_switch_multilevel.c
   src/zwave_command_class_thermostat_mode.c
+  src/zwave_command_class_thermostat_fan_mode.c
   src/zwave_command_class_thermostat_setpoint.c
   src/zwave_command_class_time.c
   src/zwave_command_class_user_code.c