feat(mqtt): make discovery entity IDs match the manual mqtt_sensors.yaml

Prefix the discovery object_id with tesla_ so Home Assistant generates the same
entity IDs as the documented manual configuration (e.g. sensor.tesla_speed
instead of sensor.speed), avoiding broken dashboards and automations on
migration. Drop the _km suffix from the battery range sensors to match the
manual unique_ids. Document that the manual mqtt_sensors.yaml must be removed
before enabling discovery to avoid duplicate unique_id errors. Addresses review
comment on #5543.

Author: brianmay

lib/teslamate/mqtt/pubsub/home_assistant.ex

@@ -47,7 +47,7 @@ defmodule TeslaMate.Mqtt.PubSub.HomeAssistant do
         config
         |> resolve_topics(car_id, namespace)
         |> Map.put(:unique_id, "teslamate_#{car_id}_#{object_id}")
-        |> Map.put(:object_id, object_id)
+        |> Map.put(:object_id, "tesla_#{object_id}")
         |> Map.put(:device, device)
         |> Jason.encode!()
 
@@ -219,23 +219,23 @@ defmodule TeslaMate.Mqtt.PubSub.HomeAssistant do
          unit_of_measurement: "km",
          icon: "mdi:counter"
        }},
-      {"sensor", "est_battery_range_km",
+      {"sensor", "est_battery_range",
        %{
          state_topic_key: :est_battery_range_km,
          name: "Est Battery Range",
          device_class: "distance",
          unit_of_measurement: "km",
          icon: "mdi:gauge"
        }},
-      {"sensor", "rated_battery_range_km",
+      {"sensor", "rated_battery_range",
        %{
          state_topic_key: :rated_battery_range_km,
          name: "Rated Battery Range",
          device_class: "distance",
          unit_of_measurement: "km",
          icon: "mdi:gauge"
        }},
-      {"sensor", "ideal_battery_range_km",
+      {"sensor", "ideal_battery_range",
        %{
          state_topic_key: :ideal_battery_range_km,
          name: "Ideal Battery Range",

test/teslamate/mqtt/pubsub/home_assistant_test.exs

@@ -134,6 +134,27 @@ defmodule TeslaMate.Mqtt.PubSub.HomeAssistantTest do
     end)
   end
 
+  test "entity ids match the manual mqtt_sensors.yaml naming", %{test: name} do
+    publisher_name = start_publisher(name)
+
+    :ok = HomeAssistant.publish(@summary, [car_id: 0], {MqttPublisherMock, publisher_name})
+
+    find_config("homeassistant/sensor/teslamate_0/speed/config", fn decoded ->
+      assert decoded["object_id"] == "tesla_speed"
+      assert decoded["unique_id"] == "teslamate_0_speed"
+    end)
+
+    find_config("homeassistant/sensor/teslamate_0/est_battery_range/config", fn decoded ->
+      assert decoded["object_id"] == "tesla_est_battery_range"
+      assert decoded["unique_id"] == "teslamate_0_est_battery_range"
+    end)
+
+    find_config("homeassistant/binary_sensor/teslamate_0/healthy/config", fn decoded ->
+      assert decoded["object_id"] == "tesla_healthy"
+      assert decoded["unique_id"] == "teslamate_0_healthy"
+    end)
+  end
+
   test "clear publishes empty payloads per entity", %{test: name} do
     publisher_name = start_publisher(name)
 

website/docs/integrations/home_assistant.md

@@ -41,6 +41,16 @@ vehicle summary, where `<node>` is `teslamate`. The device is grouped under the
 `teslamate_car_<car_id>` identifier, and the entity IDs match those produced by
 the manual `mqtt_sensors.yaml` below.
 
+:::note
+
+The `unique_id`s of the discovered entities match those of the manual
+`mqtt_sensors.yaml`, so enabling discovery while the manual configuration is
+still active will produce duplicate-ID errors in Home Assistant. Remove the
+manual `mqtt: !include mqtt_sensors.yaml` section from `configuration.yaml`
+(and the entities it created) before enabling discovery.
+
+:::
+
 On startup, discovery configs are also cleared for cars that are no longer
 tracked, e.g. because they were removed from the Tesla account or because
 logging was disabled, so their entities are removed from Home Assistant.