Skip to content

Commit

Permalink
Add provisional and internal markers cluster-wide (project-chip#29765)
Browse files Browse the repository at this point in the history
* Update cluster data with api maturity

* Pull in latest zap that supports api maturity

* mark scenes provisional, mark unit testing and fault injection as internal

* Mark more clusters as provisional

* Undo domain move

* Undo submodule change

* make the scenes domain identical with how it was

* Restyle

---------

Co-authored-by: Andrei Litvin <[email protected]>
  • Loading branch information
2 people authored and HunsupJung committed Oct 23, 2023
1 parent dda294a commit 1457bef
Show file tree
Hide file tree
Showing 24 changed files with 37 additions and 36 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down Expand Up @@ -4183,7 +4183,7 @@ server cluster Thermostat = 513 {
}

/** An interface for controlling a fan in a heating/cooling system. */
server cluster FanControl = 514 {
provisional server cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down Expand Up @@ -4574,7 +4574,7 @@ server cluster ColorControl = 768 {
}

/** Attributes and commands for configuring a lighting ballast. */
server cluster BallastConfiguration = 769 {
provisional server cluster BallastConfiguration = 769 {
bitmap BallastStatusBitmap : BITMAP8 {
kBallastNonOperational = 0x1;
kLampFailure = 0x2;
Expand Down Expand Up @@ -5310,7 +5310,7 @@ server cluster ElectricalMeasurement = 2820 {
}

/** The Test Cluster is meant to validate the generated code */
server cluster UnitTesting = 4294048773 {
internal server cluster UnitTesting = 4294048773 {
enum SimpleEnum : ENUM8 {
kUnspecified = 0;
kValueA = 1;
Expand Down Expand Up @@ -5632,7 +5632,7 @@ server cluster UnitTesting = 4294048773 {
}

/** The Fault Injection Cluster provide a means for a test harness to configure faults(for example triggering a fault in the system). */
server cluster FaultInjection = 4294048774 {
internal server cluster FaultInjection = 4294048774 {
enum FaultType : ENUM8 {
kUnspecified = 0;
kSystemFault = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down Expand Up @@ -2819,7 +2819,7 @@ server cluster Thermostat = 513 {
}

/** An interface for controlling a fan in a heating/cooling system. */
server cluster FanControl = 514 {
provisional server cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down Expand Up @@ -2978,7 +2978,7 @@ server cluster ColorControl = 768 {
}

/** Attributes and commands for configuring a lighting ballast. */
server cluster BallastConfiguration = 769 {
provisional server cluster BallastConfiguration = 769 {
bitmap BallastStatusBitmap : BITMAP8 {
kBallastNonOperational = 0x1;
kLampFailure = 0x2;
Expand Down Expand Up @@ -3654,7 +3654,7 @@ server cluster AccountLogin = 1294 {
}

/** The Test Cluster is meant to validate the generated code */
server cluster UnitTesting = 4294048773 {
internal server cluster UnitTesting = 4294048773 {
enum SimpleEnum : ENUM8 {
kUnspecified = 0;
kValueA = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1088,7 +1088,7 @@ server cluster Thermostat = 513 {
}

/** An interface for controlling a fan in a heating/cooling system. */
server cluster FanControl = 514 {
provisional server cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down
2 changes: 1 addition & 1 deletion examples/chef/devices/rootnode_fan_7N2TobIlOX.matter
Original file line number Diff line number Diff line change
Expand Up @@ -1139,7 +1139,7 @@ server cluster FixedLabel = 64 {
}

/** An interface for controlling a fan in a heating/cooling system. */
server cluster FanControl = 514 {
provisional server cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1453,7 +1453,7 @@ client cluster Thermostat = 513 {
}

/** An interface for controlling a fan in a heating/cooling system. */
server cluster FanControl = 514 {
provisional server cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1019,7 +1019,7 @@ server cluster Thermostat = 513 {
}

/** An interface for controlling a fan in a heating/cooling system. */
server cluster FanControl = 514 {
provisional server cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1261,7 +1261,7 @@ server cluster Thermostat = 513 {
}

/** An interface for controlling a fan in a heating/cooling system. */
client cluster FanControl = 514 {
provisional client cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
client cluster Scenes = 5 {
provisional client cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
2 changes: 1 addition & 1 deletion examples/lighting-app/lighting-common/lighting-app.matter
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
2 changes: 1 addition & 1 deletion examples/placeholder/linux/apps/app1/config.matter
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
2 changes: 1 addition & 1 deletion examples/placeholder/linux/apps/app2/config.matter
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1579,7 +1579,7 @@ server cluster ActivatedCarbonFilterMonitoring = 114 {
}

/** An interface for controlling a fan in a heating/cooling system. */
server cluster FanControl = 514 {
provisional server cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ server cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
server cluster Scenes = 5 {
provisional server cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down
1 change: 1 addition & 0 deletions src/app/zap-templates/partials/idl/cluster_definition.zapt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
/** {{description}} */
{{#if apiMaturity}}{{apiMaturity}} {{/if~}}
{{#if generateClientCluster}}client {{else}}server {{/if~}}
cluster {{asUpperCamelCase name}} = {{!}}
{{~#if manufacturerCode}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ limitations under the License.
<field name="LampBurnHours" mask="0x01"/>
</bitmap>

<cluster>
<cluster apiMaturity="provisional">
<name>Ballast Configuration</name>
<domain>Lighting</domain>
<description>Attributes and commands for configuring a lighting ballast.</description>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ limitations under the License.
<item name="Reverse" value="0x01"/>
</enum>

<cluster>
<cluster apiMaturity="provisional">
<name>Fan Control</name>
<domain>HVAC</domain>
<description>An interface for controlling a fan in a heating/cooling system.</description>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ limitations under the License.
<item name="ChipFault" value="0x03"/>
<item name="CertFault" value="0x04"/>
</enum>
<cluster>
<cluster apiMaturity="internal">
<domain>CHIP</domain>
<name>Fault Injection</name>
<code>0xFFF1FC06</code>
Expand Down
4 changes: 2 additions & 2 deletions src/app/zap-templates/zcl/data-model/chip/pwm-cluster.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ limitations under the License.
<configurator>
<domain name="CHIP" />

<cluster>
<cluster apiMaturity="provisional">
<domain>General</domain>
<name>Pulse Width Modulation</name>
<code>0x001c</code>
<define>PWM_CLUSTER</define>
<description>Cluster to control pulse width modulation</description>
</cluster>
</configurator>
</configurator>
2 changes: 1 addition & 1 deletion src/app/zap-templates/zcl/data-model/chip/scene.xml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ limitations under the License.
</struct>

<domain name="CHIP"/>
<cluster>
<cluster apiMaturity="provisional">
<name>Scenes</name>
<domain>General</domain>
<description>Attributes and commands for scene configuration and manipulation.</description>
Expand Down
2 changes: 1 addition & 1 deletion src/app/zap-templates/zcl/data-model/chip/test-cluster.xml
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ limitations under the License.
<field mask="0x4000000000000000" name="MaskVal4" />
</bitmap>

<cluster>
<cluster apiMaturity="internal">
<domain>CHIP</domain>
<name>Unit Testing</name>
<code>0xFFF1FC05</code>
Expand Down
12 changes: 6 additions & 6 deletions src/controller/data_model/controller-clusters.matter
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ client cluster Groups = 4 {
}

/** Attributes and commands for scene configuration and manipulation. */
client cluster Scenes = 5 {
provisional client cluster Scenes = 5 {
bitmap Feature : BITMAP32 {
kSceneNames = 0x1;
kExplicit = 0x2;
Expand Down Expand Up @@ -526,7 +526,7 @@ client cluster BinaryInputBasic = 15 {
}

/** Cluster to control pulse width modulation */
client cluster PulseWidthModulation = 28 {
provisional client cluster PulseWidthModulation = 28 {
readonly attribute command_id generatedCommandList[] = 65528;
readonly attribute command_id acceptedCommandList[] = 65529;
readonly attribute event_id eventList[] = 65530;
Expand Down Expand Up @@ -4630,7 +4630,7 @@ client cluster Thermostat = 513 {
}

/** An interface for controlling a fan in a heating/cooling system. */
client cluster FanControl = 514 {
provisional client cluster FanControl = 514 {
enum AirflowDirectionEnum : ENUM8 {
kForward = 0;
kReverse = 1;
Expand Down Expand Up @@ -5041,7 +5041,7 @@ client cluster ColorControl = 768 {
}

/** Attributes and commands for configuring a lighting ballast. */
client cluster BallastConfiguration = 769 {
provisional client cluster BallastConfiguration = 769 {
bitmap BallastStatusBitmap : BITMAP8 {
kBallastNonOperational = 0x1;
kLampFailure = 0x2;
Expand Down Expand Up @@ -6572,7 +6572,7 @@ client cluster ElectricalMeasurement = 2820 {
}

/** The Test Cluster is meant to validate the generated code */
client cluster UnitTesting = 4294048773 {
internal client cluster UnitTesting = 4294048773 {
enum SimpleEnum : ENUM8 {
kUnspecified = 0;
kValueA = 1;
Expand Down Expand Up @@ -7018,7 +7018,7 @@ client cluster UnitTesting = 4294048773 {
}

/** The Fault Injection Cluster provide a means for a test harness to configure faults(for example triggering a fault in the system). */
client cluster FaultInjection = 4294048774 {
internal client cluster FaultInjection = 4294048774 {
enum FaultType : ENUM8 {
kUnspecified = 0;
kSystemFault = 1;
Expand Down

0 comments on commit 1457bef

Please sign in to comment.