Merge pull request #2 from RepositPower/feature/improve-docco

Fixes for documentation, tidying etc.

Author: tombasche

README.md

@@ -13,8 +13,7 @@
 ## Compatibility
 
 - Python 2.7
-- Python 3+
-- Python 3.6 *preferred*
+- Python 3+ *preferred*
 
 ## Installation
 ```
@@ -38,25 +37,21 @@ print(controller.battery_capacity)
 ```
 
 ## Data
-| Method        | Params          | Description |
-|:-------------:|:-------------|:-------------|
-| `battery_capacity`      | - | Get the capacity of the battery in kWh                |
-| `battery_min_state_of_charge`      | -      | Get the minimum state of charge of the battery |
-| `has_battery` | -      | Bool of whether the user has a battery or not|
-| `has_inverter` | -      | Bool of whether the user has an inverter or not|
-| `get_historical_generation` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of generation data based on start or end|
-|`latest_historical_generation`|-|Get a list of the latest generation data. Goes back the last 24 hours.|
-| `get_historical_house` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of house data based on start or end|
-|`latest_historical_house`|-|Get a list of the latest house data. Goes back the last 24 hours.|
-| `get_historical_grid_credits` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of grid credits earned based on start or end|
-|`latest_historical_house`|-|Get a list of the latest grid credits earned. Goes back the last 24 hours.|
-| `get_historical_inverter` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of inverter data based on start or end|
-|`latest_historical_inverter`|-|Get a list of the latest inverter data. Goes back the last 24 hours.|
-| `get_historical_meter` | <ul><li>start (timestamp)</li><li>end(timestamp)(optional, default=now)</li></ul>  | Get a list of meter data based on start or end|
-|`latest_historical_meter`|-|Get a list of the latest meter data. Goes back the last 24 hours.|
-|`weekday_tou_tariff`|-|Get weekday tou tariff information such as peak/off peak times and rates.|
-|`weekend_tou_tariff`|-|Get weekend tou tariff information such as peak/off peak times and rates.|
-|`feed_in_tariff`|-|Get the feed-in-tariff|
+| Method        | Params          | Description | Unit |
+|:-------------:|:-------------|:-------------|---------|
+| `battery_capacity`      | - | Get the capacity of the battery                | kWh |
+| `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_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| kWh
+|`latest_meter_data`|-|Get a list of the latest meter data. Goes back the last 24 hours.| kWh |
+|`feed_in_tariff`|-|Get the feed-in-tariff| Dollars ($) |
 
 ## Links
 

reposit/data/controller.py

@@ -80,7 +80,7 @@ def has_inverter(self):
         )
         return request.get()
 
-    def get_historical_generation(self, start, end):
+    def get_solar_generation_data(self, start, end):
         """
         Given a start and end timestamp return the generation
         data.
@@ -98,7 +98,7 @@ def get_historical_generation(self, start, end):
         return request.query(start, end)
 
     @property
-    def latest_historical_generation(self):
+    def latest_solar_generation_data(self):
         """
         Return a list of data points as lists. Time are in GMT
         :return:
@@ -112,7 +112,7 @@ def latest_historical_generation(self):
         )
         return request.get()
 
-    def get_historical_house(self, start, end):
+    def get_house_data(self, start, end):
         """
         Given a start and end timestamp return the house
         data.
@@ -130,7 +130,7 @@ def get_historical_house(self, start, end):
         return request.query(start, end)
 
     @property
-    def latest_historical_house(self):
+    def latest_house_data(self):
         """
         Return a list of data points as lists. Time are in GMT
         :return:
@@ -146,40 +146,7 @@ def latest_historical_house(self):
         )
         return request.get()
 
-    def get_historical_grid_credits(self, start, end):
-        """
-        Given a start and end timestamp return the gridcredits
-        data.
-        :param start: unix timestamp
-        :param end: unix timestamp
-        :return: list of lists of data
-        """
-        request = ApiRequest(
-            path='v2/deployments/{}/gridcredits/historical'.format(self.user_key),
-            controller=self,
-            schema={
-                'gridcredits': {}
-            }
-        )
-        return request.query(start, end)
-
-    @property
-    def latest_historical_grid_credits(self):
-        """
-        Return a list of data points as lists. Times are in GMT
-        :return:
-        """
-
-        request = ApiRequest(
-            path='v2/deployments/{}/gridcredits/historical'.format(self.user_key),
-            controller=self,
-            schema={
-                'gridcredits': {}
-            }
-        )
-        return request.get()
-
-    def get_historical_inverter(self, start, end):
+    def get_battery_data(self, start, end):
         """
         Given a start and end timestamp return the inverter
         data.
@@ -197,7 +164,7 @@ def get_historical_inverter(self, start, end):
         return request.query(start, end)
 
     @property
-    def latest_historical_inverter(self):
+    def latest_battery_data(self):
         """
         Return a list of data points as lists. Times are in GMT
         :return:
@@ -211,7 +178,7 @@ def latest_historical_inverter(self):
         )
         return request.get()
 
-    def get_historical_meter(self, start, end):
+    def get_meter_data(self, start, end):
         """
         Given a start and end timestamp return the meter
         data.
@@ -229,7 +196,7 @@ def get_historical_meter(self, start, end):
         return request.query(start, end)
 
     @property
-    def latest_historical_meter(self):
+    def latest_meter_data(self):
         """
         Return a list of data points as lists. Times are in GMT
         :return:
@@ -243,36 +210,6 @@ def latest_historical_meter(self):
         )
         return request.get()
 
-    @property
-    def weekday_tou_tariff(self):
-        """
-        Returns a list of dicts of weekday time of use tariff information
-        :return:
-        """
-        request = ApiRequest(
-            path='v2/deployments/{}/tariff/tou'.format(self.user_key),
-            controller=self,
-            schema={
-                'weekday': {}
-            }
-        )
-        return request.get()
-
-    @property
-    def weekend_tou_tariff(self):
-        """
-        Returns a list of dicts of weekend time of use tariff information
-        :return:
-        """
-        request = ApiRequest(
-            path='v2/deployments/{}/tariff/tou'.format(self.user_key),
-            controller=self,
-            schema={
-                'weekend': {}
-            }
-        )
-        return request.get()
-
     @property
     def feed_in_tariff(self):
         """

setup.py

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