Skip to content

Commit 114597c

Browse files
committed
Added doc string for get_battery_day_stats
1 parent 20565f0 commit 114597c

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

src/fusion_solar_py/client.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -654,11 +654,15 @@ def get_battery_basic_stats(self, battery_id: str) -> BatteryStatus:
654654
return battery_status
655655

656656
@logged_in
657-
def get_battery_day_stats(self, battery_id: str,query_time: int = None) -> dict:
657+
def get_battery_day_stats(self, battery_id: str, query_time: int = None) -> dict:
658658
"""Retrieves the SOC (state of charge) in % and charge/discharge power in kW of
659659
the battery for the current day.
660660
:param battery_id: The battery's id
661661
:type battery_id: str
662+
:param query_time: If set, must be set to 00:00:00 of the day the data should
663+
be fetched for. If not set, retrieves the data for the
664+
current day.
665+
:type query_time: int
662666
:return: The complete data structure as a dict
663667
"""
664668
current_time = round(time.time() * 1000)

0 commit comments

Comments
 (0)