feature: add formated time card

Author: fdcavalcanti

workpulse/cli.py

@@ -8,7 +8,7 @@
 from pathlib import Path
 
 from .database import Database
-from .homeassistant import generate_yaml_config
+from .homeassistant import YAMLGenerator
 from .mqtt_client import MQTTClient
 from .mqtt_config import create_default_config, load_config
 from .service import ServiceManager
@@ -519,18 +519,28 @@ def mqtt_yaml(self) -> int:
         Returns:
             Exit code (0 for success, non-zero for failure)
         """
-        yaml_config = generate_yaml_config()
+        yaml_config = YAMLGenerator().generate_mqtt_yaml()
+        template_config = YAMLGenerator().generate_template_yaml()
 
         print("Home Assistant YAML Configuration:")
         print("=" * 60)
+        print("Template Sensor Configuration:")
+        print(" - Provides a formatted time sensor to use on dashboard\n")
+        print(template_config)
+        print("=" * 60)
+        print("MQTT Sensor Configuration:")
+        print(
+            " - Connects to WorkPulse MQTT publisher to get working time (required)\n"
+        )
         print(yaml_config)
         print("=" * 60)
         print("\nInstructions:")
-        print("1. Copy the YAML configuration above")
+        print("1. Copy both YAML configurations above")
         print("2. Paste it into your Home Assistant configuration.yaml file")
         print("3. Restart Home Assistant (or reload MQTT integration)")
-        print("4. Ensure WorkPulse MQTT publisher is running: workpulse mqtt start")
-
+        print(
+            "4. Ensure WorkPulse MQTT publisher is running: workpulse mqtt start service"
+        )
         return 0
 
 

workpulse/homeassistant.py

@@ -4,41 +4,71 @@
 from typing import Optional
 
 
-def generate_yaml_config(hostname: Optional[str] = None) -> str:
-    """Generate Home Assistant YAML configuration for WorkPulse.
+class YAMLGenerator:
+    def __init__(self, hostname: Optional[str] = None):
+        if not hostname:
+            self.hostname = socket.gethostname()
+        else:
+            self.hostname = hostname
+        self.name = "WorkPulse Daily Time"
+        self.identifier = f"workpulse_{self.hostname}"
 
-    Generates complete YAML configuration with hostname automatically filled in.
-    The output can be copied and pasted directly into Home Assistant's configuration.yaml.
+    def generate_template_yaml(self) -> str:
+        """Generates YAML configuration for a template sensor that formats the daily time
+        reported by the MQTT sensor into a human-readable format (hours and minutes).
+        The output can be copied and pasted directly into Home Assistant's configuration.yaml.
 
-    Args:
-        hostname: Hostname to use in the configuration. If None, automatically detects.
-
-    Returns:
-        Complete YAML configuration string ready for Home Assistant
+        Returns:
+            YAML configuration string for the template sensor
+        """
+        sensor = f"sensor.{self.identifier}_{self.name.lower().replace(' ', '_')}"
+        yaml_template = f"""template:
+  - sensor:
+      - name: "WorkPulse Daily Time Formatted ({self.hostname})"
+        icon: mdi:clock-outline
+        state: >
+            {{% set total_seconds = states('{sensor}') | int %}}
+            {{% set hours = (total_seconds // 3600) %}}
+            {{% set minutes = ((total_seconds % 3600) // 60) %}}
+            {{% if hours > 0 %}}
+              {{{{ hours }}}}h {{% if minutes > 0 %}}{{{{ minutes }}}}m{{% endif %}}
+            {{% else %}}
+              {{{{ minutes }}}}m
+            {{% endif %}}
     """
-    if hostname is None:
-        hostname = socket.gethostname()
+        return yaml_template
+
+    def generate_mqtt_yaml(self) -> str:
+        """Generate Home Assistant YAML configuration for WorkPulse.
+
+        Generates complete YAML configuration with hostname automatically filled in.
+        The output can be copied and pasted directly into Home Assistant's configuration.yaml.
+
+        Args:
+            hostname: Hostname to use in the configuration. If None, automatically detects.
 
-    # Escape braces for Home Assistant template syntax
-    # In f-strings: {{ becomes {, so {{{{ becomes {{
-    yaml_config = f"""mqtt:
+        Returns:
+            Complete YAML configuration string ready for Home Assistant
+        """
+
+        # Escape braces for Home Assistant template syntax
+        # In f-strings: {{ becomes {, so {{{{ becomes {{
+        yaml_config = f"""mqtt:
   sensor:
-    # Daily Total Active Time (formatted as hours:minutes)
-    - name: "WorkPulse Daily Time"
-      unique_id: "workpulse_{hostname}_daily_time"
-      state_topic: "workpulse/{hostname}/status"
-      value_template: >
-        {{% set total_seconds = value_json.total_time | int %}}
-        {{% set hours = (total_seconds / 3600) | int %}}
-        {{% set minutes = ((total_seconds % 3600) / 60) | int %}}
-        {{% if hours > 0 %}}{{{{ hours }}}}h {{% if minutes > 0 %}}{{{{ minutes }}}}m{{% endif %}}{{% else %}}{{{{ minutes }}}}m{{% endif %}}
+    - name: "{self.name}"
+      unit_of_measurement: "s"
+      device_class: duration
+      state_class: total_increasing
+      unique_id: "workpulse_{self.hostname}_daily_time"
+      state_topic: "workpulse/{self.hostname}/status"
+      value_template: "{{{{ value_json.total_time | int }}}}"
       icon: "mdi:clock-outline"
       device:
-        identifiers:
-          - "workpulse_{hostname}"
-        name: "WorkPulse - {hostname}"
-        manufacturer: "WorkPulse"
-        model: "WorkPulse"
-"""
-
-    return yaml_config
+          identifiers:
+          - "{self.identifier}"
+          name: "WorkPulse - {self.hostname}"
+          manufacturer: "WorkPulse"
+          model: "WorkPulse"
+    """
+
+        return yaml_config