solar_edge/README.md

60 lines
1.6 KiB
Markdown
Raw Normal View History

2019-04-15 16:15:57 -06:00
# Solar Edge Status Updater
When placed in a cron job this uppdater will make an https call to a json api to retrieve the co2 savings and equivenant trees planted and overlay those numbers on a graphic and upload them to the website.
# Dependancies
2019-04-15 17:15:35 -06:00
Python 3 and contents of `requirements.txt`.
2019-04-15 16:15:57 -06:00
2019-04-15 17:15:35 -06:00
The font `Biko_Regular.otf`.
A `.png` graphic to write text on.
The package direnv and the follwing changes to the user account:
* bash.rc (https://github.com/direnv/direnv/wiki/Python#bash)
* venv (https://github.com/direnv/direnv/wiki/Python#venv-stdlib-module)
2019-04-15 17:26:14 -06:00
If `ssh_host` is blank will copy file locally instead of scping file to sever. To scp valid sshkeys are required.
2019-04-15 16:15:57 -06:00
# Bulid Instructions
2019-04-15 17:15:35 -06:00
assumes installed to `~/python/solar_edge`
2019-04-15 17:17:27 -06:00
```
2019-04-15 17:15:35 -06:00
cd ~/python
git clone http://git.elder-geek.net/fredw/solar_edge.git
cd solar_edge
cp env.sample .env
direnv allow
pip install -r requirements.txt
2019-04-15 17:17:27 -06:00
```
2019-04-15 17:15:35 -06:00
edit `.env` and update accordingly
2019-04-15 17:02:41 -06:00
2019-04-15 16:15:57 -06:00
2019-04-15 17:15:35 -06:00
add to user crontab to update site every 5 minutes
2019-04-15 17:17:27 -06:00
```
2019-04-15 17:15:35 -06:00
05 * * * * cd ~/python/solar_edge && direnv exec . python solar_edge.py > /dev/null 2>&1
2019-04-15 17:17:27 -06:00
```
2019-04-15 17:26:14 -06:00
# Sample .env if installed on the server
```
SSH_HOST=
SSH_USER=
SSH_FOLDER=/var/www/wordpress
URL=https://monitoringapi.solaredge.com/site/55555/envBenefits?systemUnits=Imperial&api_key=
INFILE=environmental_benefits_blank.png
OUTFILE=solar.png
FONT_FACE=Biko_Regular.otf
```
# Sample .env file for scp
```
SSH_HOST=myserver.com
SSH_USER=www-data
SSH_FOLDER=/var/www/wordpress
URL=https://monitoringapi.solaredge.com/site/55555/envBenefits?systemUnits=Imperial&api_key=
INFILE=environmental_benefits_blank.png
OUTFILE=solar.png
FONT_FACE=Biko_Regular.otf
```