Skip to content

Commit 1030718

Browse files
hicklinrestyled-commits
authored and
pull[bot]
committed
Update PositionTag and AreaDesc field names (#35094)
* Updated the PositionTag and AreaDesc field names in the service area XML. * Zap generated after XML update. * Updated the PositionTag and AreaDesc field names in the SDK server code and test scripts. * Restyled by clang-format * Fixed issues caused by merge. * reverted changes in generated code. * encoding --------- Co-authored-by: Restyled.io <commits@restyled.io>
1 parent 1664750 commit 1030718

File tree

21 files changed

+225
-221
lines changed

21 files changed

+225
-221
lines changed

‎examples/rvc-app/linux/RvcAppCommandDelegate.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -216,9 +216,9 @@ void RvcAppCommandHandler::OnAddServiceAreaArea(Json::Value jsonValue)
216216
if (jsonValue.isMember("LandmarkTag"))
217217
{
218218
DataModel::Nullable<Globals::RelativePositionTag> relativePositionTag = DataModel::NullNullable;
219-
if (jsonValue.isMember("PositionTag"))
219+
if (jsonValue.isMember("RelativePositionTag"))
220220
{
221-
relativePositionTag = Globals::RelativePositionTag(jsonValue["PositionTag"].asUInt());
221+
relativePositionTag = Globals::RelativePositionTag(jsonValue["RelativePositionTag"].asUInt());
222222
}
223223

224224
area.SetLandmarkInfo(Globals::LandmarkTag(jsonValue["LandmarkTag"].asUInt()), relativePositionTag);

‎examples/rvc-app/rvc-common/rvc-app.matter

+2-2
Original file line numberDiff line numberDiff line change
@@ -1458,7 +1458,7 @@ provisional cluster ServiceArea = 336 {
14581458

14591459
struct LandmarkInfoStruct {
14601460
LandmarkTag landmarkTag = 0;
1461-
nullable RelativePositionTag positionTag = 1;
1461+
nullable RelativePositionTag relativePositionTag = 1;
14621462
}
14631463

14641464
struct AreaInfoStruct {
@@ -1469,7 +1469,7 @@ provisional cluster ServiceArea = 336 {
14691469
struct AreaStruct {
14701470
int32u areaID = 0;
14711471
nullable int32u mapID = 1;
1472-
AreaInfoStruct areaDesc = 2;
1472+
AreaInfoStruct areaInfo = 2;
14731473
}
14741474

14751475
struct MapStruct {

‎src/app/clusters/service-area-server/service-area-cluster-objects.h

+25-25
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
6868
{
6969
areaID = aOther.areaID;
7070
mapID = aOther.mapID;
71-
SetLocationInfo(aOther.areaDesc.locationInfo);
72-
SetLandmarkInfo(aOther.areaDesc.landmarkInfo);
71+
SetLocationInfo(aOther.areaInfo.locationInfo);
72+
SetLandmarkInfo(aOther.areaInfo.landmarkInfo);
7373

7474
return *this;
7575
}
@@ -95,7 +95,7 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
9595

9696
AreaStructureWrapper & SetLocationInfoNull()
9797
{
98-
areaDesc.locationInfo.SetNull();
98+
areaInfo.locationInfo.SetNull();
9999
return *this;
100100
}
101101

@@ -108,15 +108,15 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
108108
AreaStructureWrapper & SetLocationInfo(const CharSpan & locationName, const DataModel::Nullable<int16_t> & floorNumber,
109109
const DataModel::Nullable<Globals::AreaTypeTag> & areaType)
110110
{
111-
areaDesc.locationInfo.SetNonNull();
111+
areaInfo.locationInfo.SetNonNull();
112112

113113
// Copy the name. If the name is larger than kAreaNameMaxSize, truncate it to fit.
114114
auto sizeToCopy = std::min(kAreaNameMaxSize, locationName.size());
115115
memcpy(mAreaNameBuffer, locationName.data(), sizeToCopy);
116-
areaDesc.locationInfo.Value().locationName = CharSpan(mAreaNameBuffer, sizeToCopy);
116+
areaInfo.locationInfo.Value().locationName = CharSpan(mAreaNameBuffer, sizeToCopy);
117117

118-
areaDesc.locationInfo.Value().floorNumber = floorNumber;
119-
areaDesc.locationInfo.Value().areaType = areaType;
118+
areaInfo.locationInfo.Value().floorNumber = floorNumber;
119+
areaInfo.locationInfo.Value().areaType = areaType;
120120

121121
return *this;
122122
}
@@ -138,7 +138,7 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
138138

139139
AreaStructureWrapper & SetLandmarkInfoNull()
140140
{
141-
areaDesc.landmarkInfo.SetNull();
141+
areaInfo.landmarkInfo.SetNull();
142142
return *this;
143143
}
144144

@@ -150,9 +150,9 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
150150
AreaStructureWrapper & SetLandmarkInfo(const Globals::LandmarkTag & landmarkTag,
151151
const DataModel::Nullable<Globals::RelativePositionTag> & relativePositionTag)
152152
{
153-
areaDesc.landmarkInfo.SetNonNull();
154-
areaDesc.landmarkInfo.Value().landmarkTag = landmarkTag;
155-
areaDesc.landmarkInfo.Value().positionTag = relativePositionTag;
153+
areaInfo.landmarkInfo.SetNonNull();
154+
areaInfo.landmarkInfo.Value().landmarkTag = landmarkTag;
155+
areaInfo.landmarkInfo.Value().relativePositionTag = relativePositionTag;
156156

157157
return *this;
158158
}
@@ -167,7 +167,7 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
167167
return SetLandmarkInfoNull();
168168
}
169169

170-
return SetLandmarkInfo(landmarkInfo.Value().landmarkTag, landmarkInfo.Value().positionTag);
170+
return SetLandmarkInfo(landmarkInfo.Value().landmarkTag, landmarkInfo.Value().relativePositionTag);
171171
}
172172

173173
/**
@@ -178,9 +178,9 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
178178
*/
179179
bool IsNameEqual(const CharSpan & aAreaName) const
180180
{
181-
if (!areaDesc.locationInfo.IsNull())
181+
if (!areaInfo.locationInfo.IsNull())
182182
{
183-
return areaDesc.locationInfo.Value().locationName.data_equal(aAreaName);
183+
return areaInfo.locationInfo.Value().locationName.data_equal(aAreaName);
184184
}
185185

186186
return false;
@@ -215,43 +215,43 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
215215
return false;
216216
}
217217

218-
if (areaDesc.locationInfo.IsNull() != aOther.areaDesc.locationInfo.IsNull())
218+
if (areaInfo.locationInfo.IsNull() != aOther.areaInfo.locationInfo.IsNull())
219219
{
220220
return false;
221221
}
222222

223-
if (!areaDesc.locationInfo.IsNull())
223+
if (!areaInfo.locationInfo.IsNull())
224224
{
225225

226-
if (!IsNameEqual(aOther.areaDesc.locationInfo.Value().locationName))
226+
if (!IsNameEqual(aOther.areaInfo.locationInfo.Value().locationName))
227227
{
228228
return false;
229229
}
230230

231-
if (areaDesc.locationInfo.Value().floorNumber != aOther.areaDesc.locationInfo.Value().floorNumber)
231+
if (areaInfo.locationInfo.Value().floorNumber != aOther.areaInfo.locationInfo.Value().floorNumber)
232232
{
233233
return false;
234234
}
235235

236-
if (areaDesc.locationInfo.Value().areaType != aOther.areaDesc.locationInfo.Value().areaType)
236+
if (areaInfo.locationInfo.Value().areaType != aOther.areaInfo.locationInfo.Value().areaType)
237237
{
238238
return false;
239239
}
240240
}
241241

242-
if (areaDesc.landmarkInfo.IsNull() != aOther.areaDesc.landmarkInfo.IsNull())
242+
if (areaInfo.landmarkInfo.IsNull() != aOther.areaInfo.landmarkInfo.IsNull())
243243
{
244244
return false;
245245
}
246246

247-
if (!areaDesc.landmarkInfo.IsNull())
247+
if (!areaInfo.landmarkInfo.IsNull())
248248
{
249-
if (areaDesc.landmarkInfo.Value().landmarkTag != aOther.areaDesc.landmarkInfo.Value().landmarkTag)
249+
if (areaInfo.landmarkInfo.Value().landmarkTag != aOther.areaInfo.landmarkInfo.Value().landmarkTag)
250250
{
251251
return false;
252252
}
253253

254-
if (areaDesc.landmarkInfo.Value().positionTag != aOther.areaDesc.landmarkInfo.Value().positionTag)
254+
if (areaInfo.landmarkInfo.Value().relativePositionTag != aOther.areaInfo.landmarkInfo.Value().relativePositionTag)
255255
{
256256
return false;
257257
}
@@ -265,12 +265,12 @@ struct AreaStructureWrapper : public chip::app::Clusters::ServiceArea::Structs::
265265
*/
266266
CharSpan GetName()
267267
{
268-
if (areaDesc.locationInfo.IsNull())
268+
if (areaInfo.locationInfo.IsNull())
269269
{
270270
return { mAreaNameBuffer, 0 };
271271
}
272272

273-
return areaDesc.locationInfo.Value().locationName;
273+
return areaInfo.locationInfo.Value().locationName;
274274
}
275275

276276
private:

‎src/app/clusters/service-area-server/service-area-server.cpp

+4-4
Original file line numberDiff line numberDiff line change
@@ -442,18 +442,18 @@ bool Instance::IsValidSupportedArea(const AreaStructureWrapper & aArea)
442442
{
443443
// If the LocationInfo field is null, the LandmarkInfo field SHALL NOT be null.
444444
// If the LandmarkInfo field is null, the LocationInfo field SHALL NOT be null.
445-
if (aArea.areaDesc.locationInfo.IsNull() && aArea.areaDesc.landmarkInfo.IsNull())
445+
if (aArea.areaInfo.locationInfo.IsNull() && aArea.areaInfo.landmarkInfo.IsNull())
446446
{
447447
ChipLogDetail(Zcl, "IsValidAsSupportedArea %" PRIu32 " - must have locationInfo and/or LandmarkInfo", aArea.areaID);
448448
return false;
449449
}
450450

451451
// If LocationInfo is not null, and its LocationName field is an empty string, at least one of the following SHALL NOT
452452
// be null: LocationInfo's FloorNumber field, LocationInfo's AreaType field, the LandmarkInfo
453-
if (!aArea.areaDesc.locationInfo.IsNull())
453+
if (!aArea.areaInfo.locationInfo.IsNull())
454454
{
455-
if (aArea.areaDesc.locationInfo.Value().locationName.empty() && aArea.areaDesc.locationInfo.Value().floorNumber.IsNull() &&
456-
aArea.areaDesc.locationInfo.Value().areaType.IsNull() && aArea.areaDesc.landmarkInfo.IsNull())
455+
if (aArea.areaInfo.locationInfo.Value().locationName.empty() && aArea.areaInfo.locationInfo.Value().floorNumber.IsNull() &&
456+
aArea.areaInfo.locationInfo.Value().areaType.IsNull() && aArea.areaInfo.landmarkInfo.IsNull())
457457
{
458458
ChipLogDetail(
459459
Zcl, "IsValidAsSupportedArea %" PRIu32 " - AreaName is empty string, FloorNumber, AreaType, LandmarkInfo are null",

‎src/app/zap-templates/zcl/data-model/chip/service-area-cluster.xml

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ limitations under the License.
2020
Data types
2121
<struct name="LandmarkInfoStruct" apiMaturity="provisional">
2222
<cluster code="0x0150"/>
23-
<item name="LandmarkTag" type="LandmarkTag" optional="false" isNullable="false"/>
24-
<item name="PositionTag" type="RelativePositionTag" optional="false" isNullable="true"/>
23+
<item name="LandmarkTag" type="LandmarkTag" optional="false" isNullable="false"/>
24+
<item name="RelativePositionTag" type="RelativePositionTag" optional="false" isNullable="true"/>
2525
</struct>
2626

2727
<struct name="AreaInfoStruct" apiMaturity="provisional">
@@ -40,7 +40,7 @@ limitations under the License.
4040
<cluster code="0x0150"/>
4141
<item name="AreaID" type="int32u" optional="false" isNullable="false"/>
4242
<item name="MapID" type="int32u" optional="false" isNullable="true"/>
43-
<item name="AreaDesc" type="AreaInfoStruct" optional="false" isNullable="false"/>
43+
<item name="AreaInfo" type="AreaInfoStruct" optional="false" isNullable="false"/>
4444
</struct>
4545

4646
<struct name="ProgressStruct">

‎src/controller/data_model/controller-clusters.matter

+2-2
Original file line numberDiff line numberDiff line change
@@ -6483,7 +6483,7 @@ provisional cluster ServiceArea = 336 {
64836483

64846484
struct LandmarkInfoStruct {
64856485
LandmarkTag landmarkTag = 0;
6486-
nullable RelativePositionTag positionTag = 1;
6486+
nullable RelativePositionTag relativePositionTag = 1;
64876487
}
64886488

64896489
struct AreaInfoStruct {
@@ -6494,7 +6494,7 @@ provisional cluster ServiceArea = 336 {
64946494
struct AreaStruct {
64956495
int32u areaID = 0;
64966496
nullable int32u mapID = 1;
6497-
AreaInfoStruct areaDesc = 2;
6497+
AreaInfoStruct areaInfo = 2;
64986498
}
64996499

65006500
struct MapStruct {

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

+22-22
Original file line numberDiff line numberDiff line change
@@ -9294,22 +9294,22 @@ public String toString() {
92949294
}
92959295
public static class ServiceAreaClusterLandmarkInfoStruct {
92969296
public Integer landmarkTag;
9297-
public @Nullable Integer positionTag;
9297+
public @Nullable Integer relativePositionTag;
92989298
private static final long LANDMARK_TAG_ID = 0L;
9299-
private static final long POSITION_TAG_ID = 1L;
9299+
private static final long RELATIVE_POSITION_TAG_ID = 1L;
93009300

93019301
public ServiceAreaClusterLandmarkInfoStruct(
93029302
Integer landmarkTag,
9303-
@Nullable Integer positionTag
9303+
@Nullable Integer relativePositionTag
93049304
) {
93059305
this.landmarkTag = landmarkTag;
9306-
this.positionTag = positionTag;
9306+
this.relativePositionTag = relativePositionTag;
93079307
}
93089308

93099309
public StructType encodeTlv() {
93109310
ArrayList<StructElement> values = new ArrayList<>();
93119311
values.add(new StructElement(LANDMARK_TAG_ID, new UIntType(landmarkTag)));
9312-
values.add(new StructElement(POSITION_TAG_ID, positionTag != null ? new UIntType(positionTag) : new NullType()));
9312+
values.add(new StructElement(RELATIVE_POSITION_TAG_ID, relativePositionTag != null ? new UIntType(relativePositionTag) : new NullType()));
93139313

93149314
return new StructType(values);
93159315
}
@@ -9319,23 +9319,23 @@ public static ServiceAreaClusterLandmarkInfoStruct decodeTlv(BaseTLVType tlvValu
93199319
return null;
93209320
}
93219321
Integer landmarkTag = null;
9322-
@Nullable Integer positionTag = null;
9322+
@Nullable Integer relativePositionTag = null;
93239323
for (StructElement element: ((StructType)tlvValue).value()) {
93249324
if (element.contextTagNum() == LANDMARK_TAG_ID) {
93259325
if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
93269326
UIntType castingValue = element.value(UIntType.class);
93279327
landmarkTag = castingValue.value(Integer.class);
93289328
}
9329-
} else if (element.contextTagNum() == POSITION_TAG_ID) {
9329+
} else if (element.contextTagNum() == RELATIVE_POSITION_TAG_ID) {
93309330
if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
93319331
UIntType castingValue = element.value(UIntType.class);
9332-
positionTag = castingValue.value(Integer.class);
9332+
relativePositionTag = castingValue.value(Integer.class);
93339333
}
93349334
}
93359335
}
93369336
return new ServiceAreaClusterLandmarkInfoStruct(
93379337
landmarkTag,
9338-
positionTag
9338+
relativePositionTag
93399339
);
93409340
}
93419341

@@ -9346,8 +9346,8 @@ public String toString() {
93469346
output.append("\tlandmarkTag: ");
93479347
output.append(landmarkTag);
93489348
output.append("\n");
9349-
output.append("\tpositionTag: ");
9350-
output.append(positionTag);
9349+
output.append("\trelativePositionTag: ");
9350+
output.append(relativePositionTag);
93519351
output.append("\n");
93529352
output.append("}\n");
93539353
return output.toString();
@@ -9417,26 +9417,26 @@ public String toString() {
94179417
public static class ServiceAreaClusterAreaStruct {
94189418
public Long areaID;
94199419
public @Nullable Long mapID;
9420-
public ChipStructs.ServiceAreaClusterAreaInfoStruct areaDesc;
9420+
public ChipStructs.ServiceAreaClusterAreaInfoStruct areaInfo;
94219421
private static final long AREA_ID_ID = 0L;
94229422
private static final long MAP_ID_ID = 1L;
9423-
private static final long AREA_DESC_ID = 2L;
9423+
private static final long AREA_INFO_ID = 2L;
94249424

94259425
public ServiceAreaClusterAreaStruct(
94269426
Long areaID,
94279427
@Nullable Long mapID,
9428-
ChipStructs.ServiceAreaClusterAreaInfoStruct areaDesc
9428+
ChipStructs.ServiceAreaClusterAreaInfoStruct areaInfo
94299429
) {
94309430
this.areaID = areaID;
94319431
this.mapID = mapID;
9432-
this.areaDesc = areaDesc;
9432+
this.areaInfo = areaInfo;
94339433
}
94349434

94359435
public StructType encodeTlv() {
94369436
ArrayList<StructElement> values = new ArrayList<>();
94379437
values.add(new StructElement(AREA_ID_ID, new UIntType(areaID)));
94389438
values.add(new StructElement(MAP_ID_ID, mapID != null ? new UIntType(mapID) : new NullType()));
9439-
values.add(new StructElement(AREA_DESC_ID, areaDesc.encodeTlv()));
9439+
values.add(new StructElement(AREA_INFO_ID, areaInfo.encodeTlv()));
94409440

94419441
return new StructType(values);
94429442
}
@@ -9447,7 +9447,7 @@ public static ServiceAreaClusterAreaStruct decodeTlv(BaseTLVType tlvValue) {
94479447
}
94489448
Long areaID = null;
94499449
@Nullable Long mapID = null;
9450-
ChipStructs.ServiceAreaClusterAreaInfoStruct areaDesc = null;
9450+
ChipStructs.ServiceAreaClusterAreaInfoStruct areaInfo = null;
94519451
for (StructElement element: ((StructType)tlvValue).value()) {
94529452
if (element.contextTagNum() == AREA_ID_ID) {
94539453
if (element.value(BaseTLVType.class).type() == TLVType.UInt) {
@@ -9459,17 +9459,17 @@ public static ServiceAreaClusterAreaStruct decodeTlv(BaseTLVType tlvValue) {
94599459
UIntType castingValue = element.value(UIntType.class);
94609460
mapID = castingValue.value(Long.class);
94619461
}
9462-
} else if (element.contextTagNum() == AREA_DESC_ID) {
9462+
} else if (element.contextTagNum() == AREA_INFO_ID) {
94639463
if (element.value(BaseTLVType.class).type() == TLVType.Struct) {
94649464
StructType castingValue = element.value(StructType.class);
9465-
areaDesc = ChipStructs.ServiceAreaClusterAreaInfoStruct.decodeTlv(castingValue);
9465+
areaInfo = ChipStructs.ServiceAreaClusterAreaInfoStruct.decodeTlv(castingValue);
94669466
}
94679467
}
94689468
}
94699469
return new ServiceAreaClusterAreaStruct(
94709470
areaID,
94719471
mapID,
9472-
areaDesc
9472+
areaInfo
94739473
);
94749474
}
94759475

@@ -9483,8 +9483,8 @@ public String toString() {
94839483
output.append("\tmapID: ");
94849484
output.append(mapID);
94859485
output.append("\n");
9486-
output.append("\tareaDesc: ");
9487-
output.append(areaDesc);
9486+
output.append("\tareaInfo: ");
9487+
output.append(areaInfo);
94889488
output.append("\n");
94899489
output.append("}\n");
94909490
return output.toString();

0 commit comments

Comments
 (0)