✨ Add device timeseries

Author: MateoGreil

README.md

@@ -10,6 +10,7 @@ The client currently supports the following methods:
 - `get_authenticated_user(self)`: Retrieves information about the authenticated user.
 - `get_sites(self)`: Retrieves a list of sites associated with the authenticated user.
 - `get_devices(self, site_id)`: Retrieves a list of devices for the specified site.
+- `get_device_ts_time_ago(self, device_id, measure_kind = "FLOW", aggregation_level = "HOUR", aggregation_type = "MAX", time_ago_unit = "DAY", time_ago_value = "1")`: Retrieves the time series data for a specific device, based on the provided parameters.
 
 ## Installation
 You can install the Comwatt Python Client using pip. Run the following command:
@@ -44,6 +45,10 @@ print(sites)
 # Get a list of devices for a specific site
 devices = client.get_devices(sites[0]['id'])
 print(devices)
+
+# Get time series data for a specific device
+time_series_data = client.get_device_ts_time_ago(devices[0]['id'])
+print(time_series_data)
 ```
 
 Make sure to replace `'username'`, `'password'` with the actual values for your Comwatt account.

comwatt/client.py

@@ -43,3 +43,12 @@ def get_devices(self, site_id):
             return response.json()
         else:
             raise Exception(f'Error retrieving sites: {response.sttaus_code}')
+
+    def get_device_ts_time_ago(self, device_id, measure_kind = "FLOW", aggregation_level = "HOUR", aggregation_type = "MAX", time_ago_unit = "DAY", time_ago_value = "1"):
+        url = f'{self.base_url}/aggregations/device-ts-time-ago?deviceId={device_id}&measureKind={measure_kind}&aggregationLevel={aggregation_level}&aggregationType={aggregation_type}&timeAgoUnit={time_ago_unit}&timeAgoValue={time_ago_value}'
+
+        response = self.session.get(url)
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f'Error retrieving aggregations: {response.status_code}')