Remove unused return value from read_message and fix ifdef placement in generated API code

2025-10-31 07:03:55 +00:00 · 2025-06-28 21:08:41 -05:00
parent 86c0fb48a3
commit e27094e0f3
3 changed files with 96 additions and 97 deletions
--- a/esphome/components/api/api_pb2_service.cpp
+++ b/esphome/components/api/api_pb2_service.cpp
@@ -14,7 +14,7 @@ void APIServerConnectionBase::log_send_message_(const char *name, const std::str
 }
 #endif

-bool APIServerConnectionBase::read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) {
+void APIServerConnectionBase::read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) {
  switch (msg_type) {
    case 1: {
      HelloRequest msg;
@@ -106,50 +106,50 @@ bool APIServerConnectionBase::read_message(uint32_t msg_size, uint32_t msg_type,
      this->on_subscribe_logs_request(msg);
      break;
    }
-    case 30: {
 #ifdef USE_COVER
+    case 30: {
      CoverCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_cover_command_request: %s", msg.dump().c_str());
 #endif
      this->on_cover_command_request(msg);
-#endif
      break;
    }
-    case 31: {
+#endif
 #ifdef USE_FAN
+    case 31: {
      FanCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_fan_command_request: %s", msg.dump().c_str());
 #endif
      this->on_fan_command_request(msg);
-#endif
      break;
    }
-    case 32: {
+#endif
 #ifdef USE_LIGHT
+    case 32: {
      LightCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_light_command_request: %s", msg.dump().c_str());
 #endif
      this->on_light_command_request(msg);
-#endif
      break;
    }
-    case 33: {
+#endif
 #ifdef USE_SWITCH
+    case 33: {
      SwitchCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_switch_command_request: %s", msg.dump().c_str());
 #endif
      this->on_switch_command_request(msg);
-#endif
      break;
    }
+#endif
    case 34: {
      SubscribeHomeassistantServicesRequest msg;
      msg.decode(msg_data, msg_size);
@@ -204,395 +204,394 @@ bool APIServerConnectionBase::read_message(uint32_t msg_size, uint32_t msg_type,
      this->on_execute_service_request(msg);
      break;
    }
-    case 45: {
 #ifdef USE_ESP32_CAMERA
+    case 45: {
      CameraImageRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_camera_image_request: %s", msg.dump().c_str());
 #endif
      this->on_camera_image_request(msg);
-#endif
      break;
    }
-    case 48: {
+#endif
 #ifdef USE_CLIMATE
+    case 48: {
      ClimateCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_climate_command_request: %s", msg.dump().c_str());
 #endif
      this->on_climate_command_request(msg);
-#endif
      break;
    }
-    case 51: {
+#endif
 #ifdef USE_NUMBER
+    case 51: {
      NumberCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_number_command_request: %s", msg.dump().c_str());
 #endif
      this->on_number_command_request(msg);
-#endif
      break;
    }
-    case 54: {
+#endif
 #ifdef USE_SELECT
+    case 54: {
      SelectCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_select_command_request: %s", msg.dump().c_str());
 #endif
      this->on_select_command_request(msg);
-#endif
      break;
    }
-    case 57: {
+#endif
 #ifdef USE_SIREN
+    case 57: {
      SirenCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_siren_command_request: %s", msg.dump().c_str());
 #endif
      this->on_siren_command_request(msg);
-#endif
      break;
    }
-    case 60: {
+#endif
 #ifdef USE_LOCK
+    case 60: {
      LockCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_lock_command_request: %s", msg.dump().c_str());
 #endif
      this->on_lock_command_request(msg);
-#endif
      break;
    }
-    case 62: {
+#endif
 #ifdef USE_BUTTON
+    case 62: {
      ButtonCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_button_command_request: %s", msg.dump().c_str());
 #endif
      this->on_button_command_request(msg);
-#endif
      break;
    }
-    case 65: {
+#endif
 #ifdef USE_MEDIA_PLAYER
+    case 65: {
      MediaPlayerCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_media_player_command_request: %s", msg.dump().c_str());
 #endif
      this->on_media_player_command_request(msg);
-#endif
      break;
    }
-    case 66: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 66: {
      SubscribeBluetoothLEAdvertisementsRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_subscribe_bluetooth_le_advertisements_request: %s", msg.dump().c_str());
 #endif
      this->on_subscribe_bluetooth_le_advertisements_request(msg);
-#endif
      break;
    }
-    case 68: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 68: {
      BluetoothDeviceRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_device_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_device_request(msg);
-#endif
      break;
    }
-    case 70: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 70: {
      BluetoothGATTGetServicesRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_gatt_get_services_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_gatt_get_services_request(msg);
-#endif
      break;
    }
-    case 73: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 73: {
      BluetoothGATTReadRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_gatt_read_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_gatt_read_request(msg);
-#endif
      break;
    }
-    case 75: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 75: {
      BluetoothGATTWriteRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_gatt_write_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_gatt_write_request(msg);
-#endif
      break;
    }
-    case 76: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 76: {
      BluetoothGATTReadDescriptorRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_gatt_read_descriptor_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_gatt_read_descriptor_request(msg);
-#endif
      break;
    }
-    case 77: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 77: {
      BluetoothGATTWriteDescriptorRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_gatt_write_descriptor_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_gatt_write_descriptor_request(msg);
-#endif
      break;
    }
-    case 78: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 78: {
      BluetoothGATTNotifyRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_gatt_notify_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_gatt_notify_request(msg);
-#endif
      break;
    }
-    case 80: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 80: {
      SubscribeBluetoothConnectionsFreeRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_subscribe_bluetooth_connections_free_request: %s", msg.dump().c_str());
 #endif
      this->on_subscribe_bluetooth_connections_free_request(msg);
-#endif
      break;
    }
-    case 87: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 87: {
      UnsubscribeBluetoothLEAdvertisementsRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_unsubscribe_bluetooth_le_advertisements_request: %s", msg.dump().c_str());
 #endif
      this->on_unsubscribe_bluetooth_le_advertisements_request(msg);
-#endif
      break;
    }
-    case 89: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 89: {
      SubscribeVoiceAssistantRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_subscribe_voice_assistant_request: %s", msg.dump().c_str());
 #endif
      this->on_subscribe_voice_assistant_request(msg);
-#endif
      break;
    }
-    case 91: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 91: {
      VoiceAssistantResponse msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_voice_assistant_response: %s", msg.dump().c_str());
 #endif
      this->on_voice_assistant_response(msg);
-#endif
      break;
    }
-    case 92: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 92: {
      VoiceAssistantEventResponse msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_voice_assistant_event_response: %s", msg.dump().c_str());
 #endif
      this->on_voice_assistant_event_response(msg);
-#endif
      break;
    }
-    case 96: {
+#endif
 #ifdef USE_ALARM_CONTROL_PANEL
+    case 96: {
      AlarmControlPanelCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_alarm_control_panel_command_request: %s", msg.dump().c_str());
 #endif
      this->on_alarm_control_panel_command_request(msg);
-#endif
      break;
    }
-    case 99: {
+#endif
 #ifdef USE_TEXT
+    case 99: {
      TextCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_text_command_request: %s", msg.dump().c_str());
 #endif
      this->on_text_command_request(msg);
-#endif
      break;
    }
-    case 102: {
+#endif
 #ifdef USE_DATETIME_DATE
+    case 102: {
      DateCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_date_command_request: %s", msg.dump().c_str());
 #endif
      this->on_date_command_request(msg);
-#endif
      break;
    }
-    case 105: {
+#endif
 #ifdef USE_DATETIME_TIME
+    case 105: {
      TimeCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_time_command_request: %s", msg.dump().c_str());
 #endif
      this->on_time_command_request(msg);
-#endif
      break;
    }
-    case 106: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 106: {
      VoiceAssistantAudio msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_voice_assistant_audio: %s", msg.dump().c_str());
 #endif
      this->on_voice_assistant_audio(msg);
-#endif
      break;
    }
-    case 111: {
+#endif
 #ifdef USE_VALVE
+    case 111: {
      ValveCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_valve_command_request: %s", msg.dump().c_str());
 #endif
      this->on_valve_command_request(msg);
-#endif
      break;
    }
-    case 114: {
+#endif
 #ifdef USE_DATETIME_DATETIME
+    case 114: {
      DateTimeCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_date_time_command_request: %s", msg.dump().c_str());
 #endif
      this->on_date_time_command_request(msg);
-#endif
      break;
    }
-    case 115: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 115: {
      VoiceAssistantTimerEventResponse msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_voice_assistant_timer_event_response: %s", msg.dump().c_str());
 #endif
      this->on_voice_assistant_timer_event_response(msg);
-#endif
      break;
    }
-    case 118: {
+#endif
 #ifdef USE_UPDATE
+    case 118: {
      UpdateCommandRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_update_command_request: %s", msg.dump().c_str());
 #endif
      this->on_update_command_request(msg);
-#endif
      break;
    }
-    case 119: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 119: {
      VoiceAssistantAnnounceRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_voice_assistant_announce_request: %s", msg.dump().c_str());
 #endif
      this->on_voice_assistant_announce_request(msg);
-#endif
      break;
    }
-    case 121: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 121: {
      VoiceAssistantConfigurationRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_voice_assistant_configuration_request: %s", msg.dump().c_str());
 #endif
      this->on_voice_assistant_configuration_request(msg);
-#endif
      break;
    }
-    case 123: {
+#endif
 #ifdef USE_VOICE_ASSISTANT
+    case 123: {
      VoiceAssistantSetConfiguration msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_voice_assistant_set_configuration: %s", msg.dump().c_str());
 #endif
      this->on_voice_assistant_set_configuration(msg);
-#endif
      break;
    }
-    case 124: {
+#endif
 #ifdef USE_API_NOISE
+    case 124: {
      NoiseEncryptionSetKeyRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_noise_encryption_set_key_request: %s", msg.dump().c_str());
 #endif
      this->on_noise_encryption_set_key_request(msg);
-#endif
      break;
    }
-    case 127: {
+#endif
 #ifdef USE_BLUETOOTH_PROXY
+    case 127: {
      BluetoothScannerSetModeRequest msg;
      msg.decode(msg_data, msg_size);
 #ifdef HAS_PROTO_MESSAGE_DUMP
      ESP_LOGVV(TAG, "on_bluetooth_scanner_set_mode_request: %s", msg.dump().c_str());
 #endif
      this->on_bluetooth_scanner_set_mode_request(msg);
-#endif
      break;
    }
+#endif
    default:
-      return false;
+      break;
  }
-  return true;
 }

 void APIServerConnection::on_hello_request(const HelloRequest &msg) {
--- a/esphome/components/api/api_pb2_service.h
+++ b/esphome/components/api/api_pb2_service.h
@@ -199,7 +199,7 @@ class APIServerConnectionBase : public ProtoService {
  virtual void on_update_command_request(const UpdateCommandRequest &value){};
 #endif
 protected:
-  bool read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) override;
+  void read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) override;
 };

 class APIServerConnection : public APIServerConnectionBase {
--- a/script/api_protobuf/api_protobuf.py
+++ b/script/api_protobuf/api_protobuf.py
@@ -1034,7 +1034,7 @@ SOURCE_BOTH = 0
 SOURCE_SERVER = 1
 SOURCE_CLIENT = 2

-RECEIVE_CASES: dict[int, str] = {}
+RECEIVE_CASES: dict[int, tuple[str, str | None]] = {}

 ifdefs: dict[str, str] = {}

@@ -1208,8 +1208,6 @@ def build_service_message_type(
        func = f"on_{snake}"
        hout += f"virtual void {func}(const {mt.name} &value){{}};\n"
        case = ""
-        if ifdef is not None:
-            case += f"#ifdef {ifdef}\n"
        case += f"{mt.name} msg;\n"
        case += "msg.decode(msg_data, msg_size);\n"
        if log:
@@ -1217,10 +1215,9 @@ def build_service_message_type(
            case += f'ESP_LOGVV(TAG, "{func}: %s", msg.dump().c_str());\n'
            case += "#endif\n"
        case += f"this->{func}(msg);\n"
-        if ifdef is not None:
-            case += "#endif\n"
        case += "break;"
-        RECEIVE_CASES[id_] = case
+        # Store the ifdef with the case for later use
+        RECEIVE_CASES[id_] = (case, ifdef)

        # Only close ifdef if we opened it
        if ifdef is not None:
@@ -1379,18 +1376,21 @@ def main() -> None:
    cases = list(RECEIVE_CASES.items())
    cases.sort()
    hpp += " protected:\n"
-    hpp += "  bool read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) override;\n"
-    out = f"bool {class_name}::read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) {{\n"
+    hpp += "  void read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) override;\n"
+    out = f"void {class_name}::read_message(uint32_t msg_size, uint32_t msg_type, uint8_t *msg_data) {{\n"
    out += "  switch (msg_type) {\n"
-    for i, case in cases:
-        c = f"case {i}: {{\n"
-        c += indent(case) + "\n"
-        c += "}"
-        out += indent(c, "    ") + "\n"
+    for i, (case, ifdef) in cases:
+        if ifdef is not None:
+            out += f"#ifdef {ifdef}\n"
+        c = f"    case {i}: {{\n"
+        c += indent(case, "      ") + "\n"
+        c += "    }"
+        out += c + "\n"
+        if ifdef is not None:
+            out += "#endif\n"
    out += "    default:\n"
-    out += "      return false;\n"
+    out += "      break;\n"
    out += "  }\n"
-    out += "  return true;\n"
    out += "}\n"
    cpp += out
    hpp += "};\n"