Add enum options for Octoprint status sensor (home-assistant#157213)

Author: vexofp

homeassistant/components/octoprint/icons.json

@@ -1,4 +1,39 @@
 {
+  "entity": {
+    "sensor": {
+      "file_name": {
+        "default": "mdi:printer-3d-nozzle",
+        "state": {
+          "unavailable": "mdi:printer-3d-nozzle-off"
+        }
+      },
+      "status": {
+        "default": "mdi:printer-3d",
+        "state": {
+          "cancelling": "mdi:file-cancel",
+          "connecting": "mdi:lan-connect",
+          "detect_serial": "mdi:lan-connect",
+          "error": "mdi:printer-3d-nozzle-alert",
+          "finishing": "mdi:printer-3d-nozzle",
+          "offline": "mdi:printer-3d-off",
+          "offline_after_error": "mdi:printer-3d-off",
+          "open_serial": "mdi:lan-connect",
+          "operational": "mdi:printer-3d",
+          "paused": "mdi:printer-3d-nozzle-off",
+          "pausing": "mdi:printer-3d-nozzle",
+          "printing": "mdi:printer-3d-nozzle",
+          "printing_sd": "mdi:printer-3d-nozzle",
+          "printing_streaming": "mdi:file-upload",
+          "resuming": "mdi:printer-3d-nozzle",
+          "starting": "mdi:printer-3d-nozzle",
+          "starting_sd": "mdi:printer-3d-nozzle",
+          "starting_streaming": "mdi:file-upload",
+          "transferring_file": "mdi:file-upload",
+          "unavailable": "mdi:printer-3d-off"
+        }
+      }
+    }
+  },
   "services": {
     "printer_connect": {
       "service": "mdi:lan-connect"

homeassistant/components/octoprint/sensor.py

@@ -23,8 +23,6 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-JOB_PRINTING_STATES = ["Printing from SD", "Printing"]
-
 
 def _is_printer_printing(printer: OctoprintPrinterInfo) -> bool:
     return (
@@ -110,10 +108,38 @@ def __init__(
         self._attr_device_info = coordinator.device_info
 
 
+# Map the strings returned by the OctoPrint API back into values based on the underlying OctoPrint constants.
+# See octoprint.util.comm.MahcineCom.getStateString():
+# https://github.com/OctoPrint/OctoPrint/blob/7e7d418dac467e308b24c669a03e8b4256f04b45/src/octoprint/util/comm.py#L965
+_API_STATE_VALUE = {
+    "Opening serial connection": "open_serial",
+    "Detecting serial connection": "detect_serial",
+    "Connecting": "connecting",
+    "Operational": "operational",
+    "Starting print from SD": "starting_sd",
+    "Starting to send file to SD": "starting_streaming",
+    "Starting": "starting",
+    "Printing from SD": "printing_sd",
+    "Sending file to SD": "printing_streaming",
+    "Printing": "printing",
+    "Cancelling": "cancelling",
+    "Pausing": "pausing",
+    "Paused": "paused",
+    "Resuming": "resuming",
+    "Finishing": "finishing",
+    "Offline": "offline",
+    "Error": "error",
+    "Offline after error": "offline_after_error",
+    "Transferring file to SD": "transferring_file",
+}
+
+
 class OctoPrintStatusSensor(OctoPrintSensorBase):
     """Representation of an OctoPrint status sensor."""
 
-    _attr_icon = "mdi:printer-3d"
+    _attr_device_class = SensorDeviceClass.ENUM
+    _attr_options = list(_API_STATE_VALUE.values())
+    _attr_translation_key = "status"
 
     def __init__(
         self, coordinator: OctoprintDataUpdateCoordinator, device_id: str
@@ -124,11 +150,14 @@ def __init__(
     @property
     def native_value(self):
         """Return sensor state."""
+
+        # Get printer data from the coordinator
         printer: OctoprintPrinterInfo = self.coordinator.data["printer"]
         if not printer:
             return None
 
-        return printer.state.text
+        # Translate the string from the API into an internal state value, or return None (Unknown) if no match
+        return _API_STATE_VALUE.get(printer.state.text)
 
     @property
     def available(self) -> bool:
@@ -272,7 +301,7 @@ def available(self) -> bool:
 class OctoPrintFileNameSensor(OctoPrintSensorBase):
     """Representation of an OctoPrint file name sensor."""
 
-    _attr_icon = "mdi:printer-3d-nozzle"
+    _attr_translation_key = "file_name"
 
     def __init__(
         self,

homeassistant/components/octoprint/strings.json

@@ -47,6 +47,35 @@
       "extruder_temperature": {
         "name": "Extruder temperature"
       }
+    },
+    "sensor": {
+      "file_name": {
+        "name": "Current file"
+      },
+      "status": {
+        "name": "Current state",
+        "state": {
+          "cancelling": "Cancelling",
+          "connecting": "Connecting",
+          "detect_serial": "Detecting serial connection",
+          "error": "[%key:common::state::error%]",
+          "finishing": "Finishing",
+          "offline": "Offline",
+          "offline_after_error": "Offline after error",
+          "open_serial": "Opening serial connection",
+          "operational": "Operational",
+          "paused": "[%key:common::state::paused%]",
+          "pausing": "Pausing",
+          "printing": "Printing",
+          "printing_sd": "Printing from SD",
+          "printing_streaming": "Sending file to SD",
+          "resuming": "Resuming",
+          "starting": "Starting",
+          "starting_sd": "Starting print from SD",
+          "starting_streaming": "Starting to send file to SD",
+          "transferring_file": "Transferring file to SD"
+        }
+      }
     }
   },
   "exceptions": {

tests/components/octoprint/test_sensor.py

@@ -57,7 +57,7 @@ async def test_sensors(
 
     state = hass.states.get("sensor.octoprint_current_state")
     assert state is not None
-    assert state.state == "Operational"
+    assert state.state == "operational"
     assert state.name == "OctoPrint Current State"
     entry = entity_registry.async_get("sensor.octoprint_current_state")
     assert entry.unique_id == "Current State-uuid"