Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/philipptrenz/sunportal
A web-based visualisation tool for SMA(R) solar inverter data
https://github.com/philipptrenz/sunportal
logger raspberry-pi raspberry-pi-3 raspberrypi sbfspot sma sma-solar solar solar-logger solarpower sun visualisation visualization web
Last synced: 3 months ago
JSON representation
A web-based visualisation tool for SMA(R) solar inverter data
- Host: GitHub
- URL: https://github.com/philipptrenz/sunportal
- Owner: philipptrenz
- License: mit
- Created: 2018-09-02T13:39:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-12-31T15:05:09.000Z (about 3 years ago)
- Last Synced: 2023-03-10T19:59:13.672Z (almost 2 years ago)
- Topics: logger, raspberry-pi, raspberry-pi-3, raspberrypi, sbfspot, sma, sma-solar, solar, solar-logger, solarpower, sun, visualisation, visualization, web
- Language: JavaScript
- Homepage:
- Size: 7.16 MB
- Stars: 19
- Watchers: 7
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/philipptrenz/sunportal)
# sunportal
_sunportal_ is a web based visualisation tool to display data of SMA solar inverters. It is based on the database of [SBFspot](https://github.com/SBFspot/SBFspot) and shows charts daily and monthly power production. It runs on a Raspberry Pi and can handle multiple inverters in one Speedwire or Bluetooth(R) network.
Inverters that do not support Speedwire or Bluetooth or that are not from the manufacturer SMA can be integrated through [s0-bridge](https://github.com/philipptrenz/s0-bridge). _s0-bridge_ also enables power consumption to be recorded by using electric meters with S0 interface.
Current features:
* Web based visualization of daily and monthly power production
* Displaying multiple inverters
* Translations: English, German
* Mail notification service for inverter disorders and lack of production
Planned features:
* Visualization of yearly power production
* Visualization of power consumption
* Validation of `config.yml` with [JSON Schema](https://json-schema.org/)
* Configuration of _sunportal_ via web interface
* REST-API, i.e. to integrate solar power plants into home automation applications
If you like my project and want to keep me motivated:
## Installation on a Raspberry Pi
First install and configure SBFspot as described [here](https://github.com/SBFspot/SBFspot/wiki/Installation-Linux-SQLite#sbfspot-with-sqlite), the _SBFspotUploadDaemon_ is not required.
Also add a cronjob for SBFspot to run every 5 minutes. Execute `sudo crontab -e`, choose your preferred editor and add the following line:
```
*/5 * * * * /usr/local/bin/sbfspot.3/SBFspot -finq -nocsv > /dev/null
```
After that install _sunportal_:
```bash
# install needed dependencies
sudo apt-get install git python3 python3-pip
# clone this repo
git clone https://github.com/philipptrenz/sunportal
cd sunportal
#install _sunportal
sudo pip3 install -r requirements.txt
```
## Configure _sunportal_
All configuration parameters of _sunportal_ get stored inside the `config.yml` YAML file. To edit the preconfigured values copy the `config.default.yml` and edit the `config.yml`:
```bash
cp config.default.yml config.yml
nano config.yml
```
Under `mail` you can enable the integrated mail notification service by adding an SMTP server.
```yaml
---
database:
path: "/home/pi/smadata/SBFspot.db"
co2_avoidance_factor: 0.7
mail:
enabled: 'false'
check_interval: 300
sender: [email protected]
smtp_server:
url: smtp.example.com
port: 587
recipients:
- [email protected]
starttls:
enabled: 'false'
user: ''
password: ''
renaming:
'10000000001': My Inverter 1
```
## Start _sunportal_
```bash
sudo python3 sunportal.py
```
Open a browser and navigate to the IP address of the Raspberry Pi to see the website.
### Run _sunportal_ on boot
```bash
# add the bash script to the service folder
sudo cp scripts/sunportal.sh /etc/init.d/sunportal
sudo chmod 755 /etc/init.d/sunportal
sudo update-rc.d sunportal defaults
```
Now _sunportal_ can be controlled as a service (`sudo service sunportal status`) and it automatically starts on boot.
## Disclaimer
SMA, Speedwire are registered trademarks of SMA Solar Technology AG.