Rename microgrid.voltage → voltage_per_phase

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

src/frequenz/sdk/actor/power_distributing/_component_managers/_ev_charger_manager/_ev_charger_manager.py

@@ -55,7 +55,7 @@ def __init__(
         self._ev_charger_ids = self._get_ev_charger_ids()
         self._evc_states = EvcStates()
         self._voltage_cache: LatestValueCache[Sample3Phase[Voltage]] = LatestValueCache(
-            microgrid.voltage().new_receiver(),
+            microgrid.voltage_per_phase().new_receiver(),
             unique_id=f"{type(self).__name__}«{hex(id(self))}»:voltage_cache",
         )
         self._config = EVDistributionConfig(component_ids=self._ev_charger_ids)

src/frequenz/sdk/microgrid/__init__.py

@@ -234,7 +234,7 @@
     new_ev_charger_pool,
     new_pv_pool,
     producer,
-    voltage,
+    voltage_per_phase,
 )
 
 
@@ -263,5 +263,5 @@ async def initialize(server_url: str, resampler_config: ResamplerConfig) -> None
     "new_ev_charger_pool",
     "new_pv_pool",
     "producer",
-    "voltage",
+    "voltage_per_phase",
 ]

src/frequenz/sdk/microgrid/_data_pipeline.py

@@ -139,8 +139,8 @@ def frequency(self) -> GridFrequency:
 
         return self._frequency_instance
 
-    def voltage(self) -> VoltageStreamer:
-        """Return the 3-phase voltage measuring point."""
+    def voltage_per_phase(self) -> VoltageStreamer:
+        """Return the per-phase voltage measuring point."""
         if not self._voltage_instance:
             self._voltage_instance = VoltageStreamer(
                 self._resampling_request_sender(),
@@ -506,9 +506,9 @@ def frequency() -> GridFrequency:
     return _get().frequency()
 
 
-def voltage() -> VoltageStreamer:
-    """Return the 3-phase voltage measuring point."""
-    return _get().voltage()
+def voltage_per_phase() -> VoltageStreamer:
+    """Return the per-phase voltage measuring point."""
+    return _get().voltage_per_phase()
 
 
 def logical_meter() -> LogicalMeter:

src/frequenz/sdk/timeseries/_voltage_streamer.py

@@ -44,7 +44,7 @@ class VoltageStreamer:
         )
 
         # Get a receiver for the phase-to-neutral voltage.
-        voltage_recv = microgrid.voltage().new_receiver()
+        voltage_recv = microgrid.voltage_per_phase().new_receiver()
 
         async for voltage_sample in voltage_recv:
             print(voltage_sample)

tests/timeseries/test_voltage_streamer.py

@@ -22,7 +22,7 @@ async def test_voltage_1(mocker: MockerFixture) -> None:
     mockgrid.add_batteries(1, no_meter=False)
 
     async with mockgrid:
-        voltage = microgrid.voltage()
+        voltage = microgrid.voltage_per_phase()
         voltage_recv = voltage.new_receiver()
 
         assert voltage._task is not None
@@ -56,7 +56,7 @@ async def test_voltage_2(mocker: MockerFixture) -> None:
     mockgrid.add_batteries(1, no_meter=True)
 
     async with mockgrid:
-        voltage = microgrid.voltage()
+        voltage = microgrid.voltage_per_phase()
         voltage_recv = voltage.new_receiver()
 
         assert voltage._task is not None
@@ -89,7 +89,7 @@ async def test_voltage_3(mocker: MockerFixture) -> None:
     mockgrid.add_batteries(2, no_meter=False)
 
     async with mockgrid:
-        voltage = microgrid.voltage()
+        voltage = microgrid.voltage_per_phase()
         voltage_recv = voltage.new_receiver()
 
         assert voltage._task is not None