├── documents ├── sera-animation.gif └── sunspec-implementation-technical-note.pdf ├── Dockerfile ├── requirements.txt ├── LICENSE ├── README.md ├── server.py └── .gitignore /documents/sera-animation.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/benzino77/solaredge-rest-api/HEAD/documents/sera-animation.gif -------------------------------------------------------------------------------- /documents/sunspec-implementation-technical-note.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/benzino77/solaredge-rest-api/HEAD/documents/sunspec-implementation-technical-note.pdf -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3-alpine 2 | 3 | WORKDIR /usr/src/app 4 | COPY requirements.txt ./ 5 | RUN pip install --no-cache-dir -r requirements.txt 6 | 7 | COPY . . 8 | 9 | CMD ["gunicorn", "--bind", ":8080", "--workers" ,"1", "--threads", "8", "--timeout", "0", "server:app" ] -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | autopep8==1.5.5 2 | click==7.1.2 3 | Flask==1.1.2 4 | gunicorn==20.0.4 5 | itsdangerous==1.1.0 6 | Jinja2==2.11.3 7 | MarkupSafe==1.1.1 8 | pycodestyle==2.7.0 9 | pymodbus==2.5.0 10 | pyserial==3.5 11 | six==1.15.0 12 | solaredge-modbus==0.7.0 13 | toml==0.10.2 14 | Werkzeug==1.0.1 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 benzino77 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## SolarEdge Inverter REST API 2 | 3 | Super simple REST api to Solaredge Inverter, based on [solaredge_modbus](https://github.com/nmakel/solaredge_modbus) project and Flask. It is using MODBUS over TCP. Information how to turn on MODBUS over TCP in your Inverter can be found on solaredge documentation page or in included [PDF](https://github.com/benzino77/solaredge-rest-api/blob/main/documents/sunspec-implementation-technical-note.pdf) 4 | 5 | ### Usage 6 | The api endpoint is `/api/v1/solaredge` and it is reachable by simple GET request: 7 | 8 | ![Animation](./documents/sera-animation.gif) 9 | 10 | 11 | ### Install 12 | 13 | ### Docker 14 | The simplest way to start it is by using docker: 15 | 16 | `docker run --rm -p 8080:8080 -e MODBUS_HOST= -e MODBUS_PORT= benzino77/solaredge-rest-api` 17 | 18 | for example: 19 | ```bash 20 | docker run --rm -p 8080:8080 -e MODBUS_HOST=192.168.10.5 -e MODBUS_PORT=1502 benzino77/solaredge-rest-api 21 | ``` 22 | 23 | The `1502` is a default port (I think). 24 | 25 | ### Run locally 26 | You can also run it locally (I do prefer to use python virtualenv for projects to keep my environment clean): 27 | 28 | 29 | ```bash 30 | git clone https://github.com/benzino77/solaredge-rest-api 31 | cd solaredge-rest-api 32 | python3 -m venv myvenv 33 | source myvenv/bin/activate 34 | pip install -r requirements.txt 35 | MODBUS_HOST=192.168.10.5 MODBUS_PORT=1502 gunicorn --bind :8080 --workers 1 --threads 8 --timeout 0 server:app 36 | ``` 37 | -------------------------------------------------------------------------------- /server.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from os import getenv 4 | import solaredge_modbus 5 | from flask import Flask, jsonify, request 6 | 7 | inverter = solaredge_modbus.Inverter( 8 | host=getenv('MODBUS_HOST'), 9 | port=getenv('MODBUS_PORT'), 10 | timeout=5, 11 | unit=1 12 | ) 13 | 14 | 15 | error_message = {'succes': False, 'data': {'error': 'Not allowed.'}} 16 | 17 | app = Flask(__name__) 18 | 19 | 20 | @app.route('/api/v1/solaredge', methods=['GET', 'POST', 'PUT', 'DELETE']) 21 | def metrics_api(): 22 | if request.method != 'GET': 23 | return jsonify(error_message), 405 24 | 25 | values = {} 26 | 27 | num_of_tries = 5 28 | while num_of_tries > 0: 29 | try: 30 | values = inverter.read_all() 31 | meters = inverter.meters() 32 | batteries = inverter.batteries() 33 | break 34 | except Exception as e: 35 | print('Something went wrong: {e}') 36 | 37 | values['meters'] = {} 38 | values['batteries'] = {} 39 | 40 | for meter, params in meters.items(): 41 | meter_values = params.read_all() 42 | values['meters'][meter] = meter_values 43 | 44 | for battery, params in batteries.items(): 45 | battery_values = params.read_all() 46 | values['batteries'][battery] = battery_values 47 | 48 | ret_val = {} 49 | ret_val['success'] = True 50 | ret_val['data'] = values 51 | return jsonify(ret_val) 52 | 53 | 54 | @app.route('/', defaults={'u_path': ''}) 55 | @app.route('/') 56 | def catch_all(u_path): 57 | return jsonify(error_message), 405 58 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | .vscode/ --------------------------------------------------------------------------------