A library to communicate with a Reposit Controller
Project description
reposit-python-client
Python client library to communicate with a Reposit Controller.
Compatibility
- Python 2.7
- Python 3+ preferred
Installation
pip install reposit
Quickstart
from reposit.auth import RPConnection
from reposit import Controller, Account
user = RPConnection('username', 'password')
account = Account(user)
user_keys = account.get_user_keys()
controller = Controller(user, user_key=user_keys[0])
print(controller.battery_capacity)
Data
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 |
|
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 |
|
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 |
|
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 |
get_remaining_charge |
|
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) Note: This can be used to calculate the state of charge with the formula: (remaining_charge / battery_capacity) * 100` |
kWh |
get_meter_data |
|
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
reposit-0.4.0.tar.gz
(7.4 kB
view details)
File details
Details for the file reposit-0.4.0.tar.gz
.
File metadata
- Download URL: reposit-0.4.0.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.13.0 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.29.1 CPython/2.7.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e690c40cea9d0113fdb5013de0bd5fc9197ddca325c34848a689fb48ce1f46e6 |
|
MD5 | ca170891d0cece31ba34cb96894819be |
|
BLAKE2b-256 | 337ade33ff97973d80cfdadcca8f34a83591faf41e206c7eb21f1aab5300ac3a |