Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

byd_bat: Change jpg to png and adapt user_doc.rst, new release 0.0.4 #807

Merged
merged 8 commits into from
Sep 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion byd_bat/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
# V0.0.3 230819 - Code mit pycodestyle kontrolliert/angepasst
# - Anpassungen durch 'check_plugin'
#
# V0.0.4 230904 - Bilder JPG in PNG konvertiert fuer user_doc.rst
#
# -----------------------------------------------------------------------
#
# Als Basis fuer die Implementierung wurde die folgende Quelle verwendet:
Expand Down Expand Up @@ -176,7 +178,7 @@ class properties and methods (class variables and class functions)
are already available!
"""

PLUGIN_VERSION = '0.0.3'
PLUGIN_VERSION = '0.0.4'

def __init__(self,sh):
"""
Expand Down
2 changes: 1 addition & 1 deletion byd_bat/plugin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ plugin:
# documentation: https://github.com/smarthomeNG/smarthome/wiki/CLI-Plugin # url of documentation (wiki) page
support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1886748-support-thread-f%C3%BCr-das-byd-batterie-plugin

version: 0.0.3 # Plugin version (must match the version specified in __init__.py)
version: 0.0.4 # Plugin version (must match the version specified in __init__.py)
sh_minversion: 1.9 # minimum shNG version to use this plugin
# sh_maxversion: # maximum shNG version to use this plugin (leave empty if latest)
# py_minversion: 3.6 # minimum Python version to use for this plugin
Expand Down
28 changes: 14 additions & 14 deletions byd_bat/user_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ Anforderungen
Der BYD Energiespeicher muss mit dem LAN verbunden sind. Die IP-Adresse des BYD wird über DHCP zugewiesen und muss ermittelt werden. Diese IP-Adresse muss in der Plugin-Konfiguration gespeichert werden.

Notwendige Software
~~~~~~~~~~~~~~~~~~~
-------------------

* matplotlib

Unterstützte Geräte
~~~~~~~~~~~~~~~~~~~
-------------------

Folgende Typen werden unterstützt:

Expand All @@ -53,27 +53,27 @@ Konfiguration
=============

plugin.yaml
~~~~~~~~~~~
-----------

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Zu den Informationen, welche Parameter in der ../etc/plugin.yaml konfiguriert werden können bzw. müssen, bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/byd_bat>` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.


items.yaml
~~~~~~~~~~
----------

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Zu den Informationen, welche Attribute in der Item Konfiguration verwendet werden können bzw. müssen, bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/byd_bat>` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.


logic.yaml
~~~~~~~~~~
----------

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Zu den Informationen, welche Konfigurationsmöglichkeiten für Logiken bestehen, bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/byd_bat>` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.


Funktionen
~~~~~~~~~~
----------

Bitte die Dokumentation lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.
Zu den Informationen, welche Funktionen das Plugin bereitstellt (z.B. zur Nutzung in Logiken), bitte die Dokumentation :doc:`Dokumentation </plugins_doc/config/byd_bat>` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde.

Web Interface
=============
Expand All @@ -87,20 +87,20 @@ Oben rechts werden die wichtigsten Daten zum BYD Energiespeicher angezeigt.

Im Tab "BYD Home" sind die Grunddaten des Energiespeichers dargestellt:

.. image:: assets/home.JPG
.. image:: assets/home.png
:class: screenshot

Im Tab "BYD Diagnose" werden Diagnosedaten angezeigt:

.. image:: assets/diag.JPG
.. image:: assets/diag.png
:class: screenshot

Im Tab "BYD Spannungen" werden die Spannungen der Module als Heatmap angezeigt:

.. image:: assets/volt.JPG
.. image:: assets/volt.png
:class: screenshot

Im Tab "BYD Temperaturen" werden die Temperaturen der Module als Heatmap angezeigt:

.. image:: assets/temp.JPG
.. image:: assets/temp.png
:class: screenshot
Binary file removed byd_bat/webif/static/img/diag.JPG
Binary file not shown.
Binary file added byd_bat/webif/static/img/diag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed byd_bat/webif/static/img/home.JPG
Binary file not shown.
Binary file added byd_bat/webif/static/img/home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed byd_bat/webif/static/img/temp.JPG
Binary file not shown.
Binary file added byd_bat/webif/static/img/temp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed byd_bat/webif/static/img/volt.JPG
Binary file not shown.
Binary file added byd_bat/webif/static/img/volt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.