Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added short readme doc #1

Merged
merged 2 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ jobs:
uses: oxsecurity/megalinter/flavors/python@beta
env:
VALIDATE_ALL_CODEBASE: true
DEFAULT_BRANCH: master
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Fronius-stats

Simple Python script that fetches data from a predefined Fronius inverter.
Displays: timestamp, current production and how much has been produced during the (day, year) so far.

## Script execution
Execute in the terminal with the following command: 'python3 fronius.py'
After script execution the data is fetched from the inverter and trimmed.

## Architecture
By default it fetches the URL being used froma file called 'api.txt'.

There's also a possibility to use a example response message in a Docker environment.
In order to use the Docker web service you must edit the python source and comment/uncomment the necessary lines.
The Docker setup can be found from web_server-directory.


## Next steps

Save data to a database.
Visualize the data.