feat: updated the default names of various sensors to be more useful …

…in areas of HA when space is limited

BREAKING CHANGE:
If you are relying on the previous default names of sensors then you will need to update your
sensors manually. Only the visual default name of the sensors have changed; the entity ids will
remain the same and therefore will not effect any automatmations. If you have manually changed the
names of the sensors, this should not effect you.

custom_components/octopus_energy/electricity/base.py

@@ -17,7 +17,7 @@ def __init__(self, hass: HomeAssistant, meter, point):
     self._is_export = meter["is_export"]
     self._is_smart_meter = meter["is_smart_meter"]
     self._export_id_addition = "_export" if self._is_export == True else ""
-    self._export_name_addition = " Export" if self._is_export == True else ""
+    self._export_name_addition = "Export " if self._is_export == True else ""
 
     self._attributes = {
       "mpan": self._mpan,

custom_components/octopus_energy/electricity/current_accumulative_consumption.py

@@ -63,9 +63,9 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    base_name = f"Electricity {self._serial_number} {self._mpan} Current Accumulative Consumption"
+    base_name = f"Current Accumulative Consumption Electricity ({self._serial_number}/{self._mpan})"
     if self._peak_type is not None:
-      return f"{base_name} ({get_peak_name(self._peak_type)})"
+      return f"{get_peak_name(self._peak_type)} {base_name}"
 
     return base_name
 

custom_components/octopus_energy/electricity/current_accumulative_cost.py

@@ -64,9 +64,9 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    base_name = f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Current Accumulative Cost"
+    base_name = f"Current Accumulative Cost {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
     if self._peak_type is not None:
-      return f"{base_name} ({get_peak_name(self._peak_type)})"
+      return f"{get_peak_name(self._peak_type)} {base_name}"
 
     return base_name
 

custom_components/octopus_energy/electricity/current_consumption.py

@@ -50,7 +50,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan} Current Consumption"
+    return f"Current Consumption Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/electricity/current_demand.py

@@ -45,7 +45,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan} Current Demand"
+    return f"Current Demand Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/electricity/current_rate.py

@@ -61,7 +61,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Current Rate"
+    return f"Current Rate {self._export_name_addition}Electricity ({self._serial_number} {self._mpan})"
 
   @property
   def state_class(self):

custom_components/octopus_energy/electricity/next_rate.py

@@ -53,7 +53,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Next Rate"
+    return f"Next Rate {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def state_class(self):

custom_components/octopus_energy/electricity/off_peak.py

@@ -52,7 +52,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Off Peak"
+    return f"Off Peak {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def icon(self):

custom_components/octopus_energy/electricity/previous_accumulative_consumption.py

@@ -72,7 +72,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    base_name = f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Accumulative Consumption"
+    base_name = f"Previous Accumulative Consumption {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
     if self._peak_type is not None:
       return f"{base_name} ({get_peak_name(self._peak_type)})"

custom_components/octopus_energy/electricity/previous_accumulative_cost.py

@@ -65,7 +65,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    base_id = f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Accumulative Cost"
+    base_id = f"Previous Accumulative Cost {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
     if self._peak_type is not None:
       return f"{base_id} ({get_peak_name(self._peak_type)})"
 

custom_components/octopus_energy/electricity/previous_accumulative_cost_override.py

@@ -65,7 +65,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Accumulative Cost Override"
+    return f"Previous Accumulative Cost Override {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def entity_registry_enabled_default(self) -> bool:

custom_components/octopus_energy/electricity/previous_accumulative_cost_override_tariff.py

@@ -55,7 +55,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Cost Override Tariff"
+    return f"Previous Cost Override Tariff {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def icon(self):

custom_components/octopus_energy/electricity/previous_rate.py

@@ -53,7 +53,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Rate"
+    return f"Previous Rate {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def state_class(self):

custom_components/octopus_energy/electricity/rates_current_day.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Current Day Rates"
+    return f"Current Day Rates {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/rates_next_day.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Next Day Rates"
+    return f"Next Day Rates {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/rates_previous_consumption.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Consumption Rates"
+    return f"Previous Consumption Rates {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def entity_registry_enabled_default(self) -> bool:

custom_components/octopus_energy/electricity/rates_previous_consumption_override.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Consumption Override Rates"
+    return f"Previous Consumption Override Rates {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   @property
   def entity_registry_enabled_default(self) -> bool:

custom_components/octopus_energy/electricity/rates_previous_day.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Previous Day Rates"
+    return f"Previous Day Rates {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})"
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/electricity/standing_charge.py

@@ -39,7 +39,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f'Electricity {self._serial_number} {self._mpan}{self._export_name_addition} Current Standing Charge'
+    return f'Current Standing Charge {self._export_name_addition}Electricity ({self._serial_number}/{self._mpan})'
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/current_accumulative_consumption_cubic_meters.py

@@ -48,7 +48,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Current Accumulative Consumption ({UnitOfVolume.CUBIC_METERS})"
+    return f"Current Accumulative Consumption ({UnitOfVolume.CUBIC_METERS}) Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/current_accumulative_consumption_kwh.py

@@ -48,7 +48,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Current Accumulative Consumption"
+    return f"Current Accumulative Consumption Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/current_accumulative_cost.py

@@ -55,7 +55,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Current Accumulative Cost"
+    return f"Current Accumulative Cost Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/current_consumption.py

@@ -50,7 +50,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Current Consumption"
+    return f"Current Consumption Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/current_rate.py

@@ -55,7 +55,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f'Gas {self._serial_number} {self._mprn} Current Rate'
+    return f'Current Rate Gas ({self._serial_number}/{self._mprn})'
 
   @property
   def state_class(self):

custom_components/octopus_energy/gas/next_rate.py

@@ -51,7 +51,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f'Gas {self._serial_number} {self._mprn} Next Rate'
+    return f'Next Rate Gas ({self._serial_number}/{self._mprn})'
 
   @property
   def state_class(self):

custom_components/octopus_energy/gas/previous_accumulative_consumption_cubic_meters.py

@@ -66,7 +66,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Accumulative Consumption"
+    return f"Previous Accumulative Consumption Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/previous_accumulative_consumption_kwh.py

@@ -61,7 +61,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Accumulative Consumption (kWh)"
+    return f"Previous Accumulative Consumption (kWh) Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/previous_accumulative_cost.py

@@ -61,7 +61,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Accumulative Cost"
+    return f"Previous Accumulative Cost Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def device_class(self):

custom_components/octopus_energy/gas/previous_accumulative_cost_override.py

@@ -66,7 +66,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Accumulative Cost Override"
+    return f"Previous Accumulative Cost Override Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def entity_registry_enabled_default(self) -> bool:

custom_components/octopus_energy/gas/previous_accumulative_cost_override_tariff.py

@@ -55,7 +55,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Cost Override Tariff"
+    return f"Previous Cost Override Tariff Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def icon(self):

custom_components/octopus_energy/gas/previous_rate.py

@@ -51,7 +51,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f'Gas {self._serial_number} {self._mprn} Previous Rate'
+    return f'Previous Rate Gas ({self._serial_number}/{self._mprn})'
 
   @property
   def state_class(self):

custom_components/octopus_energy/gas/rates_current_day.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Current Day Rates"
+    return f"Current Day Rates Gas ({self._serial_number}/{self._mprn})"
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/gas/rates_next_day.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Next Day Rates"
+    return f"Next Day Rates Gas ({self._serial_number}/{self._mprn})"
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/gas/rates_previous_consumption.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Consumption Rates"
+    return f"Previous Consumption Rates Gas ({self._serial_number}/{self._mprn})"
 
   @property
   def entity_registry_enabled_default(self) -> bool:

custom_components/octopus_energy/gas/rates_previous_consumption_override.py

@@ -44,7 +44,7 @@ def entity_registry_enabled_default(self) -> bool:
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Consumption Override Rates"
+    return f"Previous Consumption Override Rates Gas ({self._serial_number}/{self._mprn})"
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/gas/rates_previous_day.py

@@ -36,7 +36,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Gas {self._serial_number} {self._mprn} Previous Day Rates"
+    return f"Previous Day Rates Gas ({self._serial_number}/{self._mprn})"
 
   async def async_added_to_hass(self):
     """Call when entity about to be added to hass."""

custom_components/octopus_energy/gas/standing_charge.py

@@ -40,7 +40,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f'Gas {self._serial_number} {self._mprn} Current Standing Charge'
+    return f'Current Standing Charge Gas ({self._serial_number}/{self._mprn})'
 
   @property
   def state_class(self):

custom_components/octopus_energy/intelligent/bump_charge.py

@@ -46,7 +46,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Octopus Energy {self._account_id} Intelligent Bump Charge"
+    return f"Intelligent Bump Charge ({self._account_id})"
 
   @property
   def icon(self):

custom_components/octopus_energy/intelligent/charge_limit.py

@@ -49,7 +49,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Octopus Energy {self._account_id} Intelligent Charge Limit"
+    return f"Intelligent Charge Limit ({self._account_id})"
 
   @property
   def icon(self):

custom_components/octopus_energy/intelligent/dispatching.py

@@ -64,7 +64,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Octopus Energy {self._account_id} Intelligent Dispatching"
+    return f"Intelligent Dispatching ({self._account_id})"
 
   @property
   def icon(self):

custom_components/octopus_energy/intelligent/ready_time.py

@@ -47,7 +47,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Octopus Energy {self._account_id} Intelligent Ready Time"
+    return f"Intelligent Ready Time ({self._account_id})"
 
   @property
   def icon(self):

custom_components/octopus_energy/intelligent/smart_charge.py

@@ -45,7 +45,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Octopus Energy {self._account_id} Intelligent Smart Charge"
+    return f"Intelligent Smart Charge ({self._account_id})"
 
   @property
   def icon(self):

custom_components/octopus_energy/octoplus/points.py

@@ -49,7 +49,7 @@ def unique_id(self):
   @property
   def name(self):
     """Name of the sensor."""
-    return f"Octopus Energy {self._account_id} Octoplus Points"
+    return f"Octoplus Points ({self._account_id})"
 
   @property
   def icon(self):