Merge pull request #4 from RepositPower/feature/add-remaining-charge

Add remaining charge method

Author: tombasche

README.md

@@ -43,14 +43,15 @@ print(controller.battery_capacity)
 | `battery_min_state_of_charge`      | -      | Get the minimum state of charge of the battery | Percentage (%)
 | `has_battery` | -      | Bool of whether the user has a battery or not| True/False |
 | `has_inverter` | -      | Bool of whether the user has an inverter or not| True/False |
-| `get_solar_generation_data` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of solar generation data based on start or end| kW |
-|`latest_solar_generation_data`|-|Get a list of the latest generation data. Goes back the last 24 hours.| kW |
-| `get_house_data` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of house data based on start or end| kW|
-|`latest_house_data`|-|Get a list of the latest house data. Goes back the last 24 hours.| kW|
+| `get_solar_generation` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of solar generation data based on start or end| kW |
+|`latest_solar_generation`|-|Get a list of the latest generation data. Goes back the last 24 hours.| kW |
+| `get_house_consumption` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of house consumption values based on start or end| kW|
+|`latest_house_consumption`|-|Get a list of the latest house consumption. Goes back the last 24 hours.| kW|
 | `get_battery_data` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of battery data based on start or end| kWh |
-|`latest_battery_data`|-|Get a list of the latest battery data. Goes back the last 24 hours.| kWh |pip 
-| `get_meter_data` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of meter data based on start or end. There should be at least a 5 minute gap between start and end timestamps (i.e. 300 seconds) | kWh
-|`latest_meter_data`|-|Get a list of the latest meter data. Goes back the last 24 hours.| kWh |
+|`latest_battery_data`|-|Get a list of the latest battery data. Goes back the last 24 hours.| kWh |
+| `get_remaining_charge` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of the battery's remaining charge values based on start or end. There should be at least a 5 minute gap between start and end timestamps (i.e. 300 seconds)<br/><br/> Note: This can be used to calculate the state of charge with the formula: (remaining_charge / battery_capacity) * 100` | kWh
+| `get_meter_data` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of meter data based on start or end. There should be at least a 5 minute gap between start and end timestamps (i.e. 300 seconds) | kW
+|`latest_meter_data`|-|Get a list of the latest meter data. Goes back the last 24 hours.| kW |
 |`feed_in_tariff`|-|Get the feed-in-tariff| Dollars ($) |
 
 ## Links

reposit/auth/exceptions.py

@@ -8,4 +8,5 @@ class NoAuthenticationError(Exception):
     If a method is called that requires an access token and none is yet
     set then raise this error
     """
+    # pylint: disable=unnecessary-pass
     pass

reposit/data/api.py

@@ -108,7 +108,7 @@ def query(self, start, end=None):
             raise ex
 
         data = self._simple_format_for_fields(resp)
-        return {'data': data[0]}  # because this is a list of lists
+        return {'data': data}
 
     def _simple_format_for_fields(self, api_response):
         """

reposit/data/controller.py

@@ -80,7 +80,7 @@ def has_inverter(self):
         )
         return request.get()
 
-    def get_solar_generation_data(self, start, end):
+    def get_solar_generation(self, start, end=None):
         """
         Given a start and end timestamp return the generation
         data.
@@ -98,7 +98,7 @@ def get_solar_generation_data(self, start, end):
         return request.query(start, end)
 
     @property
-    def latest_solar_generation_data(self):
+    def latest_solar_generation(self):
         """
         Return a list of data points as lists. Time are in GMT
         :return:
@@ -112,7 +112,7 @@ def latest_solar_generation_data(self):
         )
         return request.get()
 
-    def get_house_data(self, start, end):
+    def get_house_consumption(self, start, end=None):
         """
         Given a start and end timestamp return the house
         data.
@@ -130,7 +130,7 @@ def get_house_data(self, start, end):
         return request.query(start, end)
 
     @property
-    def latest_house_data(self):
+    def latest_house_consumption(self):
         """
         Return a list of data points as lists. Time are in GMT
         :return:
@@ -146,7 +146,7 @@ def latest_house_data(self):
         )
         return request.get()
 
-    def get_battery_data(self, start, end):
+    def get_battery_data(self, start, end=None):
         """
         Given a start and end timestamp return the inverter
         data.
@@ -178,7 +178,24 @@ def latest_battery_data(self):
         )
         return request.get()
 
-    def get_meter_data(self, start, end):
+    def get_remaining_charge(self, start, end=None):
+        """
+        Given a start and end timestamp return the remaining battery charge
+        data.
+        :param start: unix timestamp
+        :param end: unix timestamp
+        :return: list of lists of data
+        """
+        request = ApiRequest(
+            path='v2/deployments/{}/battery/historical/soc'.format(self.user_key),
+            controller=self,
+            schema={
+                'batterySOC': {}
+            }
+        )
+        return request.query(start, end)
+
+    def get_meter_data(self, start, end=None):
         """
         Given a start and end timestamp return the meter
         data.

reposit/data/exceptions.py

@@ -7,4 +7,5 @@ class InvalidControllerException(Exception):
     """
     A connection is attempted without auth headers
     """
+    # pylint: disable=unnecessary-pass
     pass

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="reposit",
-    version="0.3.1",
+    version="0.4.0",
     author="Thomas Basche",
     author_email="[email protected]",
     description="A library to communicate with a Reposit Controller",