Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-22 19:23:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update cli energy command to use energy module (#1252)

Browse Source
This commit is contained in:
Steven B. 2024-11-13 14:57:42 +00:00 committed by GitHub
parent 9efe871814
commit 157ad8e807
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 25 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
kasa/cli/usage.py
View File

@ -9,11 +9,9 @@ import asyncclick as click
from kasa import ( from kasa import (
Device, Device,
Module,
) )
from kasa.iot import ( from kasa.interfaces import Energy
IotDevice,
)
from kasa.iot.iotstrip import IotStripPlug
from kasa.iot.modules import Usage from kasa.iot.modules import Usage
from .common import ( from .common import (
@ -49,42 +47,39 @@ async def energy(dev: Device, year, month, erase):
Daily and monthly data provided in CSV format. Daily and monthly data provided in CSV format.
""" """
echo("[bold]== Emeter ==[/bold]") echo("[bold]== Emeter ==[/bold]")
if not dev.has_emeter: if not (energy := dev.modules.get(Module.Energy)):
error("Device has no emeter") error("Device has no energy module.")
return return
if (year or month or erase) and not isinstance(dev, IotDevice): if (year or month or erase) and not energy.supports(
error("Device has no historical statistics") Energy.ModuleFeature.PERIODIC_STATS
):
error("Device does not support historical statistics")
return return
else:
dev = cast(IotDevice, dev)
if erase: if erase:
echo("Erasing emeter statistics..") echo("Erasing emeter statistics..")
return await dev.erase_emeter_stats() return await energy.erase_stats()
if year: if year:
echo(f"== For year {year.year} ==") echo(f"== For year {year.year} ==")
echo("Month, usage (kWh)") echo("Month, usage (kWh)")
usage_data = await dev.get_emeter_monthly(year=year.year) usage_data = await energy.get_monthly_stats(year=year.year)
elif month: elif month:
echo(f"== For month {month.month} of {month.year} ==") echo(f"== For month {month.month} of {month.year} ==")
echo("Day, usage (kWh)") echo("Day, usage (kWh)")
usage_data = await dev.get_emeter_daily(year=month.year, month=month.month) usage_data = await energy.get_daily_stats(year=month.year, month=month.month)
else: else:
# Call with no argument outputs summary data and returns # Call with no argument outputs summary data and returns
if isinstance(dev, IotStripPlug): emeter_status = await energy.get_status()
emeter_status = await dev.get_emeter_realtime()
else:
emeter_status = dev.emeter_realtime
echo("Current: {} A".format(emeter_status["current"])) echo("Current: {} A".format(emeter_status["current"]))
echo("Voltage: {} V".format(emeter_status["voltage"])) echo("Voltage: {} V".format(emeter_status["voltage"]))
echo("Power: {} W".format(emeter_status["power"])) echo("Power: {} W".format(emeter_status["power"]))
echo("Total consumption: {} kWh".format(emeter_status["total"])) echo("Total consumption: {} kWh".format(emeter_status["total"]))
echo(f"Today: {dev.emeter_today} kWh") echo(f"Today: {energy.consumption_today} kWh")
echo(f"This month: {dev.emeter_this_month} kWh") echo(f"This month: {energy.consumption_this_month} kWh")
return emeter_status return emeter_status

19
tests/test_cli.py
View File

@ -15,6 +15,7 @@ from kasa import (
Credentials, Credentials,
Device, Device,
DeviceError, DeviceError,
DeviceType,
EmeterStatus, EmeterStatus,
KasaException, KasaException,
Module, Module,
@ -424,20 +425,22 @@ async def test_time_set(dev: Device, mocker, runner):
async def test_emeter(dev: Device, mocker, runner): async def test_emeter(dev: Device, mocker, runner):
res = await runner.invoke(emeter, obj=dev) res = await runner.invoke(emeter, obj=dev)
if not dev.has_emeter: if not (energy := dev.modules.get(Module.Energy)):
assert "Device has no emeter" in res.output assert "Device has no energy module." in res.output
return return
assert "== Emeter ==" in res.output assert "== Emeter ==" in res.output
if not dev.is_strip: if dev.device_type is not DeviceType.Strip:
res = await runner.invoke(emeter, ["--index", "0"], obj=dev) res = await runner.invoke(emeter, ["--index", "0"], obj=dev)
assert f"Device: {dev.host} does not have children" in res.output assert f"Device: {dev.host} does not have children" in res.output
res = await runner.invoke(emeter, ["--name", "mock"], obj=dev) res = await runner.invoke(emeter, ["--name", "mock"], obj=dev)
assert f"Device: {dev.host} does not have children" in res.output assert f"Device: {dev.host} does not have children" in res.output
if dev.is_strip and len(dev.children) > 0: if dev.device_type is DeviceType.Strip and len(dev.children) > 0:
realtime_emeter = mocker.patch.object(dev.children[0], "get_emeter_realtime") child_energy = dev.children[0].modules.get(Module.Energy)
assert child_energy
realtime_emeter = mocker.patch.object(child_energy, "get_status")
realtime_emeter.return_value = EmeterStatus({"voltage_mv": 122066}) realtime_emeter.return_value = EmeterStatus({"voltage_mv": 122066})
res = await runner.invoke(emeter, ["--index", "0"], obj=dev) res = await runner.invoke(emeter, ["--index", "0"], obj=dev)
@ -450,18 +453,18 @@ async def test_emeter(dev: Device, mocker, runner):
assert realtime_emeter.call_count == 2 assert realtime_emeter.call_count == 2
if isinstance(dev, IotDevice): if isinstance(dev, IotDevice):
monthly = mocker.patch.object(dev, "get_emeter_monthly") monthly = mocker.patch.object(energy, "get_monthly_stats")
monthly.return_value = {1: 1234} monthly.return_value = {1: 1234}
res = await runner.invoke(emeter, ["--year", "1900"], obj=dev) res = await runner.invoke(emeter, ["--year", "1900"], obj=dev)
if not isinstance(dev, IotDevice): if not isinstance(dev, IotDevice):
assert "Device has no historical statistics" in res.output assert "Device does not support historical statistics" in res.output
return return
assert "For year" in res.output assert "For year" in res.output
assert "1, 1234" in res.output assert "1, 1234" in res.output
monthly.assert_called_with(year=1900) monthly.assert_called_with(year=1900)
if isinstance(dev, IotDevice): if isinstance(dev, IotDevice):
daily = mocker.patch.object(dev, "get_emeter_daily") daily = mocker.patch.object(energy, "get_daily_stats")
daily.return_value = {1: 1234} daily.return_value = {1: 1234}
res = await runner.invoke(emeter, ["--month", "1900-12"], obj=dev) res = await runner.invoke(emeter, ["--month", "1900-12"], obj=dev)
if not isinstance(dev, IotDevice): if not isinstance(dev, IotDevice):