Skip to content

MQTT: Use default_entity_id instead of object_id #1351

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.

Sign up for GitHub

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

Merged
FrankBakkerNl merged 2 commits into from
Mar 21, 2026
Merged

MQTT: Use default_entity_id instead of object_id #1351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
343df2c
MQTT: Use default_entity_id instead of object_id
brechtvhb Dec 24, 2025
83f18eb
Resolve copilot suggestion
brechtvhb Dec 24, 2025
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
8 changes: 4 additions & 4 deletions ...tDaemon.HassClient.Tests/ExtensionsTest/MqttEntityManagerTests/MqttEntityManagerTester.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public async Task CreateWithNoOptionsSetsBaseConfig()
payload?.Count.Should().Be(6);
payload?["name"].ToString().Should().Be("sensor");
payload?["unique_id"].ToString().Should().Be("homeassistant_domain_sensor_config");
payload?["object_id"].ToString().Should().Be("sensor");
payload?["default_entity_id"].ToString().Should().Be("domain.sensor");
payload?["command_topic"].ToString().Should().Be("homeassistant/domain/sensor/set");
payload?["state_topic"].ToString().Should().Be("homeassistant/domain/sensor/state");
payload?["json_attributes_topic"].ToString().Should().Be("homeassistant/domain/sensor/attributes");
Expand All @@ -45,7 +45,7 @@ public async Task CreateWithDefaultOptionsSetsBaseConfig()
payload?.Count.Should().Be(6);
payload?["name"].ToString().Should().Be("sensor");
payload?["unique_id"].ToString().Should().Be("homeassistant_domain_sensor_config");
payload?["object_id"].ToString().Should().Be("sensor");
payload?["default_entity_id"].ToString().Should().Be("domain.sensor");
payload?["command_topic"].ToString().Should().Be("homeassistant/domain/sensor/set");
payload?["state_topic"].ToString().Should().Be("homeassistant/domain/sensor/state");
payload?["json_attributes_topic"].ToString().Should().Be("homeassistant/domain/sensor/attributes");
Expand All @@ -64,15 +64,15 @@ public async Task CreateCanSetUniqueId()
}

[Fact]
public async Task CreateSetsObjectId()
public async Task CreateSetsDefaultEntityId()
{
var mqttSetup = new MockMqttMessageSenderSetup();
var entityManager = new MqttEntityManager(mqttSetup.MessageSender, null!, GetOptions());

await entityManager.CreateAsync("domain.the_id");
var payload = PayloadToDictionary(mqttSetup.LastPublishedMessage.PayloadSegment.Array ?? []);

payload?["object_id"].ToString().Should().Be("the_id");
payload?["default_entity_id"].ToString().Should().Be("domain.the_id");
}

[Fact]
Expand Down
12 changes: 6 additions & 6 deletions src/Extensions/NetDaemon.Extensions.MqttEntityManager/Models/EntityCreationPayload.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ internal class EntityCreationPayload
[JsonPropertyName("unique_id")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? UniqueId { get; set; }
[JsonPropertyName("object_id")]
public string? ObjectId { get; set; }

[JsonPropertyName("default_entity_id")]
public string? DefaultEntityId { get; set; }

[JsonPropertyName("command_topic")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? CommandTopic { get; set; }

[JsonPropertyName("state_topic")]
public string? StateTopic { get; set; }

Expand All @@ -35,7 +35,7 @@ internal class EntityCreationPayload
[JsonPropertyName("availability_topic")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? AvailabilityTopic { get; set; }

[JsonPropertyName("payload_available")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? PayloadAvailable { get; set; }
Expand All @@ -52,4 +52,4 @@ internal class EntityCreationPayload
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? PayloadOff { get; set; }

}
}
3 changes: 2 additions & 1 deletion src/Extensions/NetDaemon.Extensions.MqttEntityManager/MqttEntityManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ private string BuildCreationPayload(string domain, string identifier, string con
Name = options?.Name ?? identifier,
DeviceClass = options?.DeviceClass,
UniqueId = options?.UniqueId ?? configPath.Replace('/', '_'),
ObjectId = identifier,
DefaultEntityId = DefaultEntityId(domain, identifier),
Comment thread
brechtvhb marked this conversation as resolved.
CommandTopic = CommandPath(domain, identifier),
StateTopic = StatePath(domain, identifier),
PayloadAvailable = options?.PayloadAvailable,
Expand All @@ -158,6 +158,7 @@ private static bool IsAvailabilityTopicRequired(EntityCreationOptions? options)
!string.IsNullOrWhiteSpace(options.PayloadNotAvailable));
}

private static string DefaultEntityId(string domain, string identifier) => $"{domain}.{identifier}";
private string AttrsPath(string domain, string identifier) => $"{RootPath(domain, identifier)}/attributes";

private string ConfigPath(string domain, string identifier) => $"{RootPath(domain, identifier)}/config";
Expand Down
Loading