Add support for LTNE (Local Temperature Not Exposed) feature in Therm… (#26686)

huangzh142 · restyled-commits · pull[bot] · commit 64c10291edea · 2023-09-05T16:49:17.000Z
* Add support for LTNE (Local Temperature Not Exposed) feature in Thermostat Cluster

* Restyled by clang-format

* Tidy up code and use error-mapping function

* Restyled by clang-format

* Tidy up code and add some comments

* Restyled by clang-format

---------

Co-authored-by: Restyled.io &lt;commits@restyled.io&gt;
diff --git a/examples/all-clusters-app/all-clusters-common/all-clusters-app.matter b/examples/all-clusters-app/all-clusters-common/all-clusters-app.matter
@@ -3203,6 +3203,7 @@ server cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter b/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter
@@ -2725,6 +2725,7 @@ server cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/examples/chef/devices/rootnode_heatingcoolingunit_ncdGai1E5a.matter b/examples/chef/devices/rootnode_heatingcoolingunit_ncdGai1E5a.matter
@@ -1389,6 +1389,7 @@ client cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/examples/chef/devices/rootnode_thermostat_bm3fb8dhYi.matter b/examples/chef/devices/rootnode_thermostat_bm3fb8dhYi.matter
@@ -1246,6 +1246,7 @@ server cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/examples/placeholder/linux/apps/app1/config.matter b/examples/placeholder/linux/apps/app1/config.matter
@@ -2476,6 +2476,7 @@ server cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/examples/placeholder/linux/apps/app2/config.matter b/examples/placeholder/linux/apps/app2/config.matter
@@ -2437,6 +2437,7 @@ server cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/examples/thermostat/thermostat-common/thermostat.matter b/examples/thermostat/thermostat-common/thermostat.matter
@@ -1676,6 +1676,7 @@ server cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/src/app/clusters/thermostat-server/thermostat-server.cpp b/src/app/clusters/thermostat-server/thermostat-server.cpp
@@ -31,9 +31,13 @@
 #include <lib/core/CHIPEncoding.h>
 
 using namespace chip;
+using namespace chip::app;
+using namespace chip::app::Clusters;
 using namespace chip::app::Clusters::Thermostat;
 using namespace chip::app::Clusters::Thermostat::Attributes;
 
+using imcode = Protocols::InteractionModel::Status;
+
 constexpr int16_t kDefaultAbsMinHeatSetpointLimit = 700;  // 7C (44.5 F) is the default
 constexpr int16_t kDefaultAbsMaxHeatSetpointLimit = 3000; // 30C (86 F) is the default
 constexpr int16_t kDefaultMinHeatSetpointLimit    = 700;  // 7C (44.5 F) is the default
@@ -62,6 +66,90 @@ constexpr int8_t kDefaultDeadBand                 = 25; // 2.5C is the default
 
 #define FEATURE_MAP_DEFAULT FEATURE_MAP_HEAT | FEATURE_MAP_COOL | FEATURE_MAP_AUTO
 
+namespace {
+
+class ThermostatAttrAccess : public AttributeAccessInterface
+{
+public:
+    ThermostatAttrAccess() : AttributeAccessInterface(Optional<EndpointId>::Missing(), Thermostat::Id) {}
+
+    CHIP_ERROR Read(const ConcreteReadAttributePath & aPath, AttributeValueEncoder & aEncoder) override;
+    CHIP_ERROR Write(const ConcreteDataAttributePath & aPath, AttributeValueDecoder & aDecoder) override;
+};
+
+ThermostatAttrAccess gThermostatAttrAccess;
+
+CHIP_ERROR ThermostatAttrAccess::Read(const ConcreteReadAttributePath & aPath, AttributeValueEncoder & aEncoder)
+{
+    VerifyOrDie(aPath.mClusterId == Thermostat::Id);
+
+    uint32_t ourFeatureMap;
+    bool localTemperatureNotExposedSupported = (FeatureMap::Get(aPath.mEndpointId, &ourFeatureMap) == EMBER_ZCL_STATUS_SUCCESS) &&
+        ((ourFeatureMap & to_underlying(Feature::kLocalTemperatureNotExposed)) != 0);
+
+    switch (aPath.mAttributeId)
+    {
+    case LocalTemperature::Id:
+        if (localTemperatureNotExposedSupported)
+        {
+            return aEncoder.EncodeNull();
+        }
+        break;
+    case RemoteSensing::Id:
+        if (localTemperatureNotExposedSupported)
+        {
+            uint8_t valueRemoteSensing;
+            EmberAfStatus status = RemoteSensing::Get(aPath.mEndpointId, &valueRemoteSensing);
+            if (status != EMBER_ZCL_STATUS_SUCCESS)
+            {
+                StatusIB statusIB(ToInteractionModelStatus(status));
+                return statusIB.ToChipError();
+            }
+            valueRemoteSensing &= 0xFE; // clear bit 1 (LocalTemperature RemoteSensing bit)
+            return aEncoder.Encode(valueRemoteSensing);
+        }
+        break;
+    default: // return CHIP_NO_ERROR and just read from the attribute store in default
+        break;
+    }
+
+    return CHIP_NO_ERROR;
+}
+
+CHIP_ERROR ThermostatAttrAccess::Write(const ConcreteDataAttributePath & aPath, AttributeValueDecoder & aDecoder)
+{
+    VerifyOrDie(aPath.mClusterId == Thermostat::Id);
+
+    uint32_t ourFeatureMap;
+    bool localTemperatureNotExposedSupported = (FeatureMap::Get(aPath.mEndpointId, &ourFeatureMap) == EMBER_ZCL_STATUS_SUCCESS) &&
+        ((ourFeatureMap & to_underlying(Feature::kLocalTemperatureNotExposed)) != 0);
+
+    switch (aPath.mAttributeId)
+    {
+    case RemoteSensing::Id:
+        if (localTemperatureNotExposedSupported)
+        {
+            uint8_t valueRemoteSensing;
+            ReturnErrorOnFailure(aDecoder.Decode(valueRemoteSensing));
+            if (valueRemoteSensing & 0x01) // If setting bit 1 (LocalTemperature RemoteSensing bit)
+            {
+                return CHIP_IM_GLOBAL_STATUS(ConstraintError);
+            }
+
+            EmberAfStatus status = RemoteSensing::Set(aPath.mEndpointId, valueRemoteSensing);
+            StatusIB statusIB(ToInteractionModelStatus(status));
+            return statusIB.ToChipError();
+        }
+        break;
+    default: // return CHIP_NO_ERROR and just write to the attribute store in default
+        break;
+    }
+
+    return CHIP_NO_ERROR;
+}
+
+} // anonymous namespace
+
 void emberAfThermostatClusterServerInitCallback(chip::EndpointId endpoint)
 {
     // TODO
@@ -78,8 +166,6 @@ void emberAfThermostatClusterServerInitCallback(chip::EndpointId endpoint)
     // or should this just be the responsibility of the thermostat application?
 }
 
-using imcode = Protocols::InteractionModel::Status;
-
 Protocols::InteractionModel::Status
 MatterThermostatClusterServerPreAttributeChangedCallback(const app::ConcreteAttributePath & attributePath,
                                                          EmberAfAttributeType attributeType, uint16_t size, uint8_t * value)
@@ -754,4 +840,7 @@ bool emberAfThermostatClusterSetpointRaiseLowerCallback(app::CommandHandler * co
     return true;
 }
 
-void MatterThermostatPluginServerInitCallback() {}
+void MatterThermostatPluginServerInitCallback()
+{
+    registerAttributeAccessOverride(&gThermostatAttrAccess);
+}
diff --git a/src/app/zap-templates/zcl/data-model/chip/thermostat-cluster.xml b/src/app/zap-templates/zcl/data-model/chip/thermostat-cluster.xml
@@ -25,6 +25,7 @@ limitations under the License.
     <field name="ScheduleConfiguration" mask="0x8"/>
     <field name="Setback" mask="0x10"/>
     <field name="AutoMode" mask="0x20"/>
+    <field name="LocalTemperatureNotExposed" mask="0x40"/>
   </bitmap>
 
   <bitmap name="DayOfWeek" type="BITMAP8">
diff --git a/src/controller/data_model/controller-clusters.matter b/src/controller/data_model/controller-clusters.matter
@@ -4341,6 +4341,7 @@ client cluster Thermostat = 513 {
     kScheduleConfiguration = 0x8;
     kSetback = 0x10;
     kAutoMode = 0x20;
+    kLocalTemperatureNotExposed = 0x40;
   }
 
   bitmap ModeForSequence : BITMAP8 {
diff --git a/src/controller/python/chip/clusters/Objects.py b/src/controller/python/chip/clusters/Objects.py
diff --git a/src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.h b/src/darwin/Framework/CHIP/zap-generated/MTRBaseClusters.h
diff --git a/zzz_generated/app-common/app-common/zap-generated/cluster-enums.h b/zzz_generated/app-common/app-common/zap-generated/cluster-enums.h

Original file line number	Diff line number	Diff line change
`@@ -3203,6 +3203,7 @@ server cluster Thermostat = 513 {`
`3203`	`3203`	`kScheduleConfiguration = 0x8;`
`3204`	`3204`	`kSetback = 0x10;`
`3205`	`3205`	`kAutoMode = 0x20;`
	`3206`	`+ kLocalTemperatureNotExposed = 0x40;`
`3206`	`3207`	`}`
`3207`	`3208`
`3208`	`3209`	`bitmap ModeForSequence : BITMAP8 {`
Original file line number	Diff line number	Diff line change
`@@ -2725,6 +2725,7 @@ server cluster Thermostat = 513 {`
`2725`	`2725`	`kScheduleConfiguration = 0x8;`
`2726`	`2726`	`kSetback = 0x10;`
`2727`	`2727`	`kAutoMode = 0x20;`
	`2728`	`+ kLocalTemperatureNotExposed = 0x40;`
`2728`	`2729`	`}`
`2729`	`2730`
`2730`	`2731`	`bitmap ModeForSequence : BITMAP8 {`
Original file line number	Diff line number	Diff line change
`@@ -1389,6 +1389,7 @@ client cluster Thermostat = 513 {`
`1389`	`1389`	`kScheduleConfiguration = 0x8;`
`1390`	`1390`	`kSetback = 0x10;`
`1391`	`1391`	`kAutoMode = 0x20;`
	`1392`	`+ kLocalTemperatureNotExposed = 0x40;`
`1392`	`1393`	`}`
`1393`	`1394`
`1394`	`1395`	`bitmap ModeForSequence : BITMAP8 {`
Original file line number	Diff line number	Diff line change
`@@ -1246,6 +1246,7 @@ server cluster Thermostat = 513 {`
`1246`	`1246`	`kScheduleConfiguration = 0x8;`
`1247`	`1247`	`kSetback = 0x10;`
`1248`	`1248`	`kAutoMode = 0x20;`
	`1249`	`+ kLocalTemperatureNotExposed = 0x40;`
`1249`	`1250`	`}`
`1250`	`1251`
`1251`	`1252`	`bitmap ModeForSequence : BITMAP8 {`
Original file line number	Diff line number	Diff line change
`@@ -2476,6 +2476,7 @@ server cluster Thermostat = 513 {`
`2476`	`2476`	`kScheduleConfiguration = 0x8;`
`2477`	`2477`	`kSetback = 0x10;`
`2478`	`2478`	`kAutoMode = 0x20;`
	`2479`	`+ kLocalTemperatureNotExposed = 0x40;`
`2479`	`2480`	`}`
`2480`	`2481`
`2481`	`2482`	`bitmap ModeForSequence : BITMAP8 {`
Original file line number	Diff line number	Diff line change
`@@ -2437,6 +2437,7 @@ server cluster Thermostat = 513 {`
`2437`	`2437`	`kScheduleConfiguration = 0x8;`
`2438`	`2438`	`kSetback = 0x10;`
`2439`	`2439`	`kAutoMode = 0x20;`
	`2440`	`+ kLocalTemperatureNotExposed = 0x40;`
`2440`	`2441`	`}`
`2441`	`2442`
`2442`	`2443`	`bitmap ModeForSequence : BITMAP8 {`
Original file line number	Diff line number	Diff line change
`@@ -1676,6 +1676,7 @@ server cluster Thermostat = 513 {`
`1676`	`1676`	`kScheduleConfiguration = 0x8;`
`1677`	`1677`	`kSetback = 0x10;`
`1678`	`1678`	`kAutoMode = 0x20;`
	`1679`	`+ kLocalTemperatureNotExposed = 0x40;`
`1679`	`1680`	`}`
`1680`	`1681`
`1681`	`1682`	`bitmap ModeForSequence : BITMAP8 {`
Original file line number	Diff line number	Diff line change
`@@ -4341,6 +4341,7 @@ client cluster Thermostat = 513 {`
`4341`	`4341`	`kScheduleConfiguration = 0x8;`
`4342`	`4342`	`kSetback = 0x10;`
`4343`	`4343`	`kAutoMode = 0x20;`
	`4344`	`+ kLocalTemperatureNotExposed = 0x40;`
`4344`	`4345`	`}`
`4345`	`4346`
`4346`	`4347`	`bitmap ModeForSequence : BITMAP8 {`