Add account type (#14)

Author: klaasnicolaas

README.md

@@ -24,18 +24,28 @@ With this python library you can request data from [forecast.solar](https://fore
 
 This library returns a lot of different data, based on the API:
 
-- Estimated Energy Production - Today
-- Estimated Energy Production - Tomorrow
-- Estimated Energy Production - This Hour
-- Estimated Energy Production - Next Hour
-- Highest Power Peak Time - Today
-- Highest Power Peak Time - Tomorrow
-- Estimated Power Production - Now
-- Estimated Power Production - Next Hour
-- Estimated Power Production - Next +6 Hours
-- Estimated Power Production - Next +12 Hours
-- Estimated Power Production - Next +24 Hours
+### Energy
+
+- Total Estimated Energy Production - today/tomorrow (kWh)
+- Estimated Energy Production - This Hour (kWh)
+- Estimated Energy Production - Next Hour (kWh)
+
+### Power
+
+- Highest Power Peak Time - Today (datetime)
+- Highest Power Peak Time - Tomorrow (datetime)
+- Estimated Power Production - Now (W)
+- Estimated Power Production - Next Hour (W)
+- Estimated Power Production - In +6 Hours (W)
+- Estimated Power Production - In +12 Hours (W)
+- Estimated Power Production - In +24 Hours (W)
+
+### API Info
+
 - Timezone
+- Rate limit
+- Account type
+- Rate remaining
 
 ## Contributing
 

example.py

@@ -48,11 +48,12 @@ async def main():
         )
         print()
         print(f"energy_current_hour: {estimate.energy_current_hour}")
-        print(f"energy_production_next_hour: {estimate.sum_energy_production(1)}")
-        print(f"energy_production_next_6hours: {estimate.sum_energy_production(6)}")
-        print(f"energy_production_next_12hours: {estimate.sum_energy_production(12)}")
-        print(f"energy_production_next_24hours: {estimate.sum_energy_production(24)}")
+        print(f"energy_production next hour: {estimate.sum_energy_production(1)}")
+        print(f"energy_production next 6 hours: {estimate.sum_energy_production(6)}")
+        print(f"energy_production next 12 hours: {estimate.sum_energy_production(12)}")
+        print(f"energy_production next 24 hours: {estimate.sum_energy_production(24)}")
         print(f"timezone: {estimate.timezone}")
+        print(f"account_type: {estimate.account_type}")
         print(forecast.ratelimit)
 
 

forecast_solar/models.py

@@ -3,6 +3,7 @@
 
 from dataclasses import dataclass
 from datetime import datetime, timedelta, date
+from enum import Enum
 from typing import Any
 import sys
 
@@ -25,6 +26,14 @@ def _timed_value(at: datetime, data: dict[datetime, int]) -> int | None:
     return None
 
 
+class AccountType(str, Enum):
+    """Enumeration representing the Forecast.Solar account type."""
+
+    PUBLIC = "public"
+    PERSONAL = "personal"
+    PROFESSIONAL = "professional"
+
+
 @dataclass
 class Estimate:
     """Object holding estimate forecast results from Forecast.Solar.
@@ -38,13 +47,23 @@ class Estimate:
     wh_days: dict[datetime, int]
     wh_hours: dict[datetime, int]
     watts: dict[datetime, int]
+    api_rate_limit: int
     api_timezone: str
 
     @property
     def timezone(self) -> str:
         """Return API timezone information."""
         return self.api_timezone
 
+    @property
+    def account_type(self) -> AccountType:
+        """Return API account_type information."""
+        if self.api_rate_limit == 60:
+            return AccountType.PERSONAL
+        if self.api_rate_limit == 5:
+            return AccountType.PROFESSIONAL
+        return AccountType.PUBLIC
+
     @property
     def energy_production_today(self) -> int:
         """Return estimated energy produced today."""
@@ -158,6 +177,7 @@ def from_dict(cls, data: dict[str, Any]) -> Estimate:
             watts={
                 datetime.fromisoformat(d): w for d, w in data["result"]["watts"].items()
             },
+            api_rate_limit=data["message"]["ratelimit"]["limit"],
             api_timezone=data["message"]["info"]["timezone"],
         )