project-chip/connectedhomeip

Support "specification name" across more items within the SDK

Open

#38,891 opened on May 12, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (6,410 stars) (1,659 forks)batch import
good first issuestale

Description

The ZAP templates vary usage of asUpperCamelCase and asUpperCamelCase preserveAcronyms=true and code generation is inconsistent for acronym handling (e.g. C++ and darwin differ).

When preserveAcronyms makes a difference, we should preserve the XML name (with spaces and special characters and all) so that code generation can make a decision on how to encode things.

https://github.com/project-chip/connectedhomeip/pull/38888 adds support for constant names. We should go beyond that:

  • determine a good syntax throughout (for enums/bitmaps/struct/command names, structure member names, cluster names)
  • apply this syntax to update clusters. It is likely constants are the main ones affected though. May need to manually validate (e.g. using the Unit testing cluster)

Contributor guide

Tech stack
cpp
Domain
toolingbuild system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of Matter SDK cluster definitionsFamiliarity with ZAP code generation templates
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review the linked PR #38888 to understand the approach for constant names. Determine a consistent syntax for specification names across enums, bitmaps, structs, commands, structure members, and cluster names. Apply the syntax to update clusters, manually validating using the Unit testing cluster. Focus on acronym handling to ensure code generation consistency.