Skip to content

Commit

Permalink
Merge pull request #3 from mdrocan/documentation_update
Browse files Browse the repository at this point in the history
minor changes
  • Loading branch information
mdrocan authored Sep 8, 2023
2 parents 31412cc + 24a2816 commit 920072e
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
# 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.
- 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
Install the required package with 'pip install -r requirements.txt'
Execute in the terminal with the following command: 'python3 fronius.py'
After script execution the data is fetched from the inverter and trimmed.

- Install the required package with 'pip install -r requirements.txt'
- Execute in the terminal with the following command: 'python 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.
By default the script uses the URL defined in a file called 'api.txt'.

There's also a possibility to use a example response message in a Docker environment:
- You must edit the Python source and comment/uncomment the necessary lines in the script.
- The Docker setup can be found from [here](web_server).
- Example message message [here](web_server/GetPowerFlowRealtimeData.fcgi).

## Next steps

Save data to a database.
Visualize the data.
- Save the data to a database.
- Visualize the data.

0 comments on commit 920072e

Please sign in to comment.