Skip to content

Commit

Permalink
Add License and Readme and change schedule time for aggregation back …
Browse files Browse the repository at this point in the history
…to 5 minutes
  • Loading branch information
nikilase committed Jan 13, 2024
1 parent fe13c0f commit 19a9d5d
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 1 deletion.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright © 2024 Niklas Eichenberg

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Kostal API Requester App
Little app to get current power data from kostal solar inverter and send it to an influxdb v1 time series database.

Also has the feature of calculating the daily amount of electricity sold to the grid or bought from the grid,
with the option to set how much money one kWh costs to buy or sell.

## Installation
Make sure you have an influxdb (version 1) installed and configured your config/config_template.py saving the modified
template as config/config.py

## Usage
By default, this app runs the data requester every 10 seconds and the aggregation every 5 minutes.
You can change this in the main.py file with the schedule.every() functions

App was tested on Python 3.11
2 changes: 1 addition & 1 deletion main.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

def main():
schedule.every(10).seconds.do(k_m)
schedule.every(30).seconds.do(a_m)
schedule.every(5).minutes.do(a_m)

try:
while True:
Expand Down

0 comments on commit 19a9d5d

Please sign in to comment.