Skip to content

Rename projection interval sensors and explicit friendly names #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LordMike merged 3 commits into from
Mar 16, 2026
Merged

Rename projection interval sensors and explicit friendly names #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3727f1c
Rename projection interval sensors and explicit friendly names
LordMike Mar 16, 2026
76d01be
Merge branch 'main' into codex/projection-friendly-names
LordMike Mar 16, 2026
53bb831
Name next-action sensors explicitly
LordMike Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 170 additions & 6 deletions src/custom_components/wattplan/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from .target_runtime import get_active_battery_target

from .const import (
CONF_HOURS_TO_PLAN,
CONF_OPTIONS_COUNT,
CONF_SLOT_MINUTES,
CONF_SOURCE_EXPORT_PRICE,
Expand Down Expand Up @@ -57,6 +58,21 @@
"gp": "(G)rid and (P)V",
}

ENTRY_FRIENDLY_NAMES: dict[str, str] = {
"status": "Status",
"status_message": "Status Message",
"import_price_status": "Import Price Status",
"export_price_status": "Export Price Status",
"usage_status": "Usage Status",
"usage_forecast": "Usage Forecast",
"pv_status": "PV Status",
"last_run": "Last Run",
"next_run": "Next Run",
"last_run_duration": "Last Run Duration",
"plan_details": "Plan Details",
"plan_details_hourly": "Plan Details Hourly",
}


def _subentry_slug(subentry: Any) -> str:
"""Return slug for subentry naming."""
Expand All @@ -68,6 +84,55 @@ def _entry_slug(config_entry: ConfigEntry) -> str:
return slugify(config_entry.title) or "entry"


def _subentry_display_name(subentry: Any) -> str:
"""Return configured subentry display name, falling back to title."""
return str(subentry.data.get(CONF_NAME, subentry.title))


def _duration_label(*, minutes: int) -> str:
"""Return a compact duration label for user-facing sensor names."""
if minutes % 60 == 0:
return f"{minutes // 60}h"
return f"{minutes}m"


def _entry_sensor_name(
sensor_key: str, *, slot_minutes: int, hours_to_plan: int
) -> str:
"""Return explicit entry-level sensor name."""
if sensor_key == "projected_cost_savings":
return f"Projected Cost Savings over {_duration_label(minutes=hours_to_plan * 60)}"
if sensor_key == "projected_savings_percentage":
return (
"Projected Savings Percentage over "
f"{_duration_label(minutes=hours_to_plan * 60)}"
)
if sensor_key == "projected_cost_savings_this_interval":
return f"Projected Cost Savings over {_duration_label(minutes=slot_minutes)}"
if sensor_key == "projected_savings_percentage_this_interval":
return (
"Projected Savings Percentage over "
f"{_duration_label(minutes=slot_minutes)}"
)
return ENTRY_FRIENDLY_NAMES[sensor_key]


def _subentry_sensor_name(subentry_name: str, sensor_key: str) -> str:
"""Return explicit subentry-level sensor name."""
if sensor_key == "target":
return f"({subentry_name}) Target"
if sensor_key == "action":
return f"({subentry_name}) Action"
if sensor_key == "next_action":
return f"({subentry_name}) Next Action"
if sensor_key == "next_start_option":
return f"({subentry_name}) Next Start Option"
if sensor_key.startswith("option_") and sensor_key.endswith("_start"):
option_number = sensor_key[len("option_") : -len("_start")]
return f"({subentry_name}) Option {option_number} Start"
raise ValueError(f"Unsupported subentry sensor key: {sensor_key}")


def _entry_device_info(config_entry: ConfigEntry) -> DeviceInfo:
"""Return shared device info for all entry entities."""
return DeviceInfo(
Expand Down Expand Up @@ -101,13 +166,15 @@ def __init__(
coordinator: WattPlanCoordinator,
*,
object_id: str,
friendly_name: str,
unique_id: str,
device_class: SensorDeviceClass | None = None,
) -> None:
"""Initialize coordinator-backed sensor."""
super().__init__(coordinator)
self._attr_object_id = object_id
self._attr_name = object_id
self._attr_name = friendly_name
self.internal_integration_suggested_object_id = object_id
self._attr_unique_id = unique_id
self._attr_device_info = _entry_device_info(config_entry)
if device_class is not None:
Expand Down Expand Up @@ -365,11 +432,13 @@ def __init__(
subentry_id: str,
*,
object_id: str,
friendly_name: str,
unique_id: str,
) -> None:
"""Initialize battery target sensor."""
self._attr_object_id = object_id
self._attr_name = object_id
self._attr_name = friendly_name
self.internal_integration_suggested_object_id = object_id
self._attr_unique_id = unique_id
self._attr_device_info = _entry_device_info(config_entry)
self._runtime_data = runtime_data
Expand Down Expand Up @@ -707,46 +776,72 @@ async def async_setup_entry(
) -> None:
"""Set up WattPlan sensors for one config entry."""
entry_slug = _entry_slug(config_entry)
slot_minutes = int(config_entry.data[CONF_SLOT_MINUTES])
hours_to_plan = int(config_entry.data[CONF_HOURS_TO_PLAN])
runtime_data = config_entry.runtime_data
coordinator = runtime_data.coordinator

sensors: list[SensorEntity] = [
StatusSensor(
config_entry,
coordinator,
friendly_name=_entry_sensor_name(
"status", slot_minutes=slot_minutes, hours_to_plan=hours_to_plan
),
object_id=f"{entry_slug}_status",
unique_id=f"{config_entry.entry_id}:entry:status",
),
StatusMessageSensor(
config_entry,
coordinator,
friendly_name=_entry_sensor_name(
"status_message",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_status_message",
unique_id=f"{config_entry.entry_id}:entry:status_message",
),
SourceStatusSensor(
config_entry,
coordinator,
source_key=CONF_SOURCE_IMPORT_PRICE,
friendly_name=_entry_sensor_name(
"import_price_status",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_import_price_status",
unique_id=f"{config_entry.entry_id}:entry:import_price_status",
),
LastRunSensor(
config_entry,
coordinator,
friendly_name=_entry_sensor_name(
"last_run", slot_minutes=slot_minutes, hours_to_plan=hours_to_plan
),
object_id=f"{entry_slug}_last_run",
unique_id=f"{config_entry.entry_id}:entry:last_run",
device_class=SensorDeviceClass.TIMESTAMP,
),
NextRunSensor(
config_entry,
coordinator,
friendly_name=_entry_sensor_name(
"next_run", slot_minutes=slot_minutes, hours_to_plan=hours_to_plan
),
object_id=f"{entry_slug}_next_run",
unique_id=f"{config_entry.entry_id}:entry:next_run",
device_class=SensorDeviceClass.TIMESTAMP,
),
LastRunDurationSensor(
config_entry,
coordinator,
friendly_name=_entry_sensor_name(
"last_run_duration",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_last_run_duration",
unique_id=f"{config_entry.entry_id}:entry:last_run_duration",
),
Expand All @@ -756,6 +851,11 @@ async def async_setup_entry(
projection_key="projected_savings_cost",
aggregate_mode="horizon",
use_home_currency=True,
friendly_name=_entry_sensor_name(
"projected_cost_savings",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_projected_cost_savings",
unique_id=f"{config_entry.entry_id}:entry:projected_cost_savings",
),
Expand All @@ -764,6 +864,11 @@ async def async_setup_entry(
coordinator,
projection_key="projected_savings_pct",
aggregate_mode="horizon",
friendly_name=_entry_sensor_name(
"projected_savings_percentage",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_projected_savings_percentage",
unique_id=f"{config_entry.entry_id}:entry:projected_savings_percentage",
native_unit_of_measurement="%",
Expand All @@ -774,29 +879,52 @@ async def async_setup_entry(
projection_key="projected_savings_cost",
aggregate_mode="next_interval",
use_home_currency=True,
object_id=f"{entry_slug}_projected_cost_savings_next_interval",
unique_id=f"{config_entry.entry_id}:entry:projected_cost_savings_next_interval",
friendly_name=_entry_sensor_name(
"projected_cost_savings_this_interval",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_projected_cost_savings_this_interval",
unique_id=f"{config_entry.entry_id}:entry:projected_cost_savings_this_interval",
),
ProjectionSensor(
config_entry,
coordinator,
projection_key="projected_savings_pct",
aggregate_mode="next_interval",
object_id=f"{entry_slug}_projected_savings_percentage_next_interval",
unique_id=f"{config_entry.entry_id}:entry:projected_savings_percentage_next_interval",
friendly_name=_entry_sensor_name(
"projected_savings_percentage_this_interval",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_projected_savings_percentage_this_interval",
unique_id=(
f"{config_entry.entry_id}:entry:"
"projected_savings_percentage_this_interval"
),
native_unit_of_measurement="%",
),
PlanDetailsSensor(
config_entry,
coordinator,
details_key="plan_details",
friendly_name=_entry_sensor_name(
"plan_details",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_plan_details",
unique_id=f"{config_entry.entry_id}:entry:plan_details",
),
PlanDetailsSensor(
config_entry,
coordinator,
details_key="plan_details_hourly",
friendly_name=_entry_sensor_name(
"plan_details_hourly",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_plan_details_hourly",
unique_id=f"{config_entry.entry_id}:entry:plan_details_hourly",
),
Expand All @@ -813,6 +941,11 @@ async def async_setup_entry(
config_entry,
coordinator,
source_key=CONF_SOURCE_USAGE,
friendly_name=_entry_sensor_name(
"usage_status",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_usage_status",
unique_id=f"{config_entry.entry_id}:entry:usage_status",
)
Expand All @@ -826,6 +959,11 @@ async def async_setup_entry(
UsageForecastSensor(
config_entry,
coordinator,
friendly_name=_entry_sensor_name(
"usage_forecast",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_usage_forecast",
unique_id=f"{config_entry.entry_id}:entry:usage_forecast",
)
Expand All @@ -842,6 +980,11 @@ async def async_setup_entry(
config_entry,
coordinator,
source_key=CONF_SOURCE_EXPORT_PRICE,
friendly_name=_entry_sensor_name(
"export_price_status",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_export_price_status",
unique_id=f"{config_entry.entry_id}:entry:export_price_status",
)
Expand All @@ -858,13 +1001,19 @@ async def async_setup_entry(
config_entry,
coordinator,
source_key=CONF_SOURCE_PV,
friendly_name=_entry_sensor_name(
"pv_status",
slot_minutes=slot_minutes,
hours_to_plan=hours_to_plan,
),
object_id=f"{entry_slug}_pv_status",
unique_id=f"{config_entry.entry_id}:entry:pv_status",
)
)

for subentry in config_entry.subentries.values():
sub_slug = _subentry_slug(subentry)
subentry_name = _subentry_display_name(subentry)
if subentry.subentry_type == SUBENTRY_TYPE_BATTERY:
sensors.extend(
[
Expand All @@ -874,6 +1023,7 @@ async def async_setup_entry(
config_entry,
runtime_data,
subentry.subentry_id,
friendly_name=_subentry_sensor_name(subentry_name, "target"),
object_id=f"{entry_slug}_{sub_slug}_target",
unique_id=f"{config_entry.entry_id}:{subentry.subentry_id}:target",
),
Expand All @@ -882,6 +1032,7 @@ async def async_setup_entry(
coordinator,
subentry_id=subentry.subentry_id,
group="batteries",
friendly_name=_subentry_sensor_name(subentry_name, "action"),
object_id=f"{entry_slug}_{sub_slug}_action",
unique_id=f"{config_entry.entry_id}:{subentry.subentry_id}:action",
),
Expand All @@ -890,6 +1041,9 @@ async def async_setup_entry(
coordinator,
subentry_id=subentry.subentry_id,
group="batteries",
friendly_name=_subentry_sensor_name(
subentry_name, "next_action"
),
object_id=f"{entry_slug}_{sub_slug}_next_action",
unique_id=(
f"{config_entry.entry_id}:{subentry.subentry_id}:next_action"
Expand All @@ -905,6 +1059,7 @@ async def async_setup_entry(
coordinator,
subentry_id=subentry.subentry_id,
group="comforts",
friendly_name=_subentry_sensor_name(subentry_name, "action"),
object_id=f"{entry_slug}_{sub_slug}_action",
unique_id=f"{config_entry.entry_id}:{subentry.subentry_id}:action",
),
Expand All @@ -913,6 +1068,9 @@ async def async_setup_entry(
coordinator,
subentry_id=subentry.subentry_id,
group="comforts",
friendly_name=_subentry_sensor_name(
subentry_name, "next_action"
),
object_id=f"{entry_slug}_{sub_slug}_next_action",
unique_id=(
f"{config_entry.entry_id}:{subentry.subentry_id}:next_action"
Expand All @@ -930,6 +1088,9 @@ async def async_setup_entry(
coordinator,
subentry_id=subentry.subentry_id,
key="next_start_option",
friendly_name=_subentry_sensor_name(
subentry_name, "next_start_option"
),
object_id=f"{entry_slug}_{sub_slug}_next_start_option",
unique_id=(
f"{config_entry.entry_id}:{subentry.subentry_id}:"
Expand All @@ -946,6 +1107,9 @@ async def async_setup_entry(
coordinator,
subentry_id=subentry.subentry_id,
key=option_key,
friendly_name=_subentry_sensor_name(
subentry_name, option_key
),
object_id=f"{entry_slug}_{sub_slug}_option_{option_index}_start",
unique_id=(
f"{config_entry.entry_id}:{subentry.subentry_id}:"
Expand Down
Loading
Loading