Add sensor as entity platform on MQTT subentries

homeassistant/components/mqtt/const.py

@@ -86,13 +86,15 @@
 CONF_EFFECT_TEMPLATE = "effect_template"
 CONF_EFFECT_VALUE_TEMPLATE = "effect_value_template"
 CONF_ENTITY_PICTURE = "entity_picture"
+CONF_EXPIRE_AFTER = "expire_after"
 CONF_FLASH_TIME_LONG = "flash_time_long"
 CONF_FLASH_TIME_SHORT = "flash_time_short"
 CONF_GREEN_TEMPLATE = "green_template"
 CONF_HS_COMMAND_TEMPLATE = "hs_command_template"
 CONF_HS_COMMAND_TOPIC = "hs_command_topic"
 CONF_HS_STATE_TOPIC = "hs_state_topic"
 CONF_HS_VALUE_TEMPLATE = "hs_value_template"
+CONF_LAST_RESET_VALUE_TEMPLATE = "last_reset_value_template"
 CONF_MAX_KELVIN = "max_kelvin"
 CONF_MAX_MIREDS = "max_mireds"
 CONF_MIN_KELVIN = "min_kelvin"
@@ -128,6 +130,7 @@
 CONF_STATE_CLOSING = "state_closing"
 CONF_STATE_OPEN = "state_open"
 CONF_STATE_OPENING = "state_opening"
+CONF_SUGGESTED_DISPLAY_PRECISION = "suggested_display_precision"
 CONF_SUPPORTED_COLOR_MODES = "supported_color_modes"
 CONF_TEMP_COMMAND_TEMPLATE = "temperature_command_template"
 CONF_TEMP_COMMAND_TOPIC = "temperature_command_topic"

homeassistant/components/mqtt/entity.py

@@ -123,7 +123,7 @@
     async_subscribe_topics_internal,
     async_unsubscribe_topics,
 )
-from .util import mqtt_config_entry_enabled
+from .util import learn_more_url, mqtt_config_entry_enabled
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -346,17 +346,14 @@ def _async_setup_entities() -> None:
                 line = getattr(yaml_config, "__line__", "?")
                 issue_id = hex(hash(frozenset(yaml_config)))
                 yaml_config_str = yaml_dump(yaml_config)
-                learn_more_url = (
-                    f"https://www.home-assistant.io/integrations/{domain}.mqtt/"
-                )
                 async_create_issue(
                     hass,
                     DOMAIN,
                     issue_id,
                     issue_domain=domain,
                     is_fixable=False,
                     severity=IssueSeverity.ERROR,
-                    learn_more_url=learn_more_url,
+                    learn_more_url=learn_more_url(domain),
                     translation_placeholders={
                         "domain": domain,
                         "config_file": config_file,

homeassistant/components/mqtt/sensor.py

@@ -41,7 +41,15 @@
 
 from . import subscription
 from .config import MQTT_RO_SCHEMA
-from .const import CONF_OPTIONS, CONF_STATE_TOPIC, DOMAIN, PAYLOAD_NONE
+from .const import (
+    CONF_EXPIRE_AFTER,
+    CONF_LAST_RESET_VALUE_TEMPLATE,
+    CONF_OPTIONS,
+    CONF_STATE_TOPIC,
+    CONF_SUGGESTED_DISPLAY_PRECISION,
+    DOMAIN,
+    PAYLOAD_NONE,
+)
 from .entity import MqttAvailabilityMixin, MqttEntity, async_setup_entity_entry_helper
 from .models import MqttValueTemplate, PayloadSentinel, ReceiveMessage
 from .schemas import MQTT_ENTITY_COMMON_SCHEMA
@@ -51,10 +59,6 @@
 
 PARALLEL_UPDATES = 0
 
-CONF_EXPIRE_AFTER = "expire_after"
-CONF_LAST_RESET_VALUE_TEMPLATE = "last_reset_value_template"
-CONF_SUGGESTED_DISPLAY_PRECISION = "suggested_display_precision"
-
 MQTT_SENSOR_ATTRIBUTES_BLOCKED = frozenset(
     {
         sensor.ATTR_LAST_RESET,

homeassistant/components/mqtt/strings.json

@@ -198,20 +198,66 @@
             "component": "Select the entity you want to update."
           }
         },
+        "entity_platform_config": {
+          "title": "Configure MQTT device \"{mqtt_device}\"",
+          "description": "Please configure specific details for {platform} entity \"{entity}\":",
+          "data": {
+            "device_class": "Device class",
+            "state_class": "State class",
+            "unit_of_measurement": "Unit of measurement",
+            "options": "Add option"
+          },
+          "data_description": {
+            "device_class": "The device class of the {platform} entity. [Learn more.]({url}#device_class)",
+            "state_class": "The [state_class](https://developers.home-assistant.io/docs/core/entity/sensor/#available-state-classes) of the sensor. [Learn more.]({url}#state_class)",
+            "unit_of_measurement": "Defines the unit of measurement of the sensor, if any.",
+            "options": "Options for allowed sensor state values. The sensor’s device_class must be set to Enumeration. The options option cannot be used together with State Class or Unit of measurement."
+          },
+          "sections": {
+            "advanced_settings": {
+              "name": "Advanced options",
+              "data": {
+                "suggested_display_precision": "Suggested display precision"
+              },
+              "data_description": {
+                "suggested_display_precision": "The number of decimals which should be used in the {platform} entity state after rounding. [Learn more.]({url}#suggested_display_precision)"
+              }
+            }
+          }
+        },
         "mqtt_platform_config": {
           "title": "Configure MQTT device \"{mqtt_device}\"",
           "description": "Please configure MQTT specific details for {platform} entity \"{entity}\":",
           "data": {
             "command_topic": "Command topic",
             "command_template": "Command template",
+            "state_topic": "State topic",
+            "value_template": "Value template",
+            "last_reset_value_template": "Last reset value template",
+            "force_update": "Force update",
             "retain": "Retain",
             "qos": "QoS"
           },
           "data_description": {
-            "command_topic": "The publishing topic that will be used to control the {platform} entity.",
+            "command_topic": "The publishing topic that will be used to control the {platform} entity. [Learn more.]({url}#command_topic)",
             "command_template": "A [template](https://www.home-assistant.io/docs/configuration/templating/#using-command-templates-with-mqtt) to render the payload to be published at the command topic.",
+            "state_topic": "The MQTT topic subscribed to receive {platform} state values. [Learn more.]({url}#state_topic)",
+            "value_template": "Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract the {platform} entity value.",
+            "last_reset_value_template": "Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract the last reset. When Last reset template is set, the State class option must be Total. [Learn more.]({url}#last_reset_value_template)",
+            "force_update": "Sends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history. [Learn more.]({url}#force_update)",
             "retain": "Select if values published by the {platform} entity should be retained at the MQTT broker.",
             "qos": "The QoS value {platform} entity should use."
+          },
+          "sections": {
+            "advanced_settings": {
+              "name": "Advanced settings",
+              "data": {
+                "expire_after": "Expire after"
+              },
+              "data_description": {
+                "expire_after": "If set, it defines the number of seconds after the sensor’s state expires, if it’s not updated. After expiry, the sensor’s state becomes unavailable. If not set, the sensor's state never expires. [Learn more.]({url}#expire_after)"
+              }
+            }
           }
         }
       },
@@ -225,7 +271,12 @@
         "invalid_input": "Invalid value",
         "invalid_subscribe_topic": "Invalid subscribe topic",
         "invalid_template": "Invalid template",
-        "invalid_url": "Invalid URL"
+        "invalid_uom": "The unit of measurement \"{unit_of_measurement}\" is not supported by the selected device class, please either remove the device class, select a device class which supports \"{unit_of_measurement}\", or pick a supported unit of measurement from the list",
+        "invalid_url": "Invalid URL",
+        "options_not_allowed_with_state_class_or_uom": "The 'Options' setting is not allowed when state class or unit of measurement are used",
+        "options_device_class_enum": "The 'Options' setting must be used with the Enumeration device class'. If you continue, the existing options will be reset",
+        "options_with_enum_device_class": "Configure options for the enumeration sensor",
+        "uom_required_for_device_class": "The selected device device class requires a unit"
       }
     }
   },
@@ -342,9 +393,70 @@
     }
   },
   "selector": {
+    "device_class_sensor": {
+      "options": {
+        "apparent_power": "[%key:component::sensor::entity_component::apparent_power::name%]",
+        "area": "[%key:component::sensor::entity_component::area::name%]",
+        "aqi": "[%key:component::sensor::entity_component::aqi::name%]",
+        "atmospheric_pressure": "[%key:component::sensor::entity_component::atmospheric_pressure::name%]",
+        "battery": "[%key:component::sensor::entity_component::battery::name%]",
+        "blood_glucose_concentration": "[%key:component::sensor::entity_component::blood_glucose_concentration::name%]",
+        "carbon_dioxide": "[%key:component::sensor::entity_component::carbon_dioxide::name%]",
+        "carbon_monoxide": "[%key:component::sensor::entity_component::carbon_monoxide::name%]",
+        "conductivity": "[%key:component::sensor::entity_component::conductivity::name%]",
+        "current": "[%key:component::sensor::entity_component::current::name%]",
+        "data_rate": "[%key:component::sensor::entity_component::data_rate::name%]",
+        "data_size": "[%key:component::sensor::entity_component::data_size::name%]",
+        "date": "[%key:component::sensor::entity_component::date::name%]",
+        "distance": "[%key:component::sensor::entity_component::distance::name%]",
+        "duration": "[%key:component::sensor::entity_component::duration::name%]",
+        "energy": "[%key:component::sensor::entity_component::energy::name%]",
+        "energy_distance": "[%key:component::sensor::entity_component::energy_distance::name%]",
+        "energy_storage": "[%key:component::sensor::entity_component::energy_storage::name%]",
+        "enum": "Enumeration",
+        "frequency": "[%key:component::sensor::entity_component::frequency::name%]",
+        "gas": "[%key:component::sensor::entity_component::gas::name%]",
+        "humidity": "[%key:component::sensor::entity_component::humidity::name%]",
+        "illuminance": "[%key:component::sensor::entity_component::illuminance::name%]",
+        "irradiance": "[%key:component::sensor::entity_component::irradiance::name%]",
+        "moisture": "[%key:component::sensor::entity_component::moisture::name%]",
+        "monetary": "[%key:component::sensor::entity_component::monetary::name%]",
+        "nitrogen_dioxide": "[%key:component::sensor::entity_component::nitrogen_dioxide::name%]",
+        "nitrogen_monoxide": "[%key:component::sensor::entity_component::nitrogen_monoxide::name%]",
+        "nitrous_oxide": "[%key:component::sensor::entity_component::nitrous_oxide::name%]",
+        "ozone": "[%key:component::sensor::entity_component::ozone::name%]",
+        "ph": "[%key:component::sensor::entity_component::ph::name%]",
+        "pm1": "[%key:component::sensor::entity_component::pm1::name%]",
+        "pm10": "[%key:component::sensor::entity_component::pm10::name%]",
+        "pm25": "[%key:component::sensor::entity_component::pm25::name%]",
+        "power": "[%key:component::sensor::entity_component::power::name%]",
+        "power_factor": "[%key:component::sensor::entity_component::power_factor::name%]",
+        "precipitation": "[%key:component::sensor::entity_component::precipitation::name%]",
+        "precipitation_intensity": "[%key:component::sensor::entity_component::precipitation_intensity::name%]",
+        "pressure": "[%key:component::sensor::entity_component::pressure::name%]",
+        "reactive_power": "[%key:component::sensor::entity_component::reactive_power::name%]",
+        "signal_strength": "[%key:component::sensor::entity_component::signal_strength::name%]",
+        "sound_pressure": "[%key:component::sensor::entity_component::sound_pressure::name%]",
+        "speed": "[%key:component::sensor::entity_component::speed::name%]",
+        "sulphur_dioxide": "[%key:component::sensor::entity_component::sulphur_dioxide::name%]",
+        "temperature": "[%key:component::sensor::entity_component::temperature::name%]",
+        "timestamp": "[%key:component::sensor::entity_component::timestamp::name%]",
+        "volatile_organic_compounds": "[%key:component::sensor::entity_component::volatile_organic_compounds::name%]",
+        "volatile_organic_compounds_parts": "[%key:component::sensor::entity_component::volatile_organic_compounds::name%]",
+        "voltage": "[%key:component::sensor::entity_component::voltage::name%]",
+        "volume": "[%key:component::sensor::entity_component::volume::name%]",
+        "volume_flow_rate": "[%key:component::sensor::entity_component::volume_flow_rate::name%]",
+        "volume_storage": "[%key:component::sensor::entity_component::volume_storage::name%]",
+        "water": "[%key:component::sensor::entity_component::water::name%]",
+        "weight": "[%key:component::sensor::entity_component::weight::name%]",
+        "wind_direction": "[%key:component::sensor::entity_component::wind_direction::name%]",
+        "wind_speed": "[%key:component::sensor::entity_component::wind_speed::name%]"
+      }
+    },
     "platform": {
       "options": {
-        "notify": "Notify"
+        "notify": "Notify",
+        "sensor": "Sensor"
       }
     },
     "set_ca_cert": {
@@ -353,6 +465,13 @@
         "auto": "Auto",
         "custom": "Custom"
       }
+    },
+    "state_class": {
+      "options": {
+        "measurement": "[%key:component::sensor::entity_component::_::state_attributes::state_class::state::measurement%]",
+        "total": "[%key:component::sensor::entity_component::_::state_attributes::state_class::state::total%]",
+        "total_increasing": "[%key:component::sensor::entity_component::_::state_attributes::state_class::state::total_increasing%]"
+      }
     }
   },
   "services": {

homeassistant/components/mqtt/util.py

@@ -411,3 +411,9 @@ def migrate_certificate_file_to_content(file_name_or_auto: str) -> str | None:
             return certificate_file.read()
     except OSError:
         return None
+
+
+@callback
+def learn_more_url(platform: str) -> str:
+    """Return the URL for the platform specific MQTT documentation."""
+    return f"https://www.home-assistant.io/integrations/{platform}.mqtt/"

tests/components/mqtt/common.py

@@ -72,7 +72,7 @@
         "name": "Milkman alert",
         "qos": 0,
         "command_topic": "test-topic",
-        "command_template": "{{ value_json.value }}",
+        "command_template": "{{ value }}",
         "entity_picture": "https://example.com/363a7ecad6be4a19b939a016ea93e994",
         "retain": False,
     },
@@ -91,12 +91,47 @@
         "platform": "notify",
         "qos": 0,
         "command_topic": "test-topic",
-        "command_template": "{{ value_json.value }}",
+        "command_template": "{{ value }}",
         "entity_picture": "https://example.com/5269352dd9534c908d22812ea5d714cd",
         "retain": False,
     },
 }
 
+MOCK_SUBENTRY_SENSOR_COMPONENT = {
+    "e9261f6feed443e7b7d5f3fbe2a47412": {
+        "platform": "sensor",
+        "name": "Energy",
+        "device_class": "enum",
+        "qos": 1,
+        "state_topic": "test-topic",
+        "options": ["low", "medium", "high"],
+        "expire_after": 30,
+        "value_template": "{{ value_json.value }}",
+        "entity_picture": "https://example.com/e9261f6feed443e7b7d5f3fbe2a47412",
+    },
+}
+MOCK_SUBENTRY_SENSOR_COMPONENT_STATE_CLASS = {
+    "a0f85790a95d4889924602effff06b6e": {
+        "platform": "sensor",
+        "name": "Energy",
+        "state_class": "measurement",
+        "state_topic": "test-topic",
+        "entity_picture": "https://example.com/a0f85790a95d4889924602effff06b6e",
+        "qos": 0,
+    },
+}
+MOCK_SUBENTRY_SENSOR_COMPONENT_LAST_RESET = {
+    "e9261f6feed443e7b7d5f3fbe2a47412": {
+        "platform": "sensor",
+        "name": "Energy",
+        "state_class": "total",
+        "last_reset_value_template": "{{ value_json.value }}",
+        "state_topic": "test-topic",
+        "entity_picture": "https://example.com/e9261f6feed443e7b7d5f3fbe2a47412",
+        "qos": 0,
+    },
+}
+
 # Bogus light component just for code coverage
 # Note that light cannot be setup through the UI yet
 # The test is for code coverage
@@ -151,7 +186,7 @@
     },
     "components": MOCK_SUBENTRY_NOTIFY_COMPONENT1,
 }
-MOCK_SUBENTRY_DATA_NOTIFY_NO_NAME = {
+MOCK_NOTIFY_SUBENTRY_DATA_NO_NAME = {
     "device": {
         "name": "Milk notifier",
         "sw_version": "1.0",
@@ -162,6 +197,39 @@
     },
     "components": MOCK_SUBENTRY_NOTIFY_COMPONENT_NO_NAME,
 }
+MOCK_SENSOR_SUBENTRY_DATA_SINGLE = {
+    "device": {
+        "name": "Test sensor",
+        "sw_version": "1.0",
+        "hw_version": "2.1 rev a",
+        "model": "Model XL",
+        "model_id": "mn002",
+        "configuration_url": "https://example.com",
+    },
+    "components": MOCK_SUBENTRY_SENSOR_COMPONENT,
+}
+MOCK_SENSOR_SUBENTRY_DATA_SINGLE_STATE_CLASS = {
+    "device": {
+        "name": "Test sensor",
+        "sw_version": "1.0",
+        "hw_version": "2.1 rev a",
+        "model": "Model XL",
+        "model_id": "mn002",
+        "configuration_url": "https://example.com",
+    },
+    "components": MOCK_SUBENTRY_SENSOR_COMPONENT_STATE_CLASS,
+}
+MOCK_SENSOR_SUBENTRY_DATA_SINGLE_LAST_RESET_TEMPLATE = {
+    "device": {
+        "name": "Test sensor",
+        "sw_version": "1.0",
+        "hw_version": "2.1 rev a",
+        "model": "Model XL",
+        "model_id": "mn002",
+        "configuration_url": "https://example.com",
+    },
+    "components": MOCK_SUBENTRY_SENSOR_COMPONENT_LAST_RESET,
+}
 
 MOCK_SUBENTRY_DATA_BAD_COMPONENT_SCHEMA = {
     "device": {