A python API wrapper for Solaredge monitoring service
Project description
# Solaredge
API wrapper 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
API wrapper 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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
solaredge-0.0.2.tar.gz
(6.7 kB
view details)
Built Distribution
File details
Details for the file solaredge-0.0.2.tar.gz
.
File metadata
- Download URL: solaredge-0.0.2.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc28709023131993de4f26a74e563b0199b8bdc0987fb365be61052bd94e4d91 |
|
MD5 | 1d552aad41ddc74960e3288a50f6ae7a |
|
BLAKE2b-256 | cd4f6682c03070240e5c6f3166aad4e9de50145fbc8ac54528de2378a9096b20 |
Provenance
File details
Details for the file solaredge-0.0.2-py3-none-any.whl
.
File metadata
- Download URL: solaredge-0.0.2-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca6155edc12b1ed46f818f9e3cfa00ce7a9d1d11094aa7f9318d2965a5246577 |
|
MD5 | 52799bad8e012b06281fdfceaa5beaa4 |
|
BLAKE2b-256 | b91bf42623c55fb3f4d1294793e03204daf87dcae1353f023ae59b4a78080517 |