[smt100] Rename `dielectric_constant to permittivity` (#9175)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

esphome/components/smt100/sensor.py

@@ -6,6 +6,7 @@ from esphome.const import (
     CONF_DIELECTRIC_CONSTANT,
     CONF_ID,
     CONF_MOISTURE,
+    CONF_PERMITTIVITY,
     CONF_TEMPERATURE,
     CONF_VOLTAGE,
     DEVICE_CLASS_TEMPERATURE,
@@ -33,7 +34,10 @@ CONFIG_SCHEMA = (
                 accuracy_decimals=0,
                 state_class=STATE_CLASS_MEASUREMENT,
             ),
-            cv.Optional(CONF_DIELECTRIC_CONSTANT): sensor.sensor_schema(
+            cv.Optional(CONF_DIELECTRIC_CONSTANT): cv.invalid(
+                "Use 'permittivity' instead"
+            ),
+            cv.Optional(CONF_PERMITTIVITY): sensor.sensor_schema(
                 unit_of_measurement=UNIT_EMPTY,
                 accuracy_decimals=2,
                 state_class=STATE_CLASS_MEASUREMENT,
@@ -76,9 +80,9 @@ async def to_code(config):
         sens = await sensor.new_sensor(config[CONF_COUNTS])
         cg.add(var.set_counts_sensor(sens))
 
-    if CONF_DIELECTRIC_CONSTANT in config:
+    if CONF_PERMITTIVITY in config:
-        sens = await sensor.new_sensor(config[CONF_DIELECTRIC_CONSTANT])
+        sens = await sensor.new_sensor(config[CONF_PERMITTIVITY])
-        cg.add(var.set_dielectric_constant_sensor(sens))
+        cg.add(var.set_permittivity_sensor(sens))
 
     if CONF_TEMPERATURE in config:
         sens = await sensor.new_sensor(config[CONF_TEMPERATURE])

esphome/components/smt100/smt100.cpp

@@ -16,7 +16,7 @@ void SMT100Component::loop() {
   while (this->available() != 0) {
     if (readline_(read(), buffer, MAX_LINE_LENGTH) > 0) {
       int counts = (int) strtol((strtok(buffer, ",")), nullptr, 10);
-      float dielectric_constant = (float) strtod((strtok(nullptr, ",")), nullptr);
+      float permittivity = (float) strtod((strtok(nullptr, ",")), nullptr);
       float moisture = (float) strtod((strtok(nullptr, ",")), nullptr);
       float temperature = (float) strtod((strtok(nullptr, ",")), nullptr);
       float voltage = (float) strtod((strtok(nullptr, ",")), nullptr);
@@ -25,8 +25,8 @@ void SMT100Component::loop() {
         counts_sensor_->publish_state(counts);
       }
 
-      if (this->dielectric_constant_sensor_ != nullptr) {
+      if (this->permittivity_sensor_ != nullptr) {
-        dielectric_constant_sensor_->publish_state(dielectric_constant);
+        permittivity_sensor_->publish_state(permittivity);
       }
 
       if (this->moisture_sensor_ != nullptr) {
@@ -49,8 +49,8 @@ float SMT100Component::get_setup_priority() const { return setup_priority::DATA;
 void SMT100Component::dump_config() {
   ESP_LOGCONFIG(TAG, "SMT100:");
 
-  LOG_SENSOR(TAG, "Counts", this->temperature_sensor_);
+  LOG_SENSOR(TAG, "Counts", this->counts_sensor_);
-  LOG_SENSOR(TAG, "Dielectric Constant", this->temperature_sensor_);
+  LOG_SENSOR(TAG, "Permittivity", this->permittivity_sensor_);
   LOG_SENSOR(TAG, "Temperature", this->temperature_sensor_);
   LOG_SENSOR(TAG, "Moisture", this->moisture_sensor_);
   LOG_UPDATE_INTERVAL(this);

esphome/components/smt100/smt100.h

@@ -20,8 +20,8 @@ class SMT100Component : public PollingComponent, public uart::UARTDevice {
   float get_setup_priority() const override;
 
   void set_counts_sensor(sensor::Sensor *counts_sensor) { this->counts_sensor_ = counts_sensor; }
-  void set_dielectric_constant_sensor(sensor::Sensor *dielectric_constant_sensor) {
+  void set_permittivity_sensor(sensor::Sensor *permittivity_sensor) {
-    this->dielectric_constant_sensor_ = dielectric_constant_sensor;
+    this->permittivity_sensor_ = permittivity_sensor;
   }
   void set_temperature_sensor(sensor::Sensor *temperature_sensor) { this->temperature_sensor_ = temperature_sensor; }
   void set_moisture_sensor(sensor::Sensor *moisture_sensor) { this->moisture_sensor_ = moisture_sensor; }
@@ -31,7 +31,7 @@ class SMT100Component : public PollingComponent, public uart::UARTDevice {
   int readline_(int readch, char *buffer, int len);
 
   sensor::Sensor *counts_sensor_{nullptr};
-  sensor::Sensor *dielectric_constant_sensor_{nullptr};
+  sensor::Sensor *permittivity_sensor_{nullptr};
   sensor::Sensor *moisture_sensor_{nullptr};
   sensor::Sensor *temperature_sensor_{nullptr};
   sensor::Sensor *voltage_sensor_{nullptr};

esphome/const.py

@@ -654,6 +654,7 @@ CONF_PAYLOAD = "payload"
 CONF_PAYLOAD_AVAILABLE = "payload_available"
 CONF_PAYLOAD_NOT_AVAILABLE = "payload_not_available"
 CONF_PERIOD = "period"
+CONF_PERMITTIVITY = "permittivity"
 CONF_PH = "ph"
 CONF_PHASE_A = "phase_a"
 CONF_PHASE_ANGLE = "phase_angle"

tests/components/smt100/common.yaml

@@ -8,8 +8,8 @@ sensor:
   - platform: smt100
     counts:
       name: Counts
-    dielectric_constant:
+    permittivity:
-      name: Dielectric Constant
+      name: Permittivity
     temperature:
       name: Temperature
     moisture: