diff --git a/grott/CHANGELOG.md b/grott/CHANGELOG.md new file mode 100644 index 0000000..f17ffa8 --- /dev/null +++ b/grott/CHANGELOG.md @@ -0,0 +1,6 @@ +# Changelog + +## 0.1 + +- Initial version +- Based on grott v2.3.1 diff --git a/grott/DOCS.md b/grott/DOCS.md new file mode 100644 index 0000000..ba5ea14 --- /dev/null +++ b/grott/DOCS.md @@ -0,0 +1,28 @@ +# Home Assistant Add-on: Grott - The Growatt inverter monitor + +## Installation + +Follow these steps to get the add-on installed on your system: + +1. document how to add a new custom repository in home assistant + +## How to use + +The add-on has a couple of options available. To get the add-on running: + +1. Start the add-on. +2. Have some patience and wait a couple of minutes. +3. Check the add-on log output to see the result. + +## Add-on configuration: +All options from grott are available as options in this add-on. They need to follow the naming convention of the environment variables. Eg: +```yaml + gmode: proxy + gnomqtt: False + gmqttip: 127.0.0.1 + gmqttport: 5288 + gmqttauth: False + gmqtttopic: energy/grott + gmqttuser: user + gmqttpassword: password +``` diff --git a/grott/Dockerfile b/grott/Dockerfile new file mode 100644 index 0000000..2993e6c --- /dev/null +++ b/grott/Dockerfile @@ -0,0 +1,46 @@ +ARG BUILD_FROM +FROM $BUILD_FROM + +ENV LANG C.UTF-8 + +# Run updates +# RUN apt-get clean && apt-get update && apt-get upgrade -y + +# Set the locale +# RUN apt-get install -y locales && locale-gen en_US.UTF-8 + +# Install python/pip +ENV PYTHONUNBUFFERED=1 +RUN apk add --update --no-cache python3 && ln -sf python3 /usr/bin/python +RUN python3 -m ensurepip +RUN pip3 install --no-cache --upgrade pip setuptools + +#Install required python packages +RUN pip3 install paho-mqtt +RUN pip3 install requests +RUN pip3 install influxdb +RUN pip3 install influxdb-client + + +#RUN curl -k https://codeload.github.com/johanmeijer/grott/zip/master --output files.zip && unzip files.zip +#RUN unzip files.zip + +# Copy data for add-on +#COPY grott.py /app/grott.py +#COPY grottconf.py /app/grottconf.py +#COPY grottdata.py /app/grottdata.py +#COPY grottproxy.py /app/grottproxy.py +#COPY grottsniffer.py /app/grottsniffer.py + +COPY script.sh /app/script.sh +WORKDIR /app +RUN curl -k https://codeload.github.com/johanmeijer/grott/zip/master --output files.zip && unzip files.zip +#RUN unzip files.zip +#COPY grott-master/grott.py /app/grott.py +#COPY grott-master/grottconf.py /app/grottconf.py +#COPY grott-master/grottdata.py /app/grottdata.py +#COPY grott-master/grottproxy.py /app/grottproxy.py +#COPY grott-master/grottsniffer.py /app/grottsniffer.py + +RUN chmod a+x script.sh +CMD [ "./script.sh" ] \ No newline at end of file diff --git a/grott/README.md b/grott/README.md index 8b13789..96c1619 100644 --- a/grott/README.md +++ b/grott/README.md @@ -1 +1,115 @@ +# Grott +## The Growatt inverter monitor +The growatt inverter sends log data to the growatt website at the internet. At this website (or with the mobile app) you can see detailed information on how the inverter is performing. + +**Grott** will monitor and process this data (containing information about performance and status of the inverter) and send this to: + +* MQTT +* PVOutput.org +* InfluxDB (V1 and V2) +* Using the extension functionality you can add your own processing and output functionality, + +MQTT can be used to distribute the data to other applications like: NodeRed, Grafana (using InfluxDB), Home Assistant, OpenHab and Domoticz. Descriptions and examples are available in the Wiki + +The program is written in python and runs under Linux, Windows and is available in a docker container on Docker Hub (see: https://github.com/johanmeijer/grott/wiki/Docker-support, containers available at:https://hub.docker.com/u/ledidobe). + +Grott can be started from the command line or as a (linux or Windows ) service. + +To "see" the growatt data, the network traffic needs to be routed via the system Grott is running (see: https://github.com/johanmeijer/grott/wiki/Rerouting-Growatt-Wifi-TCPIP-data-via-your-Grott-Server). + +Please see the wiki (https://github.com/johanmeijer/grott/wiki) for more information and installation details. There is also a short first time installation description available. + +# Version History +## New in Version 2.4.0 +Introduce possibility to add extensions for additional (personalized) processing. +
+see: https://github.com/johanmeijer/grott/wiki/Extensions + +## New in Version 2.3.1 +Direct output to inlfuxdb (v1 and v2) +
+see: https://github.com/johanmeijer/grott/wiki/InfluxDB-Support +## New in Version 2.2.6 +Mulitiple inverter (multiple system id's) support in PVOutput.org +
+see: https://github.com/johanmeijer/grott/wiki/PVOutput.org-support + +#### Be aware: Wiith this release the default grott.ini moved to examples directory +This file is deleted from the grott default directory to simply github installation (not overwrite your settings). +It is advised to copy this file into the Grott default directory (and customise it) during first time installation + +## New in Version 2.2.1 +#### Automatic protocol detection and processing +Limited .ini configuration needed (inverterid, encryption, offset and record layout is automaticially detected) +#### Direct output to PVOutput.org (no mqtt processing needed). +Specify pvoutput = True and apikey and systemid in .ini file to enable it. +#### Docker support +2 docker containers are created ledidobe/grottrpi (specific old RPI with ARM32) and ledidobe/grott (generic one, tested on synology NAS and Ubuntu). See https://hub.docker.com/search?q=ledidobe&type=image. +See issue 4 and 15 on how to use it (wiki will be updated soon) +#### Command Blocking / Filtering +with blockcmd = True specified in .ini (configure/reboot) commands from outside to the inverter are blocked. This protects the inverter from beeing controlled from the outside while data exchange with server.growatt.com for reporting is still active. +#### Use date/time from data record +If date/time is available in the data (inserted by the inverter) this will be used. In this way buffered records will be sent with the original creation time (in the past). +If date/time is not available in the data record the server time will be used (as it was originally). +In the mqtt message the key buffered is added (yes/no) which indicates that the message is from the buffer (past) or actual. + +## Version 2: Introduction of 2 modes support: sniff and proxy. + +In sniff mode (default and compatable with older Grott versions) IP sniffering technology is used (based on: https://github.com/buckyroberts/Python-Packet-Sniffer). In this mode the data needs to be "re-routed" using linux IP forwarding on the device Grott is running. In this mode Grott "sees" every IP package and when a Growatt TCP packages passes it will be processed and a MQTT will be sent if inverter status information is detected. + +With the proxy mode Grott is listening on a IP port (default 5279), processes the data (sent MQTT message) and routes the original packet to the growatt website. + +The proxy mode functionality can be enabled by: + +- mode = proxy in the conf.ini file +- m proxy parameter during startup + +Pro / Cons: + + sniff mode + + Data will also be routed to the growatt server if Grott is not active + - All TCP packages (also not growatt) need to be processed by Grott. + This is more resource (processor) intesive and can have a negative impact on the device performance. + - Configure IP forwarding can be complex if a lot of other network routing is configured (e.g. by Docker). + - Sudo rights necessary to allow network sniffering + + proxy mode: + + Simple configuration + + Only Growatt IP records are being analysed and processed by Grott + + Less resource intensive + + No sudo rights needed + + Blocking / Filtering of commands from the outside is possible + - If Grott is not running no data will be sent to the Growatt server + +The adivse is to use the proxy mode. This mode is strategic and will be used for enhanced features like automatic protocol detection and command blocking filtering. +
+Sniff mode is not supported under Windows +
+In sniff mode it is necessary to run Grott with SUDO rights. + +*** + +## Minimal installation +The following modules are needed the use Grott: +- grott.py +- grott.ini (available in examples direcory) +- grottconf.py +- grottdata.py +- grottproxy.py +- grottsniffer.py + + +### The Grott monitor is tested on Raspian (Raspberry PI),Ubuntu and windows 10 (proxy only), with ++ 1500-S (ShineWiFi) ++ 3000-S (Shinelan) ++ 2500-MTL-S (ShineWiFi) ++ 4200-MTL-S (Shinelan) ++ 5000TL-X (ShineWifi-X) ++ 3600TL-XE (ShineLink-X) ++ 3600TL-XE (ShineLan) + +## The Docker images are tested RPI(arm32), Ubuntu and Synology NAS + +#### More Version History: see Version_history.txt file. +#### Grott is a "hobby" project you can use it as it is (with the potential errors and imperfections). Remarks and requests for improvement are welcome. diff --git a/grott/config.json b/grott/config.json new file mode 100644 index 0000000..2269beb --- /dev/null +++ b/grott/config.json @@ -0,0 +1,63 @@ +{ + "name": "Grott", + "version": "0.1", + "slug": "grott", + "description": "The Growatt inverter monitor", + "arch": ["armhf", "armv7", "aarch64", "amd64", "i386"], + "startup": "application", + "boot": "auto", + "ports" :{ + "5279/tcp": 5279 + }, + "options": { + "gmode": "proxy", + "gnomqtt": "False", + "gmqttip": "127.0.0.1", + "gmqttport": "5288", + "gmqttauth": "False", + "gmqtttopic": "energy/grott", + "gmqttuser": "user", + "gmqttpassword": "password" + }, + "schema": { + "gverbose": "bool?", + "gminrecl": "int?", + "gmode": "str", + "ggrottip": "str?", + "ggrottport": "port?", + "gblockcmd": "bool?", + "gnoipf": "bool?", + "gtime": "str?", + "gsendbuf": "bool?", + "gcompat": "bool?", + "gvalueoffset": "int?", + "ginverterid": "str?", + "gdecrypt": "bool?", + "ggrowattip": "str?", + "ggrowattport": "port?", + "gnomqtt": "bool?", + "gmqttip": "str?", + "gmqttport": "port?", + "gmqtttopic": "str?", + "gmqttauth": "bool?", + "gmqttuser": "str?", + "gmqttpassword": "password?", + "gpvoutput": "bool?", + "gpvapikey": "str?", + "gpvsystemid": "int?", + "ginflux": "bool?" , + "ginflux2": "bool?", + "gifdbname": "str?", + "gifip": "str?", + "gifport": "port?", + "gifuser": "str?", + "gifpassword": "password?", + "giforg": "str?", + "gifbucket": "str?", + "giftoken": "str?", + "gextension": "bool?", + "gextname": "str?", + "gextvar": "str?" + } +} + diff --git a/grott/script.sh b/grott/script.sh new file mode 100644 index 0000000..8294a75 --- /dev/null +++ b/grott/script.sh @@ -0,0 +1,19 @@ +#!/usr/bin/with-contenv bashio + +export gnomqtt="$(bashio::config 'gnomqtt')" +export gmqttip="$(bashio::config 'gmqttip')" +export gmqttport="$(bashio::config 'gmqttport')" +export gmqttauth="$(bashio::config 'gmqttauth')" +export gmqtttopic="$(bashio::config 'gmqtttopic')" +export gmqttuser="$(bashio::config 'gmqttuser')" +export gmqttpassword="$(bashio::config 'gmqttpassword')" + +echo ${gnomqtt} +echo ${gmqttip} +echo ${gmqttport} +echo ${gmqttauth} +echo ${gmqtttopic} +echo ${gmqttuser} +echo ${gmqttpassword} + +python -u grott-master/grott.py -v \ No newline at end of file