From 7497eead36e17020b37f1d62c92f0c03737770be Mon Sep 17 00:00:00 2001
From: "jfierke@irobot.com" <jfierke@irobot.com>
Date: Wed, 22 May 2024 11:42:48 -0400
Subject: [PATCH] Add definitions for common HomeLocationStruct and types - see
 connectedhomeip-spec PR 8933

---
 scripts/rules.matterlint                      |   1 +
 .../zcl/data-model/chip/home-location.xml     | 129 ++++++++++++++++++
 .../zcl/zcl-with-test-extensions.json         |   1 +
 src/app/zap-templates/zcl/zcl.json            |   1 +
 4 files changed, 132 insertions(+)
 create mode 100644 src/app/zap-templates/zcl/data-model/chip/home-location.xml

diff --git a/scripts/rules.matterlint b/scripts/rules.matterlint
index 037ed829a15a11..7c5c69a67b7150 100644
--- a/scripts/rules.matterlint
+++ b/scripts/rules.matterlint
@@ -44,6 +44,7 @@ load "../src/app/zap-templates/zcl/data-model/chip/general-diagnostics-cluster.x
 load "../src/app/zap-templates/zcl/data-model/chip/global-attributes.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/groups-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/group-key-mgmt-cluster.xml";
+load "../src/app/zap-templates/zcl/data-model/chip/home-location.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/identify-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/illuminance-measurement-cluster.xml";
 load "../src/app/zap-templates/zcl/data-model/chip/keypad-input-cluster.xml";
diff --git a/src/app/zap-templates/zcl/data-model/chip/home-location.xml b/src/app/zap-templates/zcl/data-model/chip/home-location.xml
new file mode 100644
index 00000000000000..2bd00d4ba922d3
--- /dev/null
+++ b/src/app/zap-templates/zcl/data-model/chip/home-location.xml
@@ -0,0 +1,129 @@
+<?xml version="1.0"?>
+<!--
+Copyright (c) 2024 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.
+-->
+<configurator>
+  <domain name="HomeLocation"/>
+  <enum name="AreaTypeTag" type="enum8">
+    <!-- Service Area Cluster -->
+    <cluster code="0x0150"/>
+    <!-- expected future use in Basic Information Cluster code="0x0028" -->
+
+    <item value="0x00" name="Aisle"/>
+    <item value="0x01" name="Attic"/>
+    <item value="0x02" name="Back Yard"/>
+    <item value="0x03" name="Balcony"/>
+    <item value="0x04" name="Ballroom"/>
+    <item value="0x05" name="Bathroom"/>
+    <item value="0x06" name="Bedroom"/>
+    <item value="0x07" name="Border"/>
+    <item value="0x08" name="Boxroom"/>
+    <item value="0x09" name="Breakfast Room"/>
+    <item value="0x0A" name="Carort"/>
+    <item value="0x0B" name="Cellar"/>
+    <item value="0x0C" name="Cloakroom"/>
+    <item value="0x0D" name="Closet"/>
+    <item value="0x0E" name="Conservatory"/>
+    <item value="0x0F" name="Corridor"/>
+
+    <item value="0x10" name="Cupboard"/>
+    <item value="0x11" name="Deck"/>
+    <item value="0x12" name="Den"/>
+    <item value="0x13" name="Dining"/>
+    <item value="0x14" name="Drawing Room"/>
+    <item value="0x15" name="Dressing Room"/>
+    <item value="0x16" name="Driveway"/>
+    <item value="0x17" name="Elevator"/>
+    <item value="0x18" name="Ensuite"/>
+    <item value="0x19" name="Entrance"/>
+    <item value="0x1A" name="Entryway"/>
+    <item value="0x1B" name="Family Room"/>
+    <item value="0x1C" name="Foyer"/>
+    <item value="0x1D" name="Front Yard"/>
+    <item value="0x1E" name="Game Room"/>
+    <item value="0x1F" name="Garage"/>
+
+    <item value="0x20" name="Garden"/>
+    <item value="0x21" name="Guest Bathroom"/>
+    <item value="0x22" name="Guest Bedroom"/>
+    <item value="0x23" name="Guest Restroom"/>
+    <item value="0x24" name="Guest Room"/>
+    <item value="0x25" name="Gym"/>
+    <item value="0x26" name="Hallway"/>
+    <item value="0x27" name="Kids Room"/>
+    <item value="0x28" name="Kids Bedroom"/>
+    <item value="0x29" name="Kitchen"/>
+    <item value="0x2A" name="Larder"/>
+    <item value="0x2B" name="Laundry Room"/>
+    <item value="0x2C" name="Lawn"/>
+    <item value="0x2D" name="Library"/>
+    <item value="0x2E" name="Living Room"/>
+    <item value="0x2F" name="Lounge"/>
+
+    <item value="0x30" name="Man Cave"/>
+    <item value="0x31" name="Master Bathroom"/>
+    <item value="0x32" name="Master Bedroom"/>
+    <item value="0x33" name="Media/TV Room"/>
+    <item value="0x34" name="Mud Room"/>
+    <item value="0x35" name="Music Room"/>
+    <item value="0x36" name="Nursery"/>
+    <item value="0x37" name="Office"/>
+    <item value="0x38" name="Outdoor Kitchen"/>
+    <item value="0x39" name="Pantry"/>
+    <item value="0x3A" name="Parking Lot"/>
+    <item value="0x3B" name="Parlor"/>
+    <item value="0x3C" name="Patio"/>
+    <item value="0x3D" name="Play Room"/>
+    <item value="0x3E" name="Pool Room"/>
+    <item value="0x3F" name="Porch"/>
+
+    <item value="0x40" name="Ramp"/>
+    <item value="0x41" name="Reception Room"/>
+    <item value="0x42" name="Recreation Room"/>
+    <item value="0x43" name="Restroom"/>
+    <item value="0x44" name="Roof"/>
+    <item value="0x45" name="Sauna"/>
+    <item value="0x46" name="Scullery"/>
+    <item value="0x47" name="Shed"/>
+    <item value="0x48" name="Side Yard"/>
+    <item value="0x49" name="Sitting Room"/>
+    <item value="0x4A" name="Snug"/>
+    <item value="0x4B" name="Spa"/>
+    <item value="0x4C" name="Staircase"/>
+    <item value="0x4D" name="Steam Room"/>
+    <item value="0x4E" name="Storage Room"/>
+    <item value="0x4F" name="Studio"/>
+
+    <item value="0x50" name="Study"/>
+    <item value="0x51" name="Sun Room"/>
+    <item value="0x52" name="Swimming Pool"/>
+    <item value="0x53" name="Terrace"/>
+    <item value="0x54" name="Utility Room"/>
+    <item value="0x55" name="Ward"/>
+    <item value="0x56" name="Workshop"/>
+  </enum>
+
+
+  <struct name="HomeLocationStruct">
+    <!-- Service Area Cluster -->
+    <cluster code="0x0150"/>
+    <!-- expected future use in Basic Information Cluster code="0x0028" -->
+
+    <item fieldId="0" name="LocationName"    type="char_string" length="64" isNullable="false"/>
+    <item fieldId="1" name="FloorNumber"     type="int16s"                  isNullable="true"/>
+    <item fieldId="2" name="IsGroundFloor"   type="boolean"                 isNullable="true"/>
+    <item fieldId="3" name="AreaType"        type="AreaTypeTag"             isNullable="true"/>
+  </struct>
+</configurator>
diff --git a/src/app/zap-templates/zcl/zcl-with-test-extensions.json b/src/app/zap-templates/zcl/zcl-with-test-extensions.json
index f3aa6ef0b47f48..e2588405165f8b 100644
--- a/src/app/zap-templates/zcl/zcl-with-test-extensions.json
+++ b/src/app/zap-templates/zcl/zcl-with-test-extensions.json
@@ -63,6 +63,7 @@
         "global-attributes.xml",
         "groups-cluster.xml",
         "group-key-mgmt-cluster.xml",
+        "home-location.xml",
         "icd-management-cluster.xml",
         "identify-cluster.xml",
         "illuminance-measurement-cluster.xml",
diff --git a/src/app/zap-templates/zcl/zcl.json b/src/app/zap-templates/zcl/zcl.json
index d85f850b2c9483..3731edfeadbf9d 100644
--- a/src/app/zap-templates/zcl/zcl.json
+++ b/src/app/zap-templates/zcl/zcl.json
@@ -61,6 +61,7 @@
         "global-attributes.xml",
         "groups-cluster.xml",
         "group-key-mgmt-cluster.xml",
+        "home-location.xml",
         "icd-management-cluster.xml",
         "identify-cluster.xml",
         "illuminance-measurement-cluster.xml",