Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[cluster] Move LevelControl cluster to a dedicated file #24717

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,12 @@ jobs:
src/app/zap-templates/zcl/data-model/chip/general-commissioning-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/general-diagnostics-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/global-attributes.xml \
src/app/zap-templates/zcl/data-model/chip/groups-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/group-key-mgmt-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/identify-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/illuminance-measurement-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/keypad-input-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/level-control-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/localization-configuration-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/low-power-cluster.xml \
src/app/zap-templates/zcl/data-model/chip/media-input-cluster.xml \
Expand Down
2 changes: 2 additions & 0 deletions scripts/rules.matterlint
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,12 @@ load "../src/app/zap-templates/zcl/data-model/chip/flow-measurement-cluster.xml"
load "../src/app/zap-templates/zcl/data-model/chip/general-commissioning-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/general-diagnostics-cluster.xml";
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/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";
load "../src/app/zap-templates/zcl/data-model/chip/level-control-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/localization-configuration-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/low-power-cluster.xml";
load "../src/app/zap-templates/zcl/data-model/chip/matter-devices.xml";
Expand Down
2 changes: 1 addition & 1 deletion scripts/tests/chiptest/yamltest_with_chip_repl_tester.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def _StackShutDown():

# Some still-silabs clusters
_CLUSTER_XML_DIRECTORY_PATH + '/silabs/ha.xml', # For fan control
_CLUSTER_XML_DIRECTORY_PATH + '/silabs/general.xml', # For groups cluster
_CLUSTER_XML_DIRECTORY_PATH + '/silabs/general.xml', # For LevelControl cluster
])

# Parsing YAML test and setting up chip-repl yamltests runner.
Expand Down
2 changes: 2 additions & 0 deletions src/app/zap-templates/zcl/data-model/all.xml
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@
<xi:include href="chip/general-commissioning-cluster.xml" />
<xi:include href="chip/general-diagnostics-cluster.xml" />
<xi:include href="chip/global-attributes.xml" />
<xi:include href="chip/groups-cluster.xml" />
<xi:include href="chip/group-key-mgmt-cluster.xml" />
<xi:include href="chip/identify-cluster.xml" />
<xi:include href="chip/illuminance-measurement-cluster.xml" />
<xi:include href="chip/level-control-cluster.xml" />
<xi:include href="chip/keypad-input-cluster.xml" />
<xi:include href="chip/localization-configuration-cluster.xml" />
<xi:include href="chip/low-power-cluster.xml" />
Expand Down
115 changes: 115 additions & 0 deletions src/app/zap-templates/zcl/data-model/chip/groups-cluster.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<?xml version="1.0"?>
<!--
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.
-->
<configurator>
<domain name="General"/>

<cluster>
<name>Groups</name>
<domain>General</domain>
<description>Attributes and commands for group configuration and manipulation.</description>
<code>0x0004</code>
<define>GROUPS_CLUSTER</define>

<client init="false" tick="false">true</client>
<server init="false" tick="false">true</server>

<globalAttribute side="either" code="0xFFFD" value="4"/>

<attribute side="server" code="0x0000" define="GROUP_NAME_SUPPORT" type="BITMAP8" min="0x00" max="0x80" writable="false" optional="false">NameSupport</attribute>

<!-- NAME_SUPPORT -->
<command source="client" code="0x00" name="AddGroup" response="AddGroupResponse" isFabricScoped="true" optional="false" cli="zcl groups add">
<description>
Command description for AddGroup
</description>
<access op="invoke" role="manage"/>
<arg name="GroupID" type="group_id"/>
<arg name="GroupName" type="CHAR_STRING"/>
</command>

<command source="client" code="0x01" name="ViewGroup" response="ViewGroupResponse" isFabricScoped="true" optional="false" cli="zcl groups view">
<description>
Command description for ViewGroup
</description>
<arg name="GroupID" type="group_id"/>
</command>

<command source="client" code="0x02" name="GetGroupMembership" response="GetGroupMembershipResponse" cliFunctionName="zclGroupsGetCommand" isFabricScoped="true" optional="false" cli="zcl groups get">
<description>
Command description for GetGroupMembership
</description>
<arg name="GroupList" type="group_id" array="true"/>
</command>

<command source="client" code="0x03" name="RemoveGroup" response="RemoveGroupResponse" isFabricScoped="true" optional="false" cli="zcl groups remove">
<description>
Command description for RemoveGroup
</description>
<access op="invoke" role="manage"/>
<arg name="GroupID" type="group_id"/>
</command>

<command source="client" code="0x04" name="RemoveAllGroups" isFabricScoped="true" optional="false" cli="zcl groups rmall">
<description>
Command description for RemoveAllGroups
</description>
<access op="invoke" role="manage"/>
</command>

<command source="client" code="0x05" name="AddGroupIfIdentifying" isFabricScoped="true" optional="false" cli="zcl groups add-if-id">
<description>
Command description for AddGroupIfIdentifying
</description>
<access op="invoke" role="manage"/>
<arg name="GroupID" type="group_id"/>
<arg name="GroupName" type="CHAR_STRING"/>
</command>

<command source="server" code="0x00" name="AddGroupResponse" optional="false" disableDefaultResponse="true">
<description>
Command description for AddGroupResponse
</description>
<arg name="Status" type="ENUM8"/>
<arg name="GroupID" type="group_id"/>
</command>

<command source="server" code="0x01" name="ViewGroupResponse" optional="false" disableDefaultResponse="true">
<description>
Command description for ViewGroupResponse
</description>
<arg name="Status" type="ENUM8"/>
<arg name="GroupID" type="group_id"/>
<arg name="GroupName" type="CHAR_STRING"/>
</command>

<command source="server" code="0x02" name="GetGroupMembershipResponse" optional="false" disableDefaultResponse="true">
<description>
Command description for GetGroupMembershipResponse
</description>
<arg name="Capacity" type="INT8U" isNullable="true"/>
<arg name="GroupList" type="group_id" array="true"/>
</command>

<command source="server" code="0x03" name="RemoveGroupResponse" optional="false" disableDefaultResponse="true">
<description>
Command description for RemoveGroupResponse
</description>
<arg name="Status" type="ENUM8"/>
<arg name="GroupID" type="group_id"/>
</command>
</cluster>
</configurator>
156 changes: 156 additions & 0 deletions src/app/zap-templates/zcl/data-model/chip/level-control-cluster.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
<?xml version="1.0"?>
<!--
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.
-->
<configurator>
<domain name="General"/>

<enum name="MoveMode" type="ENUM8">
<cluster code="0x0008"/>
<item name="Up" value="0x0"/>
<item name="Down" value="0x1"/>
</enum>

<enum name="StepMode" type="ENUM8">
<cluster code="0x0008"/>
<item name="Up" value="0x0"/>
<item name="Down" value="0x1"/>
</enum>

<bitmap name="LevelControlOptions" type="BITMAP8">
<cluster code="0x0008"/>
<field name="ExecuteIfOff" mask="0x1"/>
<field name="CoupleColorTempToLevel" mask="0x02"/>
</bitmap>

<cluster>
<name>Level Control</name>
<domain>General</domain>
<description>Attributes and commands for controlling devices that can be set to a level between fully 'On' and fully 'Off.'</description>
<code>0x0008</code>
<define>LEVEL_CONTROL_CLUSTER</define>

<client tick="false" init="false">true</client>
<server tick="false" init="false">true</server>

<globalAttribute side="either" code="0xFFFD" value="5"/>

<attribute side="server" code="0x0000" define="CURRENT_LEVEL" type="INT8U" isNullable="true" writable="false" default="0x00" optional="false">CurrentLevel</attribute>
<attribute side="server" code="0x0001" define="LEVEL_CONTROL_REMAINING_TIME" type="INT16U" min="0x0000" max="0xFFFF" writable="false" default="0x0000" optional="true">RemainingTime</attribute>
<attribute side="server" code="0x0002" define="MINIMUM_LEVEL" type="INT8U" min="0x00" max="0xFF" writable="false" default="0x00" optional="true">MinLevel</attribute>
<attribute side="server" code="0x0003" define="MAXIMUM_LEVEL" type="INT8U" min="0x00" max="0xFF" writable="false" default="0xFE" optional="true">MaxLevel</attribute>
<attribute side="server" code="0x0004" define="CURRENT_FREQUENCY" type="INT16U" min="0x0000" max="0xFFFF" writable="false" default="0x0000" optional="true">CurrentFrequency</attribute>
<attribute side="server" code="0x0005" define="MIN_FREQUENCY" type="INT16U" min="0x0000" max="0xFFFF" writable="false" default="0x0000" optional="true">MinFrequency</attribute>
<attribute side="server" code="0x0006" define="MAX_FREQUENCY" type="INT16U" min="0x0000" max="0xFFFF" writable="false" default="0x0000" optional="true">MaxFrequency</attribute>

<attribute side="server" code="0x0010" define="ON_OFF_TRANSITION_TIME" type="INT16U" writable="true" default="0x0000" optional="true">OnOffTransitionTime</attribute>
<attribute side="server" code="0x0011" define="ON_LEVEL" type="INT8U" isNullable="true" writable="true" optional="false">OnLevel</attribute>
<attribute side="server" code="0x0012" define="ON_TRANSITION_TIME" type="INT16U" isNullable="true" writable="true" optional="true">OnTransitionTime</attribute>
<attribute side="server" code="0x0013" define="OFF_TRANSITION_TIME" type="INT16U" isNullable="true" writable="true" optional="true">OffTransitionTime</attribute>
<attribute side="server" code="0x0014" define="DEFAULT_MOVE_RATE" type="INT8U" isNullable="true" writable="true" optional="true">DefaultMoveRate</attribute>
<attribute side="server" code="0x000F" define="OPTIONS" type="LevelControlOptions" min="0x00" max="0x03" writable="true" default="0x00" optional="false">Options</attribute>
<attribute side="server" code="0x4000" define="START_UP_CURRENT_LEVEL" type="INT8U" isNullable="true" writable="true" optional="true">
<description>StartUpCurrentLevel</description>
<access op="read" role="view"/>
<access op="write" role="manage"/>
</attribute>

<command source="client" code="0x00" name="MoveToLevel" optional="false" cli="zcl level-control mv-to-level">
<description>
Command description for MoveToLevel
</description>
<arg name="Level" type="INT8U"/>
<arg name="TransitionTime" type="INT16U" isNullable="true"/>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x01" name="Move" optional="false" cli="zcl level-control move">
<description>
Command description for Move
</description>
<arg name="MoveMode" type="MoveMode"/>
<arg name="Rate" type="INT8U" isNullable="true"/>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x02" name="Step" optional="false" cli="zcl level-control step">
<description>
Command description for Step
</description>
<arg name="StepMode" type="StepMode"/>
<arg name="StepSize" type="INT8U"/>
<arg name="TransitionTime" type="INT16U" isNullable="true"/>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x03" name="Stop" optional="false" cli="zcl level-control stop">
<description>
Command description for Stop
</description>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x04" name="MoveToLevelWithOnOff" optional="false" cli="zcl level-control o-mv-to-level">
<description>
Command description for MoveToLevelWithOnOff
</description>
<arg name="Level" type="INT8U"/>
<arg name="TransitionTime" type="INT16U" isNullable="true"/>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x05" name="MoveWithOnOff" optional="false" cli="zcl level-control o-move">
<description>
Command description for MoveWithOnOff
</description>
<arg name="MoveMode" type="MoveMode"/>
<arg name="Rate" type="INT8U" isNullable="true"/>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x06" name="StepWithOnOff" optional="false" cli="zcl level-control o-step">
<description>
Command description for StepWithOnOff
</description>
<arg name="StepMode" type="StepMode"/>
<arg name="StepSize" type="INT8U"/>
<arg name="TransitionTime" type="INT16U" isNullable="true"/>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x07" name="StopWithOnOff" optional="false" cli="zcl level-control o-stop">
<description>
Command description for StopWithOnOff
</description>
<arg name="OptionsMask" type="LevelControlOptions"/>
<arg name="OptionsOverride" type="LevelControlOptions"/>
</command>

<command source="client" code="0x08" name="MoveToClosestFrequency" optional="true">
<description>
Change the currrent frequency to the provided one, or a close
approximation if the exact provided one is not possible.
</description>
<arg name="Frequency" type="INT16U"/>
</command>
</cluster>
</configurator>
Loading