Add complex type Date and using it in DayStruct

Author: Michail-Antropov

src/app/zap-templates/zcl/data-model/chip/chip-types.xml

@@ -64,7 +64,7 @@ limitations under the License.
     <type id="0xE7" description="Percentage units 0.01%"   name="percent100ths"     size="2"  analog="true"   />
 
     <type id="0xE0" description="Time of day"              name="tod"               size="4"  analog="true"   />
-    <type id="0xE1" description="Date"                     name="date"              size="4"  analog="true"   />
+    <!-- <type id="0xE1" description="Date"                     name="date"              size="4"  analog="true"   /> -->
     <type id="0xE3" description="Epoch Microseconds"       name="epoch_us"          size="8"  analog="true"   />
     <type id="0xE4" description="Epoch Seconds"            name="epoch_s"           size="4"  analog="true"   />
     <type id="0xE5" description="Posix Time Milliseconds"  name="posix_ms"          size="8"  analog="true"   />

src/app/zap-templates/zcl/data-model/chip/energy-calendar-cluster.xml

@@ -44,31 +44,31 @@ limitations under the License.
     <item name="High" value="0x03"/>
   </enum>
 
-  <struct name="PeakPeriodStruct">
+  <struct name="PeakPeriodStruct" apiMaturity="provisional">
     <cluster code="0x009A"/>
     <item fieldId="0" name="Severity" type="PeakPeriodSeverityEnum" min="0x00" max="0x03"/>
     <item fieldId="1" name="PeakPeriod" type="int16u" default="0"/>
     <item fieldId="2" name="StartTime" type="epoch_s" isNullable="true"/>
     <item fieldId="3" name="EndTime" type="epoch_s" isNullable="true"/>
   </struct>
 
-  <struct name="TransitionStruct">
+  <struct name="TransitionStruct" apiMaturity="provisional">
     <cluster code="0x009A"/>
     <item fieldId="0" name="TransitionTime" type="int16u" max="1499"/>
     <item fieldId="1" name="PriceTier" type="int32u" optional="true"/>
     <item fieldId="2" name="FriendlyCredit" type="boolean" optional="true"/>
     <item fieldId="3" name="AuxiliaryLoad" type="AuxiliaryLoadBitmap" optional="true" min="0x00" max="0xFF"/>
   </struct>
 
-  <struct name="DayStruct">
+  <struct name="DayStruct" apiMaturity="provisional">
     <cluster code="0x009A"/>
-    <item fieldId="0" name="Date" type="date" optional="true"/>
+    <item fieldId="0" name="Date" type="DateStruct" optional="true"/>
     <item fieldId="1" name="DaysOfWeek" type="TransitionDayOfWeekBitmap" optional="true" min="0x00" max="0x7F"/>
     <item fieldId="2" name="Transitions" type="TransitionStruct" array="true" length="48" minLength="1"/>
     <item fieldId="3" name="CalendarID" type="int32u" optional="true"/>
   </struct>
 
-  <struct name="CalendarPeriodStruct">
+  <struct name="CalendarPeriodStruct" apiMaturity="provisional">
     <cluster code="0x009A"/>
     <item fieldId="0" name="StartDate" type="epoch_s" isNullable="true"/>
     <item fieldId="1" name="Days" type="DayStruct" array="true" length="7" minLength="1"/>
@@ -84,16 +84,16 @@ limitations under the License.
     <description>The Energy Calendar Cluster provides a mechanism for communicating schedules associated with various forms of energy consumption.</description>
     <globalAttribute side="either" code="0xFFFD" value="3"/>
     <features>
-      <feature bit="0" code="PTIER" name="PricingTier" summary="Supports information about pricing tiers">
+      <feature apiMaturity="provisional" bit="0" code="PTIER" name="PricingTier" summary="Supports information about pricing tiers">
         <optionalConform choice="a" more="true" min="1"/>
       </feature>
-      <feature bit="1" code="FCRED" name="FriendlyCredit" summary="Supports information about when friendly credit periods begin and end">
+      <feature apiMaturity="provisional" bit="1" code="FCRED" name="FriendlyCredit" summary="Supports information about when friendly credit periods begin and end">
         <optionalConform choice="a" more="true" min="1"/>
       </feature>
-      <feature bit="2" code="AUXLD" name="AuxiliaryLoad" summary="Supports information about when auxiliary loads should be enabled or disabled">
+      <feature apiMaturity="provisional" bit="2" code="AUXLD" name="AuxiliaryLoad" summary="Supports information about when auxiliary loads should be enabled or disabled">
         <optionalConform choice="a" more="true" min="1"/>
       </feature>
-      <feature bit="3" code="PEAKP" name="PeakPeriod" summary="Supports information about peak periods">
+      <feature apiMaturity="provisional" bit="3" code="PEAKP" name="PeakPeriod" summary="Supports information about peak periods">
         <optionalConform/>
       </feature>
     </features>

src/app/zap-templates/zcl/data-model/chip/global-structs.xml

@@ -31,4 +31,14 @@ TODO: Make these structures global rather than defining them for each cluster.
     <item fieldId="1" name="FloorNumber"     type="int16s"                   isNullable="true"  optional="false"/>
     <item fieldId="2" name="AreaType"        type="AreaTypeTag"              isNullable="true"  optional="false"/>
   </struct>
+
+  <struct name="DateStruct">
+    <cluster code="0x009A"/> <!-- Energy Calendar  -->
+    <cluster code="0x0B06"/> <!-- Without this scripts/tools/zap_regen_all.py pushes global DateStruct to EnergyCalendar namespace   -->
+
+    <item fieldId="0" name="Year"      type="int8u"                  isNullable="true" optional="false"/>
+    <item fieldId="1" name="Month"     type="int8u" min="1" max="12" isNullable="true" optional="false"/>
+    <item fieldId="2" name="Day"       type="int8u" min="1" max="31" isNullable="true" optional="false"/>
+    <item fieldId="3" name="DayOfWeek" type="int8u" min="1" max="7"  isNullable="true" optional="false"/>
+  </struct>
 </configurator>

src/controller/data_model/controller-clusters.matter

@@ -5113,8 +5113,15 @@ cluster EnergyCalendar = 154 {
     optional AuxiliaryLoadBitmap auxiliaryLoad = 3;
   }
 
+  struct DateStruct {
+    nullable int8u year = 0;
+    nullable int8u month = 1;
+    nullable int8u day = 2;
+    nullable int8u dayOfWeek = 3;
+  }
+
   struct DayStruct {
-    optional date date = 0;
+    optional DateStruct date = 0;
     optional TransitionDayOfWeekBitmap daysOfWeek = 1;
     TransitionStruct transitions[] = 2;
     optional int32u calendarID = 3;

src/controller/java/generated/java/chip/devicecontroller/ChipStructs.java

@@ -8501,8 +8501,99 @@ public String toString() {
     return output.toString();
   }
 }
+public static class EnergyCalendarClusterDateStruct {
+  public @Nullable Integer year;
+  public @Nullable Integer month;
+  public @Nullable Integer day;
+  public @Nullable Integer dayOfWeek;
+  private static final long YEAR_ID = 0L;
+  private static final long MONTH_ID = 1L;
+  private static final long DAY_ID = 2L;
+  private static final long DAY_OF_WEEK_ID = 3L;
+
+  public EnergyCalendarClusterDateStruct(
+    @Nullable Integer year,
+    @Nullable Integer month,
+    @Nullable Integer day,
+    @Nullable Integer dayOfWeek
+  ) {
+    this.year = year;
+    this.month = month;
+    this.day = day;
+    this.dayOfWeek = dayOfWeek;
+  }
+
+  public StructType encodeTlv() {
+    ArrayList<StructElement> values = new ArrayList<>();
+    values.add(new StructElement(YEAR_ID, year != null ? new UIntType(year) : new NullType()));
+    values.add(new StructElement(MONTH_ID, month != null ? new UIntType(month) : new NullType()));
+    values.add(new StructElement(DAY_ID, day != null ? new UIntType(day) : new NullType()));
+    values.add(new StructElement(DAY_OF_WEEK_ID, dayOfWeek != null ? new UIntType(dayOfWeek) : new NullType()));
+
+    return new StructType(values);
+  }
+
+  public static EnergyCalendarClusterDateStruct decodeTlv(BaseTLVType tlvValue) {
+    if (tlvValue == null || tlvValue.type() != TLVType.Struct) {
+      return null;
+    }
+    @Nullable Integer year = null;
+    @Nullable Integer month = null;
+    @Nullable Integer day = null;
+    @Nullable Integer dayOfWeek = null;
+    for (StructElement element: ((StructType)tlvValue).value()) {
+      if (element.contextTagNum() == YEAR_ID) {
+        if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
+          UIntType castingValue = element.value(UIntType.class);
+          year = castingValue.value(Integer.class);
+        }
+      } else if (element.contextTagNum() == MONTH_ID) {
+        if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
+          UIntType castingValue = element.value(UIntType.class);
+          month = castingValue.value(Integer.class);
+        }
+      } else if (element.contextTagNum() == DAY_ID) {
+        if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
+          UIntType castingValue = element.value(UIntType.class);
+          day = castingValue.value(Integer.class);
+        }
+      } else if (element.contextTagNum() == DAY_OF_WEEK_ID) {
+        if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
+          UIntType castingValue = element.value(UIntType.class);
+          dayOfWeek = castingValue.value(Integer.class);
+        }
+      }
+    }
+    return new EnergyCalendarClusterDateStruct(
+      year,
+      month,
+      day,
+      dayOfWeek
+    );
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder output = new StringBuilder();
+    output.append("EnergyCalendarClusterDateStruct {\n");
+    output.append("\tyear: ");
+    output.append(year);
+    output.append("\n");
+    output.append("\tmonth: ");
+    output.append(month);
+    output.append("\n");
+    output.append("\tday: ");
+    output.append(day);
+    output.append("\n");
+    output.append("\tdayOfWeek: ");
+    output.append(dayOfWeek);
+    output.append("\n");
+    output.append("}\n");
+    return output.toString();
+  }
+}
 public static class EnergyCalendarClusterDayStruct {
-  public Optional<Long> date;
+  public Optional<ChipStructs.EnergyCalendarClusterDateStruct> date;
   public Optional<Integer> daysOfWeek;
   public ArrayList<ChipStructs.EnergyCalendarClusterTransitionStruct> transitions;
   public Optional<Long> calendarID;
@@ -8512,7 +8603,7 @@ public static class EnergyCalendarClusterDayStruct {
   private static final long CALENDAR_I_D_ID = 3L;
 
   public EnergyCalendarClusterDayStruct(
-    Optional<Long> date,
+    Optional<ChipStructs.EnergyCalendarClusterDateStruct> date,
     Optional<Integer> daysOfWeek,
     ArrayList<ChipStructs.EnergyCalendarClusterTransitionStruct> transitions,
     Optional<Long> calendarID
@@ -8525,7 +8616,7 @@ public EnergyCalendarClusterDayStruct(
 
   public StructType encodeTlv() {
     ArrayList<StructElement> values = new ArrayList<>();
-    values.add(new StructElement(DATE_ID, date.<BaseTLVType>map((nonOptionaldate) -> new UIntType(nonOptionaldate)).orElse(new EmptyType())));
+    values.add(new StructElement(DATE_ID, date.<BaseTLVType>map((nonOptionaldate) -> nonOptionaldate.encodeTlv()).orElse(new EmptyType())));
     values.add(new StructElement(DAYS_OF_WEEK_ID, daysOfWeek.<BaseTLVType>map((nonOptionaldaysOfWeek) -> new UIntType(nonOptionaldaysOfWeek)).orElse(new EmptyType())));
     values.add(new StructElement(TRANSITIONS_ID, ArrayType.generateArrayType(transitions, (elementtransitions) -> elementtransitions.encodeTlv())));
     values.add(new StructElement(CALENDAR_I_D_ID, calendarID.<BaseTLVType>map((nonOptionalcalendarID) -> new UIntType(nonOptionalcalendarID)).orElse(new EmptyType())));
@@ -8537,15 +8628,15 @@ public static EnergyCalendarClusterDayStruct decodeTlv(BaseTLVType tlvValue) {
     if (tlvValue == null || tlvValue.type() != TLVType.Struct) {
       return null;
     }
-    Optional<Long> date = Optional.empty();
+    Optional<ChipStructs.EnergyCalendarClusterDateStruct> date = Optional.empty();
     Optional<Integer> daysOfWeek = Optional.empty();
     ArrayList<ChipStructs.EnergyCalendarClusterTransitionStruct> transitions = null;
     Optional<Long> calendarID = Optional.empty();
     for (StructElement element: ((StructType)tlvValue).value()) {
       if (element.contextTagNum() == DATE_ID) {
-        if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
-          UIntType castingValue = element.value(UIntType.class);
-          date = Optional.of(castingValue.value(Long.class));
+        if (element.value(BaseTLVType.class).type() == TLVType.Struct) {
+          StructType castingValue = element.value(StructType.class);
+          date = Optional.of(ChipStructs.EnergyCalendarClusterDateStruct.decodeTlv(castingValue));
         }
       } else if (element.contextTagNum() == DAYS_OF_WEEK_ID) {
         if (element.value(BaseTLVType.class).type() == TLVType.UInt) {

src/controller/java/generated/java/chip/devicecontroller/cluster/files.gni

@@ -65,6 +65,7 @@ structs_sources = [
   "${chip_root}/src/controller/java/generated/java/chip/devicecontroller/cluster/structs/ElectricalPowerMeasurementClusterMeasurementAccuracyStruct.kt",
   "${chip_root}/src/controller/java/generated/java/chip/devicecontroller/cluster/structs/ElectricalPowerMeasurementClusterMeasurementRangeStruct.kt",
   "${chip_root}/src/controller/java/generated/java/chip/devicecontroller/cluster/structs/EnergyCalendarClusterCalendarPeriodStruct.kt",
+  "${chip_root}/src/controller/java/generated/java/chip/devicecontroller/cluster/structs/EnergyCalendarClusterDateStruct.kt",
   "${chip_root}/src/controller/java/generated/java/chip/devicecontroller/cluster/structs/EnergyCalendarClusterDayStruct.kt",
   "${chip_root}/src/controller/java/generated/java/chip/devicecontroller/cluster/structs/EnergyCalendarClusterPeakPeriodStruct.kt",
   "${chip_root}/src/controller/java/generated/java/chip/devicecontroller/cluster/structs/EnergyCalendarClusterTransitionStruct.kt",

src/controller/java/generated/java/chip/devicecontroller/cluster/structs/EnergyCalendarClusterDateStruct.kt

@@ -0,0 +1,109 @@
+/*
+ *
+ *    Copyright (c) 2023 Project CHIP Authors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package chip.devicecontroller.cluster.structs
+
+import chip.devicecontroller.cluster.*
+import matter.tlv.ContextSpecificTag
+import matter.tlv.Tag
+import matter.tlv.TlvReader
+import matter.tlv.TlvWriter
+
+class EnergyCalendarClusterDateStruct(
+  val year: UInt?,
+  val month: UInt?,
+  val day: UInt?,
+  val dayOfWeek: UInt?,
+) {
+  override fun toString(): String = buildString {
+    append("EnergyCalendarClusterDateStruct {\n")
+    append("\tyear : $year\n")
+    append("\tmonth : $month\n")
+    append("\tday : $day\n")
+    append("\tdayOfWeek : $dayOfWeek\n")
+    append("}\n")
+  }
+
+  fun toTlv(tlvTag: Tag, tlvWriter: TlvWriter) {
+    tlvWriter.apply {
+      startStructure(tlvTag)
+      if (year != null) {
+        put(ContextSpecificTag(TAG_YEAR), year)
+      } else {
+        putNull(ContextSpecificTag(TAG_YEAR))
+      }
+      if (month != null) {
+        put(ContextSpecificTag(TAG_MONTH), month)
+      } else {
+        putNull(ContextSpecificTag(TAG_MONTH))
+      }
+      if (day != null) {
+        put(ContextSpecificTag(TAG_DAY), day)
+      } else {
+        putNull(ContextSpecificTag(TAG_DAY))
+      }
+      if (dayOfWeek != null) {
+        put(ContextSpecificTag(TAG_DAY_OF_WEEK), dayOfWeek)
+      } else {
+        putNull(ContextSpecificTag(TAG_DAY_OF_WEEK))
+      }
+      endStructure()
+    }
+  }
+
+  companion object {
+    private const val TAG_YEAR = 0
+    private const val TAG_MONTH = 1
+    private const val TAG_DAY = 2
+    private const val TAG_DAY_OF_WEEK = 3
+
+    fun fromTlv(tlvTag: Tag, tlvReader: TlvReader): EnergyCalendarClusterDateStruct {
+      tlvReader.enterStructure(tlvTag)
+      val year =
+        if (!tlvReader.isNull()) {
+          tlvReader.getUInt(ContextSpecificTag(TAG_YEAR))
+        } else {
+          tlvReader.getNull(ContextSpecificTag(TAG_YEAR))
+          null
+        }
+      val month =
+        if (!tlvReader.isNull()) {
+          tlvReader.getUInt(ContextSpecificTag(TAG_MONTH))
+        } else {
+          tlvReader.getNull(ContextSpecificTag(TAG_MONTH))
+          null
+        }
+      val day =
+        if (!tlvReader.isNull()) {
+          tlvReader.getUInt(ContextSpecificTag(TAG_DAY))
+        } else {
+          tlvReader.getNull(ContextSpecificTag(TAG_DAY))
+          null
+        }
+      val dayOfWeek =
+        if (!tlvReader.isNull()) {
+          tlvReader.getUInt(ContextSpecificTag(TAG_DAY_OF_WEEK))
+        } else {
+          tlvReader.getNull(ContextSpecificTag(TAG_DAY_OF_WEEK))
+          null
+        }
+
+      tlvReader.exitContainer()
+
+      return EnergyCalendarClusterDateStruct(year, month, day, dayOfWeek)
+    }
+  }
+}

src/controller/java/generated/java/chip/devicecontroller/cluster/structs/EnergyCalendarClusterDayStruct.kt

@@ -25,7 +25,7 @@ import matter.tlv.TlvReader
 import matter.tlv.TlvWriter
 
 class EnergyCalendarClusterDayStruct(
-  val date: Optional<ULong>,
+  val date: Optional<EnergyCalendarClusterDateStruct>,
   val daysOfWeek: Optional<UInt>,
   val transitions: List<EnergyCalendarClusterTransitionStruct>,
   val calendarID: Optional<ULong>,
@@ -44,7 +44,7 @@ class EnergyCalendarClusterDayStruct(
       startStructure(tlvTag)
       if (date.isPresent) {
         val optdate = date.get()
-        put(ContextSpecificTag(TAG_DATE), optdate)
+        optdate.toTlv(ContextSpecificTag(TAG_DATE), this)
       }
       if (daysOfWeek.isPresent) {
         val optdaysOfWeek = daysOfWeek.get()
@@ -73,7 +73,9 @@ class EnergyCalendarClusterDayStruct(
       tlvReader.enterStructure(tlvTag)
       val date =
         if (tlvReader.isNextTag(ContextSpecificTag(TAG_DATE))) {
-          Optional.of(tlvReader.getULong(ContextSpecificTag(TAG_DATE)))
+          Optional.of(
+            EnergyCalendarClusterDateStruct.fromTlv(ContextSpecificTag(TAG_DATE), tlvReader)
+          )
         } else {
           Optional.empty()
         }

src/controller/java/generated/java/matter/controller/cluster/files.gni

@@ -65,6 +65,7 @@ matter_structs_sources = [
   "${chip_root}/src/controller/java/generated/java/matter/controller/cluster/structs/ElectricalPowerMeasurementClusterMeasurementAccuracyStruct.kt",
   "${chip_root}/src/controller/java/generated/java/matter/controller/cluster/structs/ElectricalPowerMeasurementClusterMeasurementRangeStruct.kt",
   "${chip_root}/src/controller/java/generated/java/matter/controller/cluster/structs/EnergyCalendarClusterCalendarPeriodStruct.kt",
+  "${chip_root}/src/controller/java/generated/java/matter/controller/cluster/structs/EnergyCalendarClusterDateStruct.kt",
   "${chip_root}/src/controller/java/generated/java/matter/controller/cluster/structs/EnergyCalendarClusterDayStruct.kt",
   "${chip_root}/src/controller/java/generated/java/matter/controller/cluster/structs/EnergyCalendarClusterPeakPeriodStruct.kt",
   "${chip_root}/src/controller/java/generated/java/matter/controller/cluster/structs/EnergyCalendarClusterTransitionStruct.kt",