Rename CecKeyCode to CecKeyCodeEnum to match spec (project-chip#30497)

* Rename CecKeyCode to CecKeyCodeEnum to match spec * Fix PR number * Ran zap_convert_all.py * Restyle * Minor change to kick CI * Fix for compilation * Restyle * Mass rename CecKeyCodeEnum to CECKeyCodeEnum * Zap regen * Update Darwin availability annotations. --------- Co-authored-by: Andrei Litvin <[email protected]> Co-authored-by: Boris Zbarsky <[email protected]>
cecille · Nov 20, 2023 · d12edc4 · d12edc4
1 parent 65a10e2
commit d12edc4
Show file tree

Hide file tree

Showing 27 changed files with 487 additions and 129 deletions.
diff --git a/data_model/clusters/KeypadInput.xml b/data_model/clusters/KeypadInput.xml
@@ -72,7 +72,7 @@ Davis, CA 95616, USA
     </feature>
   </features>
   <dataTypes>
-    <enum name="CecKeyCodeEnum">
+    <enum name="CECKeyCodeEnum">
       <item value="0" name="Select">
         <mandatoryConform/>
       </item>
@@ -348,7 +348,7 @@ Davis, CA 95616, USA
     <command id="0x00" name="SendKey" response="SendKeyResponse">
       <access invokePrivilege="operate"/>
       <mandatoryConform/>
-      <field id="0" name="KeyCode" type="CecKeyCodeEnum">
+      <field id="0" name="KeyCode" type="CECKeyCodeEnum">
         <mandatoryConform/>
       </field>
     </command>

diff --git a/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter b/examples/all-clusters-minimal-app/all-clusters-common/all-clusters-minimal-app.matter
@@ -3366,7 +3366,7 @@ server cluster LowPower = 1288 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 server cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -3475,7 +3475,7 @@ server cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {

diff --git a/examples/chef/devices/rootnode_basicvideoplayer_0ff86e943b.matter b/examples/chef/devices/rootnode_basicvideoplayer_0ff86e943b.matter
@@ -1313,7 +1313,7 @@ server cluster LowPower = 1288 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 server cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -1422,7 +1422,7 @@ server cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {

diff --git a/examples/placeholder/linux/apps/app1/config.matter b/examples/placeholder/linux/apps/app1/config.matter
@@ -5829,7 +5829,7 @@ client cluster LowPower = 1288 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 client cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -5938,7 +5938,7 @@ client cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {
@@ -5951,7 +5951,7 @@ client cluster KeypadInput = 1289 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 server cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;

diff --git a/examples/placeholder/linux/apps/app2/config.matter b/examples/placeholder/linux/apps/app2/config.matter
@@ -5788,7 +5788,7 @@ client cluster LowPower = 1288 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 client cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -5897,7 +5897,7 @@ client cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {
@@ -5910,7 +5910,7 @@ client cluster KeypadInput = 1289 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 server cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;

diff --git a/examples/tv-app/android/java/KeypadInputManager.cpp b/examples/tv-app/android/java/KeypadInputManager.cpp
@@ -41,7 +41,7 @@ void KeypadInputManager::NewManager(jint endpoint, jobject manager)
     chip::app::Clusters::KeypadInput::SetDefaultDelegate(static_cast<EndpointId>(endpoint), mgr);
 }
 
-void KeypadInputManager::HandleSendKey(CommandResponseHelper<SendKeyResponseType> & helper, const CecKeyCode & keyCode)
+void KeypadInputManager::HandleSendKey(CommandResponseHelper<SendKeyResponseType> & helper, const CECKeyCodeEnum & keyCode)
 {
     Commands::SendKeyResponse::Type response;
 

diff --git a/examples/tv-app/android/java/KeypadInputManager.h b/examples/tv-app/android/java/KeypadInputManager.h
@@ -32,7 +32,7 @@ class KeypadInputManager : public KeypadInputDelegate
     void InitializeWithObjects(jobject managerObject);
 
     void HandleSendKey(CommandResponseHelper<SendKeyResponseType> & helper,
-                       const chip::app::Clusters::KeypadInput::CecKeyCode & keyCode) override;
+                       const chip::app::Clusters::KeypadInput::CECKeyCodeEnum & keyCode) override;
 
     uint32_t GetFeatureMap(chip::EndpointId endpoint) override;
 

diff --git a/examples/tv-app/tv-common/clusters/keypad-input/KeypadInputManager.h b/examples/tv-app/tv-common/clusters/keypad-input/KeypadInputManager.h
@@ -23,7 +23,7 @@
 using chip::app::CommandResponseHelper;
 using KeypadInputDelegate = chip::app::Clusters::KeypadInput::Delegate;
 using SendKeyResponseType = chip::app::Clusters::KeypadInput::Commands::SendKeyResponse::Type;
-using CecKeyCodeType      = chip::app::Clusters::KeypadInput::CecKeyCode;
+using CecKeyCodeType      = chip::app::Clusters::KeypadInput::CECKeyCodeEnum;
 
 class KeypadInputManager : public KeypadInputDelegate
 {

diff --git a/examples/tv-app/tv-common/tv-app.matter b/examples/tv-app/tv-common/tv-app.matter
@@ -2107,7 +2107,7 @@ server cluster LowPower = 1288 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 server cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -2216,7 +2216,7 @@ server cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {

diff --git a/examples/tv-casting-app/android/App/app/src/main/jni/cpp/TvCastingApp-JNI.cpp b/examples/tv-casting-app/android/App/app/src/main/jni/cpp/TvCastingApp-JNI.cpp
@@ -1663,7 +1663,7 @@ JNI_METHOD(jboolean, keypadInput_1sendKey)
                  ChipLogError(AppServer, "MatterCallbackHandlerJNI.SetUp failed %" CHIP_ERROR_FORMAT, err.Format()));
 
     err = CastingServer::GetInstance()->KeypadInput_SendKey(
-        &endpoint, static_cast<chip::app::Clusters::KeypadInput::CecKeyCode>(keyCode),
+        &endpoint, static_cast<chip::app::Clusters::KeypadInput::CECKeyCodeEnum>(keyCode),
         [](CHIP_ERROR err) { TvCastingAppJNIMgr().getMediaCommandResponseHandler(KeypadInput_SendKey).Handle(err); });
     VerifyOrExit(CHIP_NO_ERROR == err,
                  ChipLogError(AppServer, "CastingServer.KeypadInput_SendKey failed %" CHIP_ERROR_FORMAT, err.Format()));

diff --git a/.../tv-casting-app/darwin/MatterTvCastingBridge/MatterTvCastingBridge/CastingServerBridge.mm b/.../tv-casting-app/darwin/MatterTvCastingBridge/MatterTvCastingBridge/CastingServerBridge.mm
@@ -2154,7 +2154,7 @@ - (void)keypadInput_sendKey:(ContentApp * _Nonnull)contentApp
                                      [ConversionUtils convertToCppTargetEndpointInfoFrom:contentApp outTargetEndpointInfo:endpoint];
 
                                      return castingServer->KeypadInput_SendKey(&endpoint,
-                                         static_cast<chip::app::Clusters::KeypadInput::CecKeyCode>(keyCode), responseFunction);
+                                         static_cast<chip::app::Clusters::KeypadInput::CECKeyCodeEnum>(keyCode), responseFunction);
                                  }];
 }
 

diff --git a/examples/tv-casting-app/tv-casting-common/include/CastingServer.h b/examples/tv-casting-app/tv-casting-common/include/CastingServer.h
@@ -303,7 +303,7 @@ class CastingServer : public AppDelegate
     /**
      * @brief Keypad Input cluster
      */
-    CHIP_ERROR KeypadInput_SendKey(TargetEndpointInfo * endpoint, const chip::app::Clusters::KeypadInput::CecKeyCode keyCode,
+    CHIP_ERROR KeypadInput_SendKey(TargetEndpointInfo * endpoint, const chip::app::Clusters::KeypadInput::CECKeyCodeEnum keyCode,
                                    std::function<void(CHIP_ERROR)> responseCallback);
 
     /**

diff --git a/examples/tv-casting-app/tv-casting-common/include/KeypadInput.h b/examples/tv-casting-app/tv-casting-common/include/KeypadInput.h
@@ -29,5 +29,6 @@ class SendKeyCommand : public MediaCommandBase<chip::app::Clusters::KeypadInput:
 public:
     SendKeyCommand() : MediaCommandBase(chip::app::Clusters::KeypadInput::Id) {}
 
-    CHIP_ERROR Invoke(const chip::app::Clusters::KeypadInput::CecKeyCode keyCode, std::function<void(CHIP_ERROR)> responseCallback);
+    CHIP_ERROR Invoke(const chip::app::Clusters::KeypadInput::CECKeyCodeEnum keyCode,
+                      std::function<void(CHIP_ERROR)> responseCallback);
 };
diff --git a/examples/tv-casting-app/tv-casting-common/src/CastingServer.cpp b/examples/tv-casting-app/tv-casting-common/src/CastingServer.cpp
@@ -1100,7 +1100,7 @@ CHIP_ERROR CastingServer::TargetNavigator_SubscribeToCurrentTarget(
  * @brief Keypad Input cluster
  */
 CHIP_ERROR CastingServer::KeypadInput_SendKey(TargetEndpointInfo * endpoint,
-                                              const chip::app::Clusters::KeypadInput::CecKeyCode keyCode,
+                                              const chip::app::Clusters::KeypadInput::CECKeyCodeEnum keyCode,
                                               std::function<void(CHIP_ERROR)> responseCallback)
 {
     ReturnErrorOnFailure(mSendKeyCommand.SetTarget(mActiveTargetVideoPlayerInfo, endpoint->GetEndpointId()));

diff --git a/examples/tv-casting-app/tv-casting-common/src/KeypadInput.cpp b/examples/tv-casting-app/tv-casting-common/src/KeypadInput.cpp
@@ -21,7 +21,7 @@
 using namespace chip;
 using namespace chip::app::Clusters;
 
-CHIP_ERROR SendKeyCommand::Invoke(const chip::app::Clusters::KeypadInput::CecKeyCode keyCode,
+CHIP_ERROR SendKeyCommand::Invoke(const chip::app::Clusters::KeypadInput::CECKeyCodeEnum keyCode,
                                   std::function<void(CHIP_ERROR)> responseCallback)
 {
     KeypadInput::Commands::SendKey::Type request;

diff --git a/examples/tv-casting-app/tv-casting-common/tv-casting-app.matter b/examples/tv-casting-app/tv-casting-common/tv-casting-app.matter
@@ -1626,7 +1626,7 @@ client cluster LowPower = 1288 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 client cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -1735,7 +1735,7 @@ client cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {

diff --git a/scripts/py_matter_idl/matter_idl/tests/inputs/large_all_clusters_app.matter b/scripts/py_matter_idl/matter_idl/tests/inputs/large_all_clusters_app.matter
@@ -3250,7 +3250,7 @@ server cluster LowPower = 1288 {
 }
 
 server cluster KeypadInput = 1289 {
-  enum CecKeyCode : ENUM8 {
+  enum CECKeyCodeEnum : ENUM8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -3355,7 +3355,7 @@ server cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {

diff --git a/src/app/CompatEnumNames.h b/src/app/CompatEnumNames.h
@@ -19,7 +19,6 @@
  * is meant to be included at the end of cluster-enums.h, after all the normal
  * enum definitions are available.
  */
-
 #pragma once
 
 namespace chip {
@@ -61,6 +60,8 @@ using ApplicationLauncherStatusEnum = StatusEnum;
 namespace KeypadInput {
 // https://github.com/project-chip/connectedhomeip/pull/30316 renamed this
 using KeypadInputStatusEnum = StatusEnum;
+// https://github.com/project-chip/connectedhomeip/pull/30497 renamed this
+using CecKeyCode = CECKeyCodeEnum;
 } // namespace KeypadInput
 
 namespace Channel {

diff --git a/src/app/clusters/keypad-input-server/keypad-input-delegate.h b/src/app/clusters/keypad-input-server/keypad-input-delegate.h
@@ -34,7 +34,7 @@ namespace KeypadInput {
 class Delegate
 {
 public:
-    virtual void HandleSendKey(CommandResponseHelper<Commands::SendKeyResponse::Type> & helper, const CecKeyCode & keyCode) = 0;
+    virtual void HandleSendKey(CommandResponseHelper<Commands::SendKeyResponse::Type> & helper, const CECKeyCodeEnum & keyCode) = 0;
 
     bool HasFeature(chip::EndpointId endpoint, Feature feature);
 

diff --git a/src/app/zap-templates/zcl/data-model/chip/keypad-input-cluster.xml b/src/app/zap-templates/zcl/data-model/chip/keypad-input-cluster.xml
@@ -27,7 +27,7 @@ limitations under the License.
 
     <command source="client" code="0x00" name="SendKey" response="SendKeyResponse" optional="false">
       <description>Upon receipt, this SHALL process a keycode as input to the media device.</description>
-      <arg name="KeyCode" type="CecKeyCode"/>
+      <arg name="KeyCode" type="CECKeyCodeEnum"/>
     </command>
 
     <command source="server" code="0x01" name="SendKeyResponse" optional="false">
@@ -44,7 +44,7 @@ limitations under the License.
     <item name="InvalidKeyInCurrentState" value="0x02"/>
   </enum>
 
-  <enum name="CecKeyCode" type="enum8">
+  <enum name="CECKeyCodeEnum" type="enum8">
     <cluster code="0x0509"/>
     <item name="Select" value="0x00"/>
     <item name="Up" value="0x01"/>

diff --git a/src/controller/data_model/controller-clusters.matter b/src/controller/data_model/controller-clusters.matter
@@ -6582,7 +6582,7 @@ client cluster LowPower = 1288 {
 
 /** This cluster provides an interface for controlling a device like a TV using action commands such as UP, DOWN, and SELECT. */
 client cluster KeypadInput = 1289 {
-  enum CecKeyCode : enum8 {
+  enum CECKeyCodeEnum : enum8 {
     kSelect = 0;
     kUp = 1;
     kDown = 2;
@@ -6691,7 +6691,7 @@ client cluster KeypadInput = 1289 {
   readonly attribute int16u clusterRevision = 65533;
 
   request struct SendKeyRequest {
-    CecKeyCode keyCode = 0;
+    CECKeyCodeEnum keyCode = 0;
   }
 
   response struct SendKeyResponse = 1 {

diff --git a/src/controller/python/chip/clusters/Objects.py b/src/controller/python/chip/clusters/Objects.py