diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..db24c25 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,98 @@ +{ + "_comment": "This JSON file controls the behaviour of the all contributors bot. A description of the keys can be found here: https://allcontributors.org/docs/en/bot/configuration", + "projectName": "ginlong_solis_api_connector", + "projectOwner": "Gentleman1983", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": false, + "contributorsPerLine": 7, + "contributorsSortAlphabetically": false, + "linkToUsage": true, + "skipCi": true, + "contributors": [ + { + "login": "TobiO79", + "name": "Tobias Otto", + "avatar_url": "https://avatars.githubusercontent.com/u/30373938?v=4", + "profile": "https://github.com/TobiO79", + "contributions": [ + "test", + "code", + "maintenance", + "review" + ] + }, + { + "login": "Gentleman1983", + "name": "Christian Otto", + "avatar_url": "https://avatars.githubusercontent.com/u/1020222?v=4", + "profile": "https://github.com/Gentleman1983", + "contributions": [ + "test", + "code", + "maintenance", + "review" + ] + }, + { + "login": "petermdevries", + "name": "Peter de Vries", + "avatar_url": "https://avatars.githubusercontent.com/u/15040708?v=4", + "profile": "https://github.com/petermdevries", + "contributions": [ + "bug" + ] + }, + { + "login": "Flecky13", + "name": "Pedro", + "avatar_url": "https://avatars.githubusercontent.com/u/57505680?v=4", + "profile": "https://github.com/Flecky13", + "contributions": [ + "bug" + ] + }, + { + "login": "philicibine", + "name": "philicibine", + "avatar_url": "https://avatars.githubusercontent.com/u/16887758?v=4", + "profile": "https://github.com/philicibine", + "contributions": [ + "bug" + ] + }, + { + "login": "MetPhoto", + "name": "Mark", + "avatar_url": "https://avatars.githubusercontent.com/u/2766363?v=4", + "profile": "https://github.com/MetPhoto", + "contributions": [ + "bug" + ] + }, + { + "login": "Stephen2615", + "name": "Stephen2615", + "avatar_url": "https://avatars.githubusercontent.com/u/43490186?v=4", + "profile": "https://github.com/Stephen2615", + "contributions": [ + "bug" + ] + }, + { + "login": "izakhearn", + "name": "Izak Hearn", + "avatar_url": "https://avatars.githubusercontent.com/u/25284121?v=4", + "profile": "https://izakwebdesigns.co.za", + "contributions": [ + "bug" + ] + } + ], + "commitType": "docs", + "commitConvention": "angular" +} diff --git a/.github/workflows/buildDockerImage.yml b/.github/workflows/buildDockerImage.yml new file mode 100644 index 0000000..3f9059c --- /dev/null +++ b/.github/workflows/buildDockerImage.yml @@ -0,0 +1,11 @@ +name: Build Docker Container Image + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Build the Docker image + run: docker build . --file Dockerfile --tag ginlong-solis-api-connector:$(date +%s) diff --git a/.github/workflows/publishToDockerhub.yml b/.github/workflows/publishToDockerhub.yml new file mode 100644 index 0000000..cce4e47 --- /dev/null +++ b/.github/workflows/publishToDockerhub.yml @@ -0,0 +1,41 @@ +name: Build and publish a Docker image + +on: [ release ] + +env: + IMAGE_NAME: gentleman1983/ginlong-solis-api-connector + +jobs: + docker: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Login to Docker Hub + uses: docker/login-action@v3 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN }} + + - name: Extract metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.IMAGE_NAME }} + + - name: Build and push + uses: docker/build-push-action@v6 + with: + sbom: true + push: true + provenance: mode=max + tags: | + gentleman1983/ginlong-solis-api-connector:${{ github.event.release.name }} + gentleman1983/ginlong-solis-api-connector:latest diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml new file mode 100644 index 0000000..dd0f06e --- /dev/null +++ b/.github/workflows/pylint.yml @@ -0,0 +1,24 @@ +name: Pylint + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ["3.12"] + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pylint + pip install -r requirements.txt + - name: Analysing the code with pylint + run: | + pylint $(git ls-files '*.py') diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2d0653a --- /dev/null +++ b/.gitignore @@ -0,0 +1,162 @@ +### Python template +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +.idea/ + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f5b1cfb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,46 @@ +# Version change log +This document provides an overview to the changes on the different releases... + +## NEXT +* t.b.d. + +## 3.0.0 +> [!WARNING] +> In this update we refactored all actual and upcoming number fields to provide data in float values. There may be the +> need to update your existing InfluxDB instance to handle the new data types. +* Updated the Dockerhub repository on `README.md`, to not point to the [old dkruyt API scraper images](https://hub.docker.com/repository/docker/dkruyt/ginlong-scraper) ([#51](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/51)) +* Added publishing to Dockerhub repository [gentleman1983/ginlong-solis-api-connector](https://hub.docker.com/repository/docker/gentleman1983/ginlong-solis-api-connector) on release ([#55](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/55)) +* Publishing task to Dockerhub should publish [SBOM](https://www.cisa.gov/sbom), too ([#57](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/57)) +* Add Mend renovate bot to repository ([#56](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/56)) +* Fixed parsing issues regarding api update from March 4th, 2024. ([#68](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/68)) +* Pinned the data units regarding the dynamic units on Ginlong API. ([#13](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/13)) + +## 2.4.0 +* Added `CHANGELOG.md` document to have central document for changes. ([#38](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/38)) +* Fixed issue regarding bad gateways. ([#46](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/46)) + * Added option to configure number and timeout between retries. +* Added the fields `pA`, `pB` and `PC` to change list to update according to API changes on end of November 2023. + +## 2.3.1 +* Fixed issue on error handling on the `SOLIS_CLOUD_API_INVERTER_ID` parameter. ([#24](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/24)) +* Fixed possible index out of bounds exception. ([#24](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/24)) +* Added support for all contributors bot. ([#2](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/2), [#26](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/26), [#31](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/31)) + +## 2.3.0 +* Added option to override detection for single phase inverters. ([#14](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/14)) +* Fixed calculation on some data fields to fix issues on monitoring. ([#16](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/16), [#22](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/22)) +* Fixed mixing up of some PVoutput values (`v3` & `v4`). ([#17](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/17)) +* Fixed issue on influx db where some values where interpreted as integers instead of floats when value is `0`. This lead to problems in data import, e.g. during the nighttime. ([#18](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/18)) + +## 2.2.0 +* Added configurability for optional PVoutput fields `pv7` to `pv12` for subscribers of PVoutput. ([#4](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/4)) +* Fixed missing usage of inverter ID ENV value. ([#8](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/8)) +* Fixed some conversion issues on integer ENV values like inverter ID, ports, etc. ([#6](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/6)) +* Fixed some PyLint issues or marked them as false positives or as better readable containing them on source code. + +## 2.1.0 +* Added functionality to handle single phase inverters ([#3](https://github.com/Gentleman1983/ginlong_solis_api_connector/issues/3)) +* Added option to support multiple inverters + +## 2.0.0 +* Added functionality to connect to Solis Cloud API. diff --git a/Dockerfile b/Dockerfile index 0c34f42..461193b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,24 +4,27 @@ ARG VERSION ARG BUILD_DATE ARG VCS_REF -LABEL maintainer="dkruyt" \ +LABEL maintainer="Gentleman1983, TobiO79" \ org.opencontainers.image.created=$BUILD_DATE \ - org.opencontainers.image.url="https://github.com/dkruyt/ginlong-solis-scraper" \ - org.opencontainers.image.source="https://github.com/dkruyt/ginlong-solis-scraper" \ + org.opencontainers.image.url="https://hub.docker.com/repository/docker/gentleman1983/ginlong-solis-api-connector" \ + org.opencontainers.image.source="https://github.com/Gentleman1983/ginlong_solis_api_connector" \ org.opencontainers.image.version=$VERSION \ org.opencontainers.image.revision=$VCS_REF \ - org.opencontainers.image.vendor="dkruyt" \ - org.opencontainers.image.title="ginlong-solis-scraper" \ - org.opencontainers.image.description="Scrapes PV statistics from the Ginlong monitor pages and outputs it to influxdb, pvoutput or mqtt" \ + org.opencontainers.image.vendor="Gentleman1983" \ + org.opencontainers.image.title="ginlong-solis-api-connector" \ + org.opencontainers.image.description="Fetches API data from Solis Cloud API and outputs it to influxdb, pvoutput or mqtt." \ org.opencontainers.image.licenses="GPL-3.0" ENV LOG_LEVEL="INFO" -ENV GINLONG_USERNAME="" -ENV GINLONG_PASSWORD="" -ENV GINLONG_DOMAIN="m.ginlong.com" -ENV GINLONG_LANG="2" -ENV GINLONG_DEVICE_ID="" +ENV SOLIS_CLOUD_API_KEY_ID="" +ENV SOLIS_CLOUD_API_KEY_SECRET="" +ENV SOLIS_CLOUD_API_URL="https://www.soliscloud.com" +ENV SOLIS_CLOUD_API_PORT="13333" +ENV SOLIS_CLOUD_API_INVERTER_ID="0" +ENV SOLIS_CLOUD_API_OVERRIDE_SINGLE_PHASE_INVERTER="" +ENV SOLIS_CLOUD_API_NUMBER_RETRIES="3" +ENV SOLIS_CLOUD_API_RETRIES_WAIT_S="1" ENV USE_INFLUX="false" ENV INFLUX_DATABASE="influxdb" @@ -34,12 +37,20 @@ ENV INFLUX_MEASUREMENT="PV" ENV USE_PVOUTPUT="false" ENV PVOUTPUT_API_KEY="" ENV PVOUTPUT_SYSTEM_ID="" +ENV PVOUTPUT_EXTENDED_V7="" +ENV PVOUTPUT_EXTENDED_V8="" +ENV PVOUTPUT_EXTENDED_V9="" +ENV PVOUTPUT_EXTENDED_V10="" +ENV PVOUTPUT_EXTENDED_V11="" +ENV PVOUTPUT_EXTENDED_V12="" ENV USE_MQTT="false" ENV MQTT_CLIENT_ID="pv" ENV MQTT_SERVER="localhost" ENV MQTT_USERNAME="" ENV MQTT_PASSWORD="" +ENV MQTT_TOPIC="topic" +ENV MQTT_PORT="1883" ENV TZ="" @@ -50,6 +61,6 @@ WORKDIR /usr/src/app COPY requirements.txt ./ RUN pip install --no-cache-dir -r requirements.txt -COPY ginlong-scraper.py ./ +COPY ginlong_solis_api_connector.py ./ -CMD [ "python", "./ginlong-scraper.py" ] +CMD [ "python", "./ginlong_solis_api_connector.py" ] diff --git a/Mapping.md b/Mapping.md new file mode 100644 index 0000000..1d157a0 --- /dev/null +++ b/Mapping.md @@ -0,0 +1,37 @@ +# Mapping internal data / REST endpoints +This table helps to define which Solis REST API endpoints provide which information used for monitoring. + +| fieldKey | fieldType | Unit | REST endpoint | API | +|--------------------------|-----------|------|------------------|------------------------------| +| AC_Current | float | A | inverterDetail | (iAc1+iAc2+iAc3)/3 | +| AC_Frequency | float | Hz | inverterDetail | fac | +| AC_Power | float | W | inverterDetail | pac | +| AC_Voltage | float | V | inverterDetail | (uAc1+uAc2+uAc3)/3 | +| Annual_Energy_Used | float | kWh | inverterDetail | eYear - gridSellYearEnergy | +| Annual_Generation | float | kWh | inverterDetail | eYear | +| Battery_Charge_Percent | float | | | | +| Consumption_Energy | float | kWh | inverterDetail | homeLoadTotalEnergy | +| Consumption_Power | float | W | inverterDetail | familyLoadPower | +| DC_Current1 | float | A | inverterDetail | iPv1 | +| DC_Current2 | float | A | inverterDetail | iPv2 | +| DC_Current3 | float | A | inverterDetail | iPv3 | +| DC_Current4 | float | A | inverterDetail | iPv4 | +| DC_Power_PV1 | float | W | inverterDetail | pow1 | +| DC_Power_PV2 | float | W | inverterDetail | pow2 | +| DC_Power_PV3 | float | W | inverterDetail | pow3 | +| DC_Power_PV4 | float | W | inverterDetail | pow4 | +| DC_Voltage_PV1 | float | V | inverterDetail | uPv1 | +| DC_Voltage_PV2 | float | V | inverterDetail | uPv2 | +| DC_Voltage_PV3 | float | V | inverterDetail | uPv3 | +| DC_Voltage_PV4 | float | V | inverterDetail | uPv4 | +| Daily_Energy_Used | float | kWh | inverterDetail | eToday - gridSellTodayEnergy | +| Daily_Generation | float | kWh | inverterDetail | eToday | +| Generation_Last_Month | float | kWh | inverterYear[-2] | energy | +| Inverter_Temperature | float | °C | inverterDetail | inverterTemperature | +| Monthly_Energy_Used | float | kWh | inverterDetail | eMonth - gridSellMonthEnergy | +| Monthly_Generation | float | kWh | inverterDetail | eMonth | +| Power_Grid_Total_Power | float | W | inverterDetail | pSum | +| Total_Energy_Purchased | float | kWh | inverterDetail | gridPurchasedTotalEnergy | +| Total_Generation | float | kWh | inverterDetail | eTotal | +| Total_On_grid_Generation | float | kWh | inverterDetail | gridSellTotalEnergy | +| updateDate | integer | | inverterDetail | dataTimestamp | diff --git a/README.md b/README.md index 7bc6668..c636ef1 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,14 @@ -# ginlong-scraper +![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Gentleman1983/ginlong_solis_api_connector?sort=semver&style=plastic) +![GitHub workflow (pylint)](https://img.shields.io/github/actions/workflow/status/Gentleman1983/ginlong_solis_api_connector/pylint.yml?label=pylint&style=plastic) +![GitHub license](https://img.shields.io/github/license/Gentleman1983/ginlong_solis_api_connector?style=plastic) +![All Contributors](https://img.shields.io/github/all-contributors/Gentleman1983/ginlong_solis_api_connector?style=plastic) +![GitHub stars](https://img.shields.io/github/stars/Gentleman1983/ginlong_solis_api_connector?style=plastic) -Scrapes PV statistics from the Ginlong monitor pages and outputs it to influxdb, pvoutput or mqtt. +# ginlong-solis-api-connector -https://hub.docker.com/repository/docker/dkruyt/ginlong-scraper +Fetches API data from Solis Cloud API and outputs it to influxdb, pvoutput or mqtt. Based on [ginlong-scraper by dkruyt](https://github.com/dkruyt/ginlong-scraper). + +https://hub.docker.com/repository/docker/gentleman1983/ginlong-solis-api-connector There is a possibility it also works with the following inverters: Omnik Solar, Solarman and Trannergy Inverters @@ -12,37 +18,52 @@ invoking the docker image. In the case of two inverters (see note below) once you have the deviceid you can set up two seperate docker containers and just vary the deviceId in the environment variables. +## Requirements +* You have to order the Solis Cloud API access like described [here](https://solis-service.solisinverters.com/support/solutions/articles/44002212561-api-access-soliscloud). +* You have to know the Solis Cloud API `KeyID` and `KeySecret`. + ## Configuration ### Environment variables -| Environment variable | Required | Description | Default value | -|---------------------------|----------|------------------------------------------------------------------------------------------------------|-----------------| -| LOG_LEVEL | No | Logging level (ERROR, INFO, DEBUG) | `INFO` | -| GINLONG_USERNAME | Yes | Ginlong Solis username | *empty* | -| GINLONG_PASSWORD | Yes | Ginlong Solis password | *empty* | -| GINLONG_DOMAIN | No | Ginlong Solis domain | `m.ginlong.com` | -| GINLONG_LANG | No | Ginlong Solis language | `2` *(English)* | -| GINLONG_DEVICE_ID | No | Ginlong Solis device ID
(only required if auto-detect fails or if you have more than one device) | *empty* | -| USE_INFLUX | No | Set to true if you want to use InfluxDB as output | `false` | -| INFLUX_DATABASE | No | InfluxDB DB name | `influxdb` | -| INFLUX_SERVER | No | InfluxDB server | `localhost` | -| INFLUX_PORT | No | InfluxDB server port | `8086` | -| INFLUX_USER | No | InfluxDB User | *empty* | -| INFLUX_PASSWORD | No | InfluxDB Password | *empty* | -| INFLUX_MEASUREMENT | No | InfluxDB measurement type | `PV` | -| USE_PVOUTPUT | No | Set to true if you want to use PvOutput as output | `false` | -| PVOUTPUT_API_KEY | No | PvOutput API key | *empty* | -| PVOUTPUT_SYSTEM_ID | No | PvOutput system ID | *empty* | -| USE_MQTT | No | Set to true if you want to use MQTT as output | `false` | -| MQTT_CLIENT_ID | No | MQTT client ID | `pv` | -| MQTT_SERVER | No | MQTT server | `localhost` | -| MQTT_USERNAME | No | MQTT username | *empty* | -| MQTT_PASSWORD | No | MQTT password | *empty* | -| TZ | No | TimeZone e.g Australia/Sydney | *empty* | +| Environment variable | Required | Description | Default value | +|-------------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| LOG_LEVEL | No | Logging level (ERROR, INFO, DEBUG) | `INFO` | +| SOLIS_CLOUD_API_KEY_ID | Yes | API Key ID | *empty* | +| SOLIS_CLOUD_API_KEY_SECRET | Yes | API Key Secret | *empty* | +| SOLIS_CLOUD_API_URL | No | API URL | `https://www.soliscloud.com` | +| SOLIS_CLOUD_API_PORT | No | API Port | `13333` | +| SOLIS_CLOUD_API_INVERTER_ID | No | Ginlong Solis device ID
(only required if auto-detect fails or if you have more than one device) | `0` or *empty* | +| SOLIS_CLOUD_API_OVERRIDE_SINGLE_PHASE_INVERTER | No | Override to provide correct calculations for single phase inverters if Solis Cloud API provides wrong data. Simply switch to `true` | *empty* | +| SOLIS_CLOUD_API_NUMBER_RETRIES | No | Number of retries to fetch an API endpoint | `3` | +| SOLIS_CLOUD_API_RETRIES_WAIT_S | No | Timeout between retries | `1` | +| USE_INFLUX | No | Set to true if you want to use InfluxDB as output | `false` | +| INFLUX_DATABASE | No | InfluxDB DB name | `influxdb` | +| INFLUX_SERVER | No | InfluxDB server | `localhost` | +| INFLUX_PORT | No | InfluxDB server port | `8086` | +| INFLUX_USER | No | InfluxDB User | *empty* | +| INFLUX_PASSWORD | No | InfluxDB Password | *empty* | +| INFLUX_MEASUREMENT | No | InfluxDB measurement type | `PV` | +| USE_PVOUTPUT | No | Set to true if you want to use PvOutput as output | `false` | +| PVOUTPUT_API_KEY | No | PvOutput API key | *empty* | +| PVOUTPUT_SYSTEM_ID | No | PvOutput system ID | *empty* | +| PVOUTPUT_EXTENDED_V7 | No | Set Extendet Output v7 to this API Key from inverterDetail (leave blank if not donated) | *empty* | +| PVOUTPUT_EXTENDED_V8 | No | Set Extendet Output v8 to this API Key from inverterDetail (leave blank if not donated) | *empty* | +| PVOUTPUT_EXTENDED_V9 | No | Set Extendet Output v9 to this API Key from inverterDetail (leave blank if not donated) | *empty* | +| PVOUTPUT_EXTENDED_V10 | No | Set Extendet Output v10 to this API Key from inverterDetail (leave blank if not donated) | *empty* | +| PVOUTPUT_EXTENDED_V11 | No | Set Extendet Output v11 to this API Key from inverterDetail (leave blank if not donated) | *empty* | +| PVOUTPUT_EXTENDED_V12 | No | Set Extendet Output v12 to this API Key from inverterDetail (leave blank if not donated) | *empty* | +| USE_MQTT | No | Set to true if you want to use MQTT as output | `false` | +| MQTT_CLIENT_ID | No | MQTT client ID | `pv` | +| MQTT_SERVER | No | MQTT server | `localhost` | +| MQTT_USERNAME | No | MQTT username | *empty* | +| MQTT_PASSWORD | No | MQTT password | *empty* | +| MQTT_PORT | No | MQTT port default 1883 | `1883` | +| MQTT_TOPIC | No | MQTT topic root, fulltopic will by MQTT_Topic / MQTT_Client_ID | `topic` | +| TZ | No | TimeZone e.g Australia/Sydney | *empty* | Note that if you have more than 1 device - then it is not readily apparent where to get the Device ID -In that case - setup the script, and set LOG_LEVEL to DEBUG, then view the logs and search for deviceId - +In that case - setup the script, and set `LOG_LEVEL` to `DEBUG`, then view the logs and search for deviceId - this will list the IDs of each inverter. ## Bonus @@ -50,3 +71,39 @@ this will list the IDs of each inverter. The grafana-dashboard-example.json file you could import in to Grafana if you use the influx database. Then you can make a dashboard similar to this. ![grafana](https://github.com/dkruyt/resources/raw/master/grafana-dashboard-ginlong-small.png) + +# Contributors + + + + + + + + + + + + + + + + + + + + + + + + +
Tobias Otto
Tobias Otto
⚠️ 💻 🚧 👀		Christian Otto
Christian Otto
⚠️ 💻 🚧 👀		Peter de Vries
Peter de Vries
🐛		Pedro
Pedro
🐛		philicibine
philicibine
🐛		Mark
Mark
🐛		Stephen2615
Stephen2615
🐛
Izak Hearn
Izak Hearn
🐛
+ + Add your contributions + +
+ + + + + diff --git a/ginlong-scraper.py b/ginlong-scraper.py deleted file mode 100755 index 5c82ff6..0000000 --- a/ginlong-scraper.py +++ /dev/null @@ -1,268 +0,0 @@ -#!/usr/bin/python -import requests -import urllib -import json -import datetime -import time -import os -import logging -import schedule - -# Not all keys are avilable depending on your setup -COLLECTED_DATA = { - 'DC_Voltage_PV1': '1a', - 'DC_Voltage_PV2': '1b', - 'DC_Current1': '1j', - 'DC_Current2': '1k', - 'AC_Voltage': '1ah', - 'AC_Current': '1ak', - 'AC_Power': '1ao', - 'AC_Frequency': '1ar', - 'DC_Power_PV1': '1s', - 'DC_Power_PV2': '1t', - 'Inverter_Temperature': '1df', - 'Daily_Generation': '1bd', - 'Monthly_Generation': '1be', - 'Annual_Generation': '1bf', - 'Total_Generation': '1bc', - 'Generation_Last_Month': '1ru', - 'Power_Grid_Total_Power': '1bq', - 'Total_On_grid_Generation': '1bu', - 'Total_Energy_Purchased': '1bv', - 'Consumption_Power': '1cj', - 'Consumption_Energy': '1cn', - 'Daily_Energy_Used': '1co', - 'Monthly_Energy_Used': '1cp', - 'Annual_Energy_Used': '1cq', - 'Battery_Charge_Percent': '1cv' -} - -def do_work(): - # solis/ginlong portal config - username = os.environ['GINLONG_USERNAME'] - password = os.environ['GINLONG_PASSWORD'] - domain = os.environ['GINLONG_DOMAIN'] - lan = os.environ['GINLONG_LANG'] - deviceId = os.environ['GINLONG_DEVICE_ID'] - - ### Output ### - - # Influx settings - influx = os.environ['USE_INFLUX'] - influx_database = os.environ['INFLUX_DATABASE'] - influx_server = os.environ['INFLUX_SERVER'] - influx_port = os.environ['INFLUX_PORT'] - influx_user = os.environ['INFLUX_USER'] - influx_password = os.environ['INFLUX_PASSWORD'] - influx_measurement = os.environ['INFLUX_MEASUREMENT'] - - # pvoutput - pvoutput = os.environ['USE_PVOUTPUT'] - pvoutput_api = os.environ['PVOUTPUT_API_KEY'] - pvoutput_system = os.environ['PVOUTPUT_SYSTEM_ID'] - - # MQTT - mqtt = os.environ['USE_MQTT'] - mqtt_client = os.environ['MQTT_CLIENT_ID'] - mqtt_server = os.environ['MQTT_SERVER'] - mqtt_username = os.environ['MQTT_USERNAME'] - mqtt_password = os.environ['MQTT_PASSWORD'] - - ### - - if username == "" or password == "": - logging.error('Username and password are mandatory for Ginlong Solis') - return - - # Create session for requests - session = requests.session() - - # building url - url = 'https://'+domain+'/cpro/login/validateLogin.json' - params = { - "userName": username, - "password": password, - "lan": lan, - "domain": domain, - "userType": "C" - } - - # default heaeders gives a 403, seems releted to the request user agent, so we put curl here - headers = {'User-Agent': 'curl/7.58.0'} - - # login call - loginSuccess = False - try: - resultData = session.post(url, data=params, headers=headers) - resultJson = resultData.json() - if resultJson.get('result') and resultJson.get('result').get('isAccept', 0) == 1: - loginSuccess = True - logging.info('Login successful for %s' % domain) - else: - raise Exception(json.dumps(resultJson)) - except Exception as e: - logging.debug(e) - logging.error('Login failed for %s' % domain) - - if loginSuccess: - if deviceId == "": - logging.info('Your deviceId is not set, auto detecting') - url = 'http://'+domain+'/cpro/epc/plantview/view/doPlantList.json' - - cookies = {'language': lan} - resultData = session.get(url, cookies=cookies, headers=headers) - resultJson = resultData.json() - - plantId = resultJson['result']['pagination']['data'][0]['plantId'] - - url = 'http://'+domain+'/cpro/epc/plantDevice/inverterListAjax.json?' - params = { - 'plantId': int(plantId) - } - - cookies = {'language': lan} - resultData = session.get(url, params=params, cookies=cookies, headers=headers) - resultJson = resultData.json() - logging.debug('Ginlong inverter list: %s' % json.dumps(resultJson)) - - # .result.paginationAjax.data - deviceId = resultJson['result']['paginationAjax']['data'][0]['deviceId'] - - logging.info('Your deviceId is %s' % deviceId) - - # get device details - url = 'http://'+domain+'/cpro/device/inverter/goDetailAjax.json' - params = { - 'deviceId': int(deviceId) - } - - cookies = {'language': lan} - resultData = session.get(url, params=params, cookies=cookies, headers=headers) - resultJson = resultData.json() - logging.debug('Ginlong device details: %s' % json.dumps(resultJson)) - - # Get values from json - updateDate = resultJson['result']['deviceWapper'].get('updateDate') - inverterData = {'updateDate': updateDate} - for name,code in COLLECTED_DATA.items(): - inverterData[name] = float(0) - value = resultJson['result']['deviceWapper']['dataJSON'].get(code) - if value is not None: - inverterData[name] = float(value) - - # Print collected values - logging.debug('Results from %s:' % deviceId) - logging.debug('%s' % time.ctime((updateDate) / 1000)) - for key,value in inverterData.items(): - logging.debug('%s: %s' % (key,value)) - - # Write to Influxdb - if influx.lower() == "true": - logging.info('InfluxDB output is enabled, posting outputs now...') - from influxdb import InfluxDBClient - json_body = [ - { - "measurement": influx_measurement, - "tags": { - "deviceId": deviceId - }, - "time": int(updateDate), - "fields": inverterData - } - ] - if influx_user != "" and influx_password != "": - client = InfluxDBClient(host=influx_server, port=influx_port, username=influx_user, password=influx_password ) - else: - client = InfluxDBClient(host=influx_server, port=influx_port) - - client.switch_database(influx_database) - success = client.write_points(json_body, time_precision='ms') - if not success: - logging.error('Error writing to influx database') - - # Write to PVOutput - if pvoutput.lower() == "true": - logging.info('PvOutput output is enabled, posting results now...') - - headers = { - "X-Pvoutput-Apikey": pvoutput_api, - "X-Pvoutput-SystemId": pvoutput_system, - "Content-type": "application/x-www-form-urlencoded", - "Accept": "text/plain" - } - - # make seconds - tuple_time = time.localtime(updateDate / 1000) - # Get hour and date - date = time.strftime("%Y%m%d", tuple_time) - hour = time.strftime("%H:%M", tuple_time) - - pvoutputdata = { - "d": date, - "t": hour, - "v1": inverterData['Daily_Generation'] * 1000, - "v2": inverterData['AC_Power'], - "v3": inverterData['Daily_Energy_Used'] * 1000, - "v4": inverterData['Consumption_Power'], - "v6": inverterData['AC_Voltage'] - } -#Python3 change - encoded = urllib.parse.urlencode(pvoutputdata) - - pvoutput_result = requests.post("http://pvoutput.org/service/r2/addstatus.jsp", data=encoded, headers=headers) - logging.debug('PvOutput response: %s' % pvoutput_result.content) - if pvoutput_result.status_code != 200: - logging.error('Error posting to PvOutput') - - # Push to MQTT - if mqtt.lower() == "true": - logging.info('MQTT output is enabled, posting results now...') - - import paho.mqtt.publish as publish - msgs = [] - - mqtt_topic = ''.join([mqtt_client, "/" ]) # Create the topic base using the client_id and serial number - - if (mqtt_username != "" and mqtt_password != ""): - auth_settings = {'username':mqtt_username, 'password':mqtt_password} - else: - auth_settings = None - - msgs.append((mqtt_topic + "updateDate", int(updateDate), 0, False)) - for key,value in inverterData.items(): - msgs.append((mqtt_topic + key, value, 0, False)) - - publish.multiple(msgs, hostname=mqtt_server, auth=auth_settings) - - -def main(): - global next_run_yes - try: - do_work() - except Exception as e: - logging.error('%s : %s' % (type(e).__name__, str(e))) - next_run_yes = 1 - - -global next_run_yes - -get_loglevel = os.environ['LOG_LEVEL'] -loglevel = logging.INFO -if get_loglevel.lower() == "info": - loglevel = logging.INFO -elif get_loglevel.lower() == "error": - loglevel = logging.ERROR -elif get_loglevel.lower() == "debug": - loglevel = logging.DEBUG - -logging.basicConfig(level=loglevel, format='%(asctime)s %(levelname)s %(message)s') -logging.info('Started ginlong-solis-scraper') - -schedule.every(5).minutes.at(':00').do(main).run() -while True: - if next_run_yes == 1: - next_run = schedule.next_run().strftime('%d/%m/%Y %H:%M:%S') - logging.info('Next run is scheduled at %s' % next_run) - next_run_yes = 0 - schedule.run_pending() - time.sleep(1) diff --git a/ginlong_solis_api_connector.py b/ginlong_solis_api_connector.py new file mode 100644 index 0000000..fe0f156 --- /dev/null +++ b/ginlong_solis_api_connector.py @@ -0,0 +1,531 @@ +#!/usr/bin/python +"""Solis cloud API data fetcher.""" +import base64 +import datetime +import hashlib +import hmac +import json +import logging +import logging.config +import urllib +import urllib.parse +import time +import traceback +import os +from datetime import datetime, timezone, date +from urllib.error import HTTPError, URLError +from urllib.request import urlopen, Request +import requests +import schedule +from influxdb import InfluxDBClient +from paho.mqtt import publish + + +def do_work(): # pylint: disable=too-many-locals disable=too-many-statements + """worker loop""" + + # solis cloud api config + api_key_id = os.environ['SOLIS_CLOUD_API_KEY_ID'] + api_key_pw = os.environ['SOLIS_CLOUD_API_KEY_SECRET'].encode("utf-8") + domain = os.environ['SOLIS_CLOUD_API_URL'] + port = int(os.environ['SOLIS_CLOUD_API_PORT']) + url = f'{domain}:{port}' + device_id = int(os.environ['SOLIS_CLOUD_API_INVERTER_ID']) + override_single_phase_inverter = os.environ['SOLIS_CLOUD_API_OVERRIDE_SINGLE_PHASE_INVERTER'] + api_retries = int(os.environ['SOLIS_CLOUD_API_NUMBER_RETRIES']) + api_retries_timeout_s = int(os.environ['SOLIS_CLOUD_API_RETRIES_WAIT_S']) + + # == Constants =============================================================== + http_function = "POST" + mime_content_type = "application/json" + endpoint_station_list = "/v1/api/userStationList" + endpoint_inverter_list = "/v1/api/inverterList" + endpoint_inverter_detail = "/v1/api/inverterDetail" + endpoint_inverter_monthly = "/v1/api/inverterMonth" + endpoint_inverter_yearly = "/v1/api/inverterYear" + endpoint_inverter_all = "/v1/api/inverterAll" + + # == Output ================================================================== + + # Influx settings + influx = os.environ['USE_INFLUX'] + influx_database = os.environ['INFLUX_DATABASE'] + influx_server = os.environ['INFLUX_SERVER'] + influx_port = int(os.environ['INFLUX_PORT']) + influx_user = os.environ['INFLUX_USER'] + influx_password = os.environ['INFLUX_PASSWORD'] + influx_measurement = os.environ['INFLUX_MEASUREMENT'] + + # pvoutput + pvoutput = os.environ['USE_PVOUTPUT'] + pvoutput_api = os.environ['PVOUTPUT_API_KEY'] + pvoutput_system = os.environ['PVOUTPUT_SYSTEM_ID'] + pvex7 = os.environ['PVOUTPUT_EXTENDED_V7'] + pvex8 = os.environ['PVOUTPUT_EXTENDED_V8'] + pvex9 = os.environ['PVOUTPUT_EXTENDED_V9'] + pvex10 = os.environ['PVOUTPUT_EXTENDED_V10'] + pvex11 = os.environ['PVOUTPUT_EXTENDED_V11'] + pvex12 = os.environ['PVOUTPUT_EXTENDED_V12'] + + # MQTT + mqtt = os.environ['USE_MQTT'] + mqtt_client = os.environ['MQTT_CLIENT_ID'] + mqtt_server = os.environ['MQTT_SERVER'] + mqtt_topic_pfad = os.environ['MQTT_TOPIC'] + mqtt_port = int(os.environ['MQTT_PORT']) + mqtt_username = os.environ['MQTT_USERNAME'] + mqtt_password = os.environ['MQTT_PASSWORD'] + + ### + # == prettify json output ==================================================== + def prettify_json(input_json) -> str: + """prettifies json for better output readability""" + return json.dumps(json.loads(input_json), indent=2) + + def calculate_unit_multiplicator(expected_unit, inverter_unit): + if len(inverter_unit) < 1: + logging.debug("Detected empty inverter unit. Returning multiplicator = 1") + return 1 + + fb_inv = inverter_unit[0] + fb_exp = expected_unit[0] + multiplicator = calculate_factor(fb_inv) / calculate_factor(fb_exp) + logging.debug("Call for caluculating multiplicator using expected unit '%s' and inverter unit '%s' resulting in multiplicator '%s'.", expected_unit, inverter_unit, multiplicator) # pylint: disable=line-too-long + return multiplicator + + def calculate_factor(fb_factor): + if fb_factor == "k": + factor = 1000 + elif fb_factor == "M": + factor = 1000000 + elif fb_factor == "G": + factor = 1000000000 + elif fb_factor == "T": + factor = 1000000000000 + elif fb_factor == "m": + factor = 1/1000 + else: + factor = 1 + return factor + + # == post ==================================================================== + def execute_request(target_url, data, headers, retries) -> str: + """execute request and handle errors""" + if data != "": + post_data = data.encode("utf-8") + request = Request(target_url, data=post_data, headers=headers) + else: + request = Request(target_url) + try: + with urlopen(request, timeout=30) as response: + body = response.read() + body_content = body.decode("utf-8") + logging.debug("Decoded content: %s", body_content) + return body_content + except HTTPError as error: + error_string = str(error.status) + ": " + error.reason + + if retries > 0: + logging.warning(target_url + " -> " + error_string + " | retries left: " + retries ) + time.sleep(api_retries_timeout_s) + execute_request(target_url, data, headers, retries - 1) + except URLError as error: + error_string = str(error.reason) + except TimeoutError: + error_string = "Request or socket timed out" + except Exception as ex: # pylint: disable=broad-except + error_string = "urlopen exception: " + str(ex) + traceback.print_exc() + + logging.error(target_url + " -> " + error_string) # pylint: disable=used-before-assignment + time.sleep(60) # retry after 1 minute + return "ERROR" + + # == get_solis_cloud_data ==================================================== + def get_solis_cloud_data(url_part, data) -> str: + """get solis cloud data""" + md5 = base64.b64encode(hashlib.md5(data.encode("utf-8")).digest()).decode("utf-8") + while True: + now = datetime.now(timezone.utc).strftime("%a, %d %b %Y %H:%M:%S GMT") + encrypt_str = ( + http_function + "\n" + + md5 + "\n" + + mime_content_type + "\n" + + now + "\n" + + url_part + ) + hmac_obj = hmac.new( + api_key_pw, + msg=encrypt_str.encode("utf-8"), + digestmod=hashlib.sha1, + ) + authorization = ( + "API " + + api_key_id + + ":" + + base64.b64encode(hmac_obj.digest()).decode("utf-8") + ) + headers = { + "Content-MD5": md5, + "Content-Type": mime_content_type, + "Date": now, + "Authorization": authorization, + } + data_content = execute_request(url + url_part, data, headers, api_retries) + logging.debug(url + url_part + " -> " + prettify_json(data_content)) + if data_content != "ERROR": + return data_content + + # == get_inverter_list_body ================================================== + def get_inverter_ids(): + body = '{"userid":"' + api_key_id + '"}' + data_content = get_solis_cloud_data(endpoint_inverter_list, body) + data_json = json.loads(data_content)["data"]["inverterStatusVo"] + entries = data_json["all"]-1 + if device_id < 0: + logging.error("'SOLIS_CLOUD_API_INVERTER_ID' has to be greater or equal to 0 " + \ + "and lower than %s.", str(entries)) + if device_id > entries: + logging.error("Your 'SOLIS_CLOUD_API_INVERTER_ID' (%s" + \ + ") is larger than or equal to the available number of inverters (" + \ + "%s). Please select a value between '0' and '%s'.", str(device_id), + str(entries), str(entries - 1)) + data_content = get_solis_cloud_data(endpoint_station_list, body) + data_json = json.loads(data_content)["data"]["page"]["records"] + station_info = data_json[device_id] + station_id = station_info["id"] + + body = '{"stationId":"' + station_id + '"}' + data_content = get_solis_cloud_data(endpoint_inverter_list, body) + inverter_info = json.loads(data_content)["data"]["page"]["records"][device_id] + return inverter_info["id"], inverter_info["sn"] + + def get_inverter_list_body( + inverter_id_val, + inverter_sn_val, + time_category='', + time_string='' + ) -> str: + if time_category == "": + body = '{"id":"' + inverter_id_val + '","sn":"' + inverter_sn_val + '"}' + else: + body = '{"id":"' + inverter_id_val + \ + '","sn":"' + inverter_sn_val + \ + '","' + time_category + \ + '":"' + time_string + '"}' + logging.debug("body: %s", body) + return body + + def get_inverter_details(inverter_id_val, inverter_sn_val): + inverter_detail_body = get_inverter_list_body(inverter_id_val, inverter_sn_val) + content = get_solis_cloud_data(endpoint_inverter_detail, inverter_detail_body) + return json.loads(content)["data"] + + def get_inverter_month_data(inverter_id_val, inverter_sn_val): + today = date.today() + str_month = today.strftime("%Y-%m") + inverter_detail_body = get_inverter_list_body( + inverter_id_val, + inverter_sn_val, + 'month', + str_month + ) + content = get_solis_cloud_data(endpoint_inverter_monthly, inverter_detail_body) + return json.loads(content)["data"] + + def get_inverter_year_data(inverter_id_val, inverter_sn_val): + today = date.today() + str_year = today.strftime("%Y") + inverter_detail_body = get_inverter_list_body( + inverter_id_val, + inverter_sn_val, + 'year', + str_year + ) + content = get_solis_cloud_data(endpoint_inverter_yearly, inverter_detail_body) + return json.loads(content)["data"] + + def get_inverter_all_data(inverter_id_val, inverter_sn_val): + inverter_detail_body = get_inverter_list_body(inverter_id_val, inverter_sn_val) + content = get_solis_cloud_data(endpoint_inverter_all, inverter_detail_body) + return json.loads(content)["data"] + + def get_ac_voltage(inverter_data): + return get_average_value(inverter_data, 'uAc1', 'uAc2', 'uAc3') + + def get_ac_current(inverter_data): + return get_average_value(inverter_data, 'iAc1', 'iAc2', 'iAc3') + + def get_average_value(inverter_data, field_phase_1, field_phase_2, field_phase_3): + if int(inverter_data['acOutputType']) == 0 or override_single_phase_inverter == 'true': + average_value = float(inverter_data[field_phase_1]) + else: + average_value = float((inverter_data[field_phase_1] + inverter_data[field_phase_2] + inverter_data[field_phase_3]) / 3) # pylint: disable=line-too-long + return average_value + + def convert_dict_details_to_float(dict_to_change, parameters): + for param in parameters: + dict_to_change[param] = float(dict_to_change[param]) + return dict_to_change + + def convert_dict_details_to_boolean(dict_to_change, parameters): + for param in parameters: + if dict_to_change[param]: + dict_to_change[param] = 1 + else: + dict_to_change[param] = 0 + return dict_to_change + + def get_last_month_generation(dict_year): + generation_last_month = 0.0 + if len(dict_year) > 1: + generation_last_month = float(dict_year[-2]['energy']) + + return generation_last_month + + # == MAIN ==================================================================== + # Write to Influxdb + def write_to_influx_db(inverter_data, inverter_month, inverter_year, inverter_all, update_date): # pylint: disable=too-many-locals + if influx.lower() == "true": + logging.info('InfluxDB output is enabled, posting outputs now...') + + # Building fields to export + dict_detail = inverter_data + dict_month = inverter_month # pylint: disable=unused-variable + dict_year = inverter_year + dict_all = inverter_all # pylint: disable=unused-variable + + dict_fields = {'DC_Voltage_PV1': float(dict_detail['uPv1'] * calculate_unit_multiplicator("V",dict_detail['uPv1Str'])), # pylint: disable=line-too-long + 'DC_Voltage_PV2': float(dict_detail['uPv2'] * calculate_unit_multiplicator("V",dict_detail['uPv2Str'])), # pylint: disable=line-too-long # pylint: disable=line-too-long + 'DC_Voltage_PV3': float(dict_detail['uPv3'] * calculate_unit_multiplicator("V",dict_detail['uPv3Str'])), # pylint: disable=line-too-long + 'DC_Voltage_PV4': float(dict_detail['uPv4'] * calculate_unit_multiplicator("V",dict_detail['uPv4Str'])), # pylint: disable=line-too-long + 'DC_Current1': float(dict_detail['iPv1'] * calculate_unit_multiplicator("A",dict_detail['iPv1Str'])), # pylint: disable=line-too-long + 'DC_Current2': float(dict_detail['iPv2'] * calculate_unit_multiplicator("A",dict_detail['iPv2Str'])), # pylint: disable=line-too-long + 'DC_Current3': float(dict_detail['iPv3'] * calculate_unit_multiplicator("A",dict_detail['iPv3Str'])), # pylint: disable=line-too-long + 'DC_Current4': float(dict_detail['iPv4'] * calculate_unit_multiplicator("A",dict_detail['iPv4Str'])), # pylint: disable=line-too-long + 'AC_Voltage': get_ac_voltage(dict_detail), + 'AC_Current': get_ac_current(dict_detail), + 'AC_Power': float(dict_detail['pac'] * calculate_unit_multiplicator("W",dict_detail['pacStr'])), # pylint: disable=line-too-long + 'AC_Frequency': float(dict_detail['fac']), + 'DC_Power_PV1': float(dict_detail['pow1'] * calculate_unit_multiplicator("W",dict_detail['pow1Str'])), # pylint: disable=line-too-long + 'DC_Power_PV2': float(dict_detail['pow2'] * calculate_unit_multiplicator("W",dict_detail['pow2Str'])), # pylint: disable=line-too-long + 'DC_Power_PV3': float(dict_detail['pow3'] * calculate_unit_multiplicator("W",dict_detail['pow3Str'])), # pylint: disable=line-too-long + 'DC_Power_PV4': float(dict_detail['pow4'] * calculate_unit_multiplicator("W",dict_detail['pow4Str'])), # pylint: disable=line-too-long + 'Inverter_Temperature': float(dict_detail['inverterTemperature']), + 'Daily_Generation': float(dict_detail['eToday'] * calculate_unit_multiplicator("kWh",dict_detail['eTodayStr'])), # pylint: disable=line-too-long + 'Monthly_Generation': float(dict_detail['eMonth'] * calculate_unit_multiplicator("kWh",dict_detail['eMonthStr'])), # pylint: disable=line-too-long + 'Annual_Generation': float(dict_detail['eYear'] * calculate_unit_multiplicator("kWh",dict_detail['eYearStr'])), # pylint: disable=line-too-long + 'Total_Generation': float(dict_detail['eTotal'] * calculate_unit_multiplicator("kWh",dict_detail['eTotalStr'])), # pylint: disable=line-too-long + 'Generation_Last_Month': get_last_month_generation(dict_year), + 'Power_Grid_Total_Power': float(dict_detail['psum'] * calculate_unit_multiplicator("W",dict_detail['psumStr'])), # pylint: disable=line-too-long + 'Total_On_grid_Generation': float(dict_detail['gridSellTotalEnergy'] * calculate_unit_multiplicator("kWh",dict_detail['gridSellTotalEnergyStr'])), # pylint: disable=line-too-long + 'Total_Energy_Purchased': float(dict_detail['gridPurchasedTotalEnergy'] * calculate_unit_multiplicator("kWh",dict_detail['gridPurchasedTotalEnergyStr'])), # pylint: disable=line-too-long + 'Consumption_Power': float(dict_detail['familyLoadPower'] * calculate_unit_multiplicator("W",dict_detail['familyLoadPowerStr'])), # pylint: disable=line-too-long + 'Consumption_Energy': float(dict_detail['homeLoadTotalEnergy'] * calculate_unit_multiplicator("kWh",dict_detail['homeLoadTotalEnergyStr'])), # pylint: disable=line-too-long + 'Daily_Energy_Used': float(dict_detail['eToday'] * calculate_unit_multiplicator("kWh",dict_detail['eTodayStr']) - (dict_detail['gridSellTodayEnergy'] * calculate_unit_multiplicator("kWh",dict_detail['gridSellTodayEnergyStr']))), # pylint: disable=line-too-long + 'Monthly_Energy_Used': float(dict_detail['eMonth'] * calculate_unit_multiplicator("kWh",dict_detail['eMonthStr']) - dict_detail['gridSellMonthEnergy'] * calculate_unit_multiplicator("kWh",dict_detail['gridSellMonthEnergyStr'])), # pylint: disable=line-too-long + 'Annual_Energy_Used': float(dict_detail['eYear'] * calculate_unit_multiplicator("kWh",dict_detail['eYearStr']) - dict_detail['gridSellYearEnergy'] * calculate_unit_multiplicator("kWh",dict_detail['gridSellYearEnergyStr'])), # pylint: disable=line-too-long + 'updateDate': int(dict_detail['dataTimestamp']) + } + + # Convert float values + changelist_float = [] + for key, value in dict_detail.items(): + if isinstance(value, int): + changelist_float.append(key) + + ignore_change_to_float = [] + for key in ignore_change_to_float: + changelist_float.remove(key) + + dict_float = convert_dict_details_to_float(dict_detail, changelist_float) + dict_fields.update(dict_float) + + # Convert boolean values + changelist_boolean = ["isShow"] + dict_boolean = convert_dict_details_to_boolean(dict_detail, changelist_boolean) + dict_fields.update(dict_boolean) + + # remove empty battery list + if len(dict_fields["batteryList"]) == 0: + dict_fields.pop("batteryList") + + # Read inverter_detail into dict + influx_to_submit = [ + { + "measurement": influx_measurement, + "tags": { + "deviceId": device_id + }, + "time": int(update_date), + "fields": dict_fields + } + ] + + if influx_user != "" and influx_password != "": + client = InfluxDBClient(host=influx_server, port=influx_port, username=influx_user, + password=influx_password) + else: + client = InfluxDBClient(host=influx_server, port=influx_port) + + client.switch_database(influx_database) + success = client.write_points(influx_to_submit, time_precision='ms') + if not success: + logging.error('Error writing to influx database') + + def write_to_pvoutput(inverter_data, update_date): + # Write to PVOutput + if pvoutput.lower() == "true": + logging.info('PvOutput output is enabled, posting results now...') + + headers = { + "X-Pvoutput-Apikey": pvoutput_api, + "X-Pvoutput-SystemId": pvoutput_system, + "Content-type": "application/x-www-form-urlencoded", + "Accept": "text/plain" + } + + # make seconds + tuple_time = time.localtime(int(update_date) / 1000) + # Get hour and date + pv_date = time.strftime("%Y%m%d", tuple_time) + pv_hour = time.strftime("%H:%M", tuple_time) + + pvoutput_data = { + # output date [yyyymmdd] as int + "d": pv_date, + # time [hh:mm] + "t": pv_hour, + # energy generation (int, Wh) + "v1": inverter_data['eToday'] * 1000, + # power generation (int, W) + "v2": inverter_data['pac'] * 1000, + # energy consumption (int, Wh) + "v3": inverter_data['homeLoadTotalEnergy'] * 1000, + # power consumption (int, W) + "v4": inverter_data['familyLoadPower'] * 1000, + # temperature (float, °C), not available by inverter data + # "v5": 0.0, + # voltage (float, V) + "v6": get_ac_voltage(inverter_data) + } + + if pvex7 != "": + pvoutput_data["v7"] = inverter_data[pvex7] + if pvex8 != "": + pvoutput_data["v8"] = inverter_data[pvex8] + if pvex9 != "": + pvoutput_data["v9"] = inverter_data[pvex9] + if pvex10 != "": + pvoutput_data["v10"] = inverter_data[pvex10] + if pvex11 != "": + pvoutput_data["v11"] = inverter_data[pvex11] + if pvex12 != "": + pvoutput_data["v12"] = inverter_data[pvex12] + + # Python3 change + encoded = urllib.parse.urlencode(pvoutput_data) + + pvoutput_result = requests.post( + "https://pvoutput.org/service/r2/addstatus.jsp", + data=encoded, + headers=headers, + timeout=120 + ) + logging.debug('PvOutput response: %s', pvoutput_result.content) + if pvoutput_result.status_code != 200: + logging.error('Error posting to PvOutput') + + def write_to_mqtt(inverter_data, update_date): + # Push to MQTT + if mqtt.lower() == "true": + logging.info('MQTT output is enabled, posting results now...') + + msgs = [] + + # Topic base using the env mqtt_topic_pfad + client ID + mqtt_topic = ''.join([mqtt_topic_pfad, "/", mqtt_client, "/"]) + + if mqtt_username != "" and mqtt_password != "": + auth_settings = {'username': mqtt_username, 'password': mqtt_password} + else: + auth_settings = None + + inverter_data.pop("batteryList") + + msgs.append((mqtt_topic + "updateDate", int(update_date), 0, False)) + for key, value in inverter_data.items(): + msgs.append((mqtt_topic + key, value, 0, False)) + + logging.debug("writing to MQTT -> %s", msgs) + publish.multiple(msgs, hostname=mqtt_server, port=mqtt_port, client_id=mqtt_client, auth=auth_settings) # pylint: disable=line-too-long + + if api_key_id == "" or api_key_pw == "": + logging.error('Key ID and secret are mandatory for Solis Cloud API') + return + + # download data + inverter_result = get_inverter_ids() + inverter_id = inverter_result[0] + inverter_sn = inverter_result[1] + inverter_detail = get_inverter_details(inverter_id, inverter_sn) + timestamp_current = inverter_detail["dataTimestamp"] + inverter_data_month = get_inverter_month_data(inverter_id, inverter_sn) + inverter_data_year = get_inverter_year_data(inverter_id, inverter_sn) + inverter_data_all = get_inverter_all_data(inverter_id, inverter_sn) + + # push to database + json_formatted_str = json.dumps(inverter_detail, indent=2) + logging.debug(json_formatted_str) + + # output data + if influx == "true": + write_to_influx_db( + inverter_detail, + inverter_data_month, + inverter_data_year, + inverter_data_all, + timestamp_current + ) + + if pvoutput == "true": + write_to_pvoutput(inverter_detail, timestamp_current) + + if mqtt == "true": + write_to_mqtt(inverter_detail, timestamp_current) + + +def main(): + """the main method""" + + global NEXT_RUN_YES # pylint: disable=global-statement + try: + do_work() + except Exception as exception: # pylint: disable=broad-exception-caught + logging.error('%s : %s', type(exception).__name__, str(exception)) + NEXT_RUN_YES = 1 + + +global NEXT_RUN_YES # pylint: disable=global-at-module-level + +GET_LOGLEVEL = os.environ['LOG_LEVEL'] +LOGLEVEL = logging.INFO +if GET_LOGLEVEL.lower() == "info": + LOGLEVEL = logging.INFO +elif GET_LOGLEVEL.lower() == "error": + LOGLEVEL = logging.ERROR +elif GET_LOGLEVEL.lower() == "debug": + LOGLEVEL = logging.DEBUG + +logging.basicConfig(level=LOGLEVEL, format='%(asctime)s %(levelname)s %(message)s') +logging.info('Started ginlong-solis-api-connector') + +schedule.every(5).minutes.at(':00').do(main).run() + +while True: + if NEXT_RUN_YES == 1: + next_run = schedule.next_run().strftime('%d/%m/%Y %H:%M:%S') + logging.info('Next run is scheduled at %s', next_run) + NEXT_RUN_YES = 0 + schedule.run_pending() + time.sleep(1) diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..38c2ad7 --- /dev/null +++ b/renovate.json @@ -0,0 +1,6 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:recommended" + ] +} \ No newline at end of file