Metadata-Version: 2.1
Name: solaredge
Version: 0.0.4
Summary: A python API wrapper for Solaredge monitoring service
Home-page: https://github.com/bertouttier/solaredge
Author: Bert Outtier, EnergieID
Author-email: jan@energieid.be
License: MIT
Keywords: solaredge data monitoring api
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: pytz
Requires-Dist: python-dateutil

# Solaredge
Python Client for Solaredge monitoring service.

See https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf

## Create a new connection by supplying your Solaredge API key
```
s = solaredge.Solaredge("APIKEY")
```

## Raw API Requests
12 API requests are supported. The methods return the parsed JSON response as a dict.

```
def get_list(self, size=100, start_index=0, search_text="", sort_property="", sort_order='ASC', status='Active,Pending'):

def get_details(self, site_id):

def get_data_period(self, site_id):

def get_energy(self, site_id, start_date, end_date, time_unit='DAY'):

def get_time_frame_energy(self, site_id, start_date, end_date, time_unit='DAY'):

def get_power(self, site_id, start_time, end_time):

def get_overview(self, site_id):

def get_power_details(self, site_id, start_time, end_time, meters=None):

def get_energy_details(self, site_id, start_time, end_time, meters=None, time_unit="DAY"):

def get_current_power_flow(self, site_id):

def get_storage_data(self, site_id, start_time, end_time, serials=None):

def get_inventory(self, site_id):
```

## Parsed API Requests
- `get_data_period_parsed`: Get start and end dates as datetime objects
- `get_energy_details_dataframe`: Get energy details as a Pandas DataFrame.
    This method deals with the API usage restrictions, allowing you to do bulk requests.
- `get_timezone`: Get the IANA timezone of a site

## TODO
* Add API documentation for certain requests
* Add more DataFrame parsers for other calls


