Skip to content

Expose IOT emeter info as features #844

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
rytilahti merged 6 commits into from
Apr 25, 2024
Merged

Expose IOT emeter info as features #844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e411c85
Expose IOT emeter info as features
rytilahti Apr 19, 2024
7b5df53
Fix mypy issue
sdb9696 Apr 22, 2024
01bff49
Add ids for homeassistant compat
rytilahti Apr 23, 2024
52203fc
Add emeter_total impl
rytilahti Apr 23, 2024
02ad6c3
Merge branch 'master' into feat/iot_emeter
sdb9696 Apr 25, 2024
8e0c093
Do not automatically add emeter to iot strip (#865)
sdb9696 Apr 25, 2024
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
7 changes: 3 additions & 4 deletions kasa/iot/iotstrip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
requires_update,
)
from .iotplug import IotPlug
from .modules import Antitheft, Countdown, Emeter, Schedule, Time, Usage
from .modules import Antitheft, Countdown, Schedule, Time, Usage

_LOGGER = logging.getLogger(__name__)

Expand Down Expand Up @@ -100,7 +100,6 @@ def __init__(
self.add_module("usage", Usage(self, "schedule"))
self.add_module("time", Time(self, "time"))
self.add_module("countdown", Countdown(self, "countdown"))
self.add_module("emeter", Emeter(self, "emeter"))

@property # type: ignore
@requires_update
Expand Down Expand Up @@ -217,13 +216,13 @@ async def erase_emeter_stats(self):
@requires_update
def emeter_this_month(self) -> float | None:
"""Return this month's energy consumption in kWh."""
return sum(plug.emeter_this_month for plug in self.children)
return sum(v if (v := plug.emeter_this_month) else 0 for plug in self.children)

@property # type: ignore
@requires_update
def emeter_today(self) -> float | None:
"""Return this month's energy consumption in kWh."""
return sum(plug.emeter_today for plug in self.children)
return sum(v if (v := plug.emeter_today) else 0 for plug in self.children)

@property # type: ignore
@requires_update
Expand Down
84 changes: 84 additions & 0 deletions kasa/iot/modules/emeter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,77 @@

from datetime import datetime

from ... import Device
from ...emeterstatus import EmeterStatus
from ...feature import Feature
from .usage import Usage


class Emeter(Usage):
"""Emeter module."""

def __init__(self, device: Device, module: str):
super().__init__(device, module)
self._add_feature(
Feature(
device,
name="Current consumption",
attribute_getter="current_consumption",
container=self,
unit="W",
id="current_power_w", # for homeassistant backwards compat
)
)
self._add_feature(
Feature(
device,
name="Today's consumption",
attribute_getter="emeter_today",
container=self,
unit="kWh",
id="today_energy_kwh", # for homeassistant backwards compat
)
)
self._add_feature(
Feature(
device,
name="This month's consumption",
attribute_getter="emeter_this_month",
container=self,
unit="kWh",
)
)
self._add_feature(
Feature(
device,
name="Total consumption since reboot",
attribute_getter="emeter_total",
container=self,
unit="kWh",
id="total_energy_kwh", # for homeassistant backwards compat
)
)
self._add_feature(
Feature(
device,
name="Voltage",
attribute_getter="voltage",
container=self,
unit="V",
id="voltage", # for homeassistant backwards compat
)
)
self._add_feature(
Feature(
device,
name="Current",
attribute_getter="current",
container=self,
unit="A",
id="current_a", # for homeassistant backwards compat
)
)

@property # type: ignore
def realtime(self) -> EmeterStatus:
"""Return current energy readings."""
Expand All @@ -32,6 +96,26 @@ def emeter_this_month(self) -> float | None:
data = self._convert_stat_data(raw_data, entry_key="month", key=current_month)
return data.get(current_month)

@property
def current_consumption(self) -> float | None:
"""Get the current power consumption in Watt."""
return self.realtime.power

@property
def emeter_total(self) -> float | None:
"""Return total consumption since last reboot in kWh."""
return self.realtime.total

@property
def current(self) -> float | None:
"""Return the current in A."""
return self.realtime.current

@property
def voltage(self) -> float | None:
"""Get the current voltage in V."""
return self.realtime.voltage

async def erase_stats(self):
"""Erase all stats.

Expand Down