implement name prefix

UserInterface/Views/GeneralSettings.axaml

@@ -6,8 +6,22 @@
              x:Class="UserInterface.Views.GeneralSettingsView">
   <StackPanel Margin="30" HorizontalAlignment="Left">
     <ContentControl FontSize="18" FontWeight="Bold">Settings</ContentControl>
-    <ContentControl Margin="0 20 0 10">IP address or hostname</ContentControl>
+    <StackPanel Margin="0 20 0 10" HorizontalAlignment="Left" Orientation="Horizontal">
-    <TextBox Text="{Binding NamePrefix}" HorizontalAlignment="Left" Width="100" Watermark="laptop-"/>
+      <ContentControl>Name prefix</ContentControl>
+      <TextBlock Cursor="Help" Margin="5 0 0 0" VerticalAlignment="Bottom" TextDecorations="Underline">(What's this?)
+      <ToolTip.Tip>
+        <StackPanel>
+          <TextBlock>
+[Experimental]
+This allows you to set a name which will be used to prefix all sensor- and command names. For example:
+If a sensor is called "ActiveWindow" and the name prefix is set to "laptop", the sensor will be named "laptop-ActiveWindow" and its entityId will be "laptop_activewindow".
+          </TextBlock>
+          
+        </StackPanel>
+      </ToolTip.Tip>
+    </TextBlock>
+     </StackPanel>
+    <TextBox Text="{Binding NamePrefix}" HorizontalAlignment="Left" Width="100"/>
     <Button Width="75" HorizontalAlignment="Right" Margin="0 40 0 10" Click="Configure">Save</Button>
   </StackPanel>
 </UserControl>

hass-workstation-service/Communication/MQTT/MqttPublisher.cs

@@ -114,19 +114,16 @@ namespace hass_workstation_service.Communication
                 };
 
                 var message = new MqttApplicationMessageBuilder()
-                .WithTopic($"homeassistant/{discoverable.Domain}/{this.DeviceConfigModel.Name}/{this.NamePrefix}{discoverable.ObjectId}/config")
+                .WithTopic($"homeassistant/{discoverable.Domain}/{this.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(discoverable.GetAutoDiscoveryConfig().NamePrefix, discoverable.ObjectId)}/config")
                 .WithPayload(clearConfig ? "" : JsonSerializer.Serialize(discoverable.GetAutoDiscoveryConfig(), discoverable.GetAutoDiscoveryConfig().GetType(), options))
                 .WithRetainFlag()
                 .Build();
                 await this.Publish(message);
                 // if clearconfig is true, also remove previous state messages
-                throw new NotImplementedException();
-                // TODO:
-                // The nameprefix we get here is already the new one so the old messages never get deleted
                 if (clearConfig)
                 {
                     var stateMessage = new MqttApplicationMessageBuilder()
-                    .WithTopic($"homeassistant/{discoverable.Domain}/{this.DeviceConfigModel.Name}/{this.NamePrefix}{discoverable.ObjectId}/")
+                    .WithTopic($"homeassistant/{discoverable.Domain}/{this.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(discoverable.GetAutoDiscoveryConfig().NamePrefix, discoverable.ObjectId)}/state")
                     .WithPayload("")
                     .WithRetainFlag()
                     .Build();

hass-workstation-service/Communication/MQTT/SensorDiscoveryConfigModel.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Text.Json.Serialization;
 
 namespace hass_workstation_service.Communication
 {
@@ -14,12 +15,49 @@ namespace hass_workstation_service.Communication
         /// (Optional) The name of the MQTT sensor. Defaults to MQTT Sensor in hass.
         /// </summary>
         /// <value></value>
+        [JsonIgnore]
         public string Name { get; set; }
+        /// <summary>
+        /// (Optional) The first part of the name. 
+        /// </summary>
+        /// <value></value>
+        [JsonIgnore]
+        public string NamePrefix { get; set; }
+
+        [JsonPropertyName("name")]
+        public string CompiledName { get => GetName(); }
+
         /// <summary>
         /// The MQTT topic subscribed to receive sensor values.
         /// </summary>
         /// <value></value>
         public string State_topic { get; set; }
+
+        /// <summary>
+        /// Gets the name including the prefix
+        /// </summary>
+        /// <returns></returns>
+        public string GetName()
+        {
+            if (string.IsNullOrWhiteSpace(NamePrefix))
+            {
+                return Name;
+            }
+            return $"{NamePrefix}-{Name}";
+        }
+
+        /// <summary>
+        /// Gets the name including the prefix if the class has not been instantiated yet.
+        /// </summary>
+        /// <returns></returns>
+        public static string GetNameWithPrefix(string namePrefix, string name)
+        {
+            if (string.IsNullOrWhiteSpace(namePrefix))
+            {
+                return name;
+            }
+            return $"{namePrefix}-{name}";
+        }
     }
     public class SensorDiscoveryConfigModel : DiscoveryConfigModel
     {

hass-workstation-service/Domain/Commands/CustomCommand.cs

@@ -54,10 +54,11 @@ namespace hass_workstation_service.Domain.Commands
             return new CommandDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Availability_topic = $"homeassistant/sensor/{Publisher.DeviceConfigModel.Name}/availability",
                 Command_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/set",
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Device = this.Publisher.DeviceConfigModel,
             };
         }

hass-workstation-service/Domain/Commands/KeyCommand.cs

@@ -30,10 +30,11 @@ namespace hass_workstation_service.Domain.Commands
             return new CommandDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Availability_topic = $"homeassistant/sensor/{Publisher.DeviceConfigModel.Name}/availability",
                 Command_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/set",
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Device = this.Publisher.DeviceConfigModel,
             };
         }

hass-workstation-service/Domain/Sensors/AbstractSensor.cs

@@ -38,11 +38,11 @@ namespace hass_workstation_service.Domain.Sensors
                 return;
 
             var message = new MqttApplicationMessageBuilder()
-                                                .WithTopic(GetAutoDiscoveryConfig().State_topic)
+                .WithTopic(GetAutoDiscoveryConfig().State_topic)
-                                                .WithPayload(state)
+                .WithPayload(state)
-                                                .WithExactlyOnceQoS()
+                .WithExactlyOnceQoS()
-                                                .WithRetainFlag()
+                .WithRetainFlag()
-                                                .Build();
+                .Build();
             await Publisher.Publish(message);
             PreviousPublishedState = state;
             LastUpdated = DateTime.UtcNow;

hass-workstation-service/Domain/Sensors/ActiveWindowSensor.cs

@@ -14,9 +14,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:window-maximize",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"
             });

hass-workstation-service/Domain/Sensors/CPULoadSensor.cs

@@ -22,9 +22,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:chart-areaspline",
                 Unit_of_measurement = "%",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"

hass-workstation-service/Domain/Sensors/CurrentClockSpeedSensor.cs

@@ -14,9 +14,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:speedometer",
                 Unit_of_measurement = "MHz",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"

hass-workstation-service/Domain/Sensors/CurrentVolumeSensor.cs

@@ -23,9 +23,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:volume-medium",
                 Unit_of_measurement = "%",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"

hass-workstation-service/Domain/Sensors/DummySensor.cs

@@ -18,9 +18,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"
             });
         }

hass-workstation-service/Domain/Sensors/GpuLoadSensor.cs

@@ -35,9 +35,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Unit_of_measurement = "%",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"
             });

hass-workstation-service/Domain/Sensors/GpuTemperatureSensor.cs

@@ -35,9 +35,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Device_class = "temperature",
                 Unit_of_measurement = "°C",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"

hass-workstation-service/Domain/Sensors/LastActiveSensor.cs

@@ -14,9 +14,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:clock-time-three-outline",
                 Device_class = "timestamp"
             });

hass-workstation-service/Domain/Sensors/LastBootSensor.cs

@@ -18,9 +18,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:clock-time-three-outline",
                 Device_class = "timestamp"
             });

hass-workstation-service/Domain/Sensors/MemoryUsageSensor.cs

@@ -42,9 +42,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:memory",
                 Unit_of_measurement = "%",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"

hass-workstation-service/Domain/Sensors/MicrophoneActiveSensor.cs

@@ -27,9 +27,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Availability_topic = $"homeassistant/sensor/{Publisher.DeviceConfigModel.Name}/availability"
             });
         }

hass-workstation-service/Domain/Sensors/NamedWindowSensor.cs

@@ -22,11 +22,12 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Availability_topic = $"homeassistant/sensor/{Publisher.DeviceConfigModel.Name}/availability"
-            });
+            });;
         }
 
         public override string GetState()

hass-workstation-service/Domain/Sensors/SessionStateSensor.cs

@@ -42,9 +42,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:lock",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"
             });

hass-workstation-service/Domain/Sensors/UserNotificationStateSensor.cs

@@ -14,9 +14,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Icon = "mdi:laptop",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"
             });

hass-workstation-service/Domain/Sensors/WMIQuerySensor.cs

@@ -25,9 +25,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Availability_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/availability"
             });
         }

hass-workstation-service/Domain/Sensors/WebcamActiveSensor.cs

@@ -30,9 +30,10 @@ namespace hass_workstation_service.Domain.Sensors
             return this._autoDiscoveryConfigModel ?? SetAutoDiscoveryConfigModel(new SensorDiscoveryConfigModel()
             {
                 Name = this.Name,
+                NamePrefix = Publisher.NamePrefix,
                 Unique_id = this.Id.ToString(),
                 Device = this.Publisher.DeviceConfigModel,
-                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{Publisher.NamePrefix}{this.ObjectId}/state",
+                State_topic = $"homeassistant/{this.Domain}/{Publisher.DeviceConfigModel.Name}/{DiscoveryConfigModel.GetNameWithPrefix(Publisher.NamePrefix, this.ObjectId)}/state",
                 Availability_topic = $"homeassistant/sensor/{Publisher.DeviceConfigModel.Name}/availability"
             });
         }