From 45ce7a03b8145ace226b483a7490f8cf2fbe0d0e Mon Sep 17 00:00:00 2001 From: Dennis Siemensma Date: Tue, 2 Jul 2024 21:58:26 +0200 Subject: [PATCH] Relocate/convert docs #1686 --- documentation/docs/explained/about.md | 151 ++++++++++++++++++ .../drawings/DSMR-reader-Architecture.svg | 1 + .../screenshots/about-dsmrreader}/about.png | Bin .../screenshots/about-dsmrreader}/archive.png | Bin .../screenshots/about-dsmrreader}/compare.png | Bin .../about-dsmrreader}/configuration.png | Bin .../about-dsmrreader}/dashboard.png | Bin .../about-dsmrreader}/energy-contracts.png | Bin .../screenshots/about-dsmrreader}/export.png | Bin .../screenshots/about-dsmrreader}/live.png | Bin .../about-dsmrreader}/statistics.png | Bin .../screenshots/about-dsmrreader}/support.png | Bin .../screenshots/about-dsmrreader}/trends.png | Bin 13 files changed, 152 insertions(+) create mode 100644 documentation/docs/explained/about.md create mode 100644 documentation/docs/static/drawings/DSMR-reader-Architecture.svg rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/about.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/archive.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/compare.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/configuration.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/dashboard.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/energy-contracts.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/export.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/live.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/statistics.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/support.png (100%) rename {legacy-docs/_static/screenshots/v5/frontend => documentation/docs/static/screenshots/about-dsmrreader}/trends.png (100%) diff --git a/documentation/docs/explained/about.md b/documentation/docs/explained/about.md new file mode 100644 index 000000000..50ce3adec --- /dev/null +++ b/documentation/docs/explained/about.md @@ -0,0 +1,151 @@ +# About DSMR-reader + +## Project goals +- Provide a tool to easily extract, store and visualize data transferred by the DSMR protocol of your smart meter. +- Allow you to export your data to other systems or third parties. + + +**Data transfer protocol support** + +- **MQTT**: Push data from DSMR-reader to a generic message broker. +- **REST API**: Push (telegram) data from a generic HTTP client to DSMR-reader. +- **REST API**: Pull data from DSMR-reader from a generic HTTP client. + +Any integration should be possible this way, either using generic scripts or even **plugins**. + +DSMR-reader only supports the builtin mentioned above and unfortunately cannot support every other (technical) integration that exists in the world. + + +## Architecture +*Below is a very shallow schema of DSMR-reader's architecture. Note that it's subject to be (eventually) outdated.* +![Drawing](../static/drawings/DSMR-reader-Architecture.svg) + + +## Languages +- The entire application and its code is written and documented in **English**. +- The interface is available in both **English** and **Dutch** (detects your **browser's language preference**). +- This documentation is only available in **English**. +- Any [support and communication](https://github.com/dsmrreader/dsmr-reader/issues/new/choose) is available in both **English** and **Dutch**. + +*This documentation used to be available in **Dutch** as well, but the latter was dropped along the release of DSMR-reader v6.x, to be able of spending most time into either development or support.* + +## Hardware requirements + +- RaspberryPi 4+ or similar. +- P1 telegram cable or a network socket when using ``ser2net``. +- A smart meter supporting any of these DSMR-telegram versions: ``v2`` / ``v4`` / ``v5``. + + +## Software requirements + +- **OS**: Any operating system that supports Docker containers. DSMR-reader runs in a container to ease upgrading. +- **Disk space**: 1+ GB - Depending on your smart meter and the amount of readings you want to preserve. +- **Database**: A [supported](https://www.postgresql.org/support/versioning/) PostgreSQL database. Other databases _may_ work as well, but are not supported for this project. + +Note that this project is built with [Django Framework](https://www.djangoproject.com/), which determines which versions are actually supported. + + +## Screenshots +**Dashboard** + +The dashboard displays the latest information regarding the consumption of today. +You can view the total consumption for the current month and year as well. + +If your meter supports it, you can also see your gas consumption and electricity returned. + +![Screenshot](../static/screenshots/about-dsmrreader/dashboard.png) + +---- + +**Live graphs** + +The live graphs plots the most recent data available, depending on the capabilities of your smart meter. + +![Screenshot](../static/screenshots/about-dsmrreader/live.png) + +---- + + +**Archive** + +The archive allows you to scroll through all historisch data captured by the application. +All data can be viewed on different levels: by day, by month and by year. + +![Screenshot](../static/screenshots/about-dsmrreader/archive.png) + +---- + + +**Compare** + +This page allows you to simply compare two days, months or years with each other. +It will also display the difference between each other as a percentage. + +![Screenshot](../static/screenshots/about-dsmrreader/compare.png) + +---- + + +**Trends** + +This page displays a summary of your average daily consumption and habits. + +![Screenshot](../static/screenshots/about-dsmrreader/trends.png) + +---- + + +**Statistics** + +This page displays your meter positions and statistics provided by the DSMR protocol. +You can also find the number of readings stored and any excesses regarding consumption. + +![Screenshot](../static/screenshots/about-dsmrreader/statistics.png) + +---- + +**Energy contracts** + +Summary of all your contracts and the amount of energy consumed/generated. + +![Screenshot](../static/screenshots/about-dsmrreader/energy-contracts.png) + +---- + + +**Export** + +This pages allows you to export all day or hour statistics to CSV. + +![Screenshot](../static/screenshots/about-dsmrreader/export.png) + +---- + + +**About** + +Shows the 'health' of the application. Any issues will be reported here. +You can also easily check for DSMR-reader updates here. + +![Screenshot](../static/screenshots/about-dsmrreader/about.png) + +---- + + +**Support** + +Assists you in finding the information required for debugging your installation or any issues. + +![Screenshot](../static/screenshots/about-dsmrreader/support.png) + +---- + + +**Configuration** + +The configuration page is the entrypoint for the admin interface. + +You can type any topic or setting you're searching for, as it should pop up with clickable deeplink to the admin panel. +Or you can just skip it this page and continue directly to the admin panel. + +![Screenshot](../static/screenshots/about-dsmrreader/configuration.png) diff --git a/documentation/docs/static/drawings/DSMR-reader-Architecture.svg b/documentation/docs/static/drawings/DSMR-reader-Architecture.svg new file mode 100644 index 000000000..23568cf83 --- /dev/null +++ b/documentation/docs/static/drawings/DSMR-reader-Architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/legacy-docs/_static/screenshots/v5/frontend/about.png b/documentation/docs/static/screenshots/about-dsmrreader/about.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/about.png rename to documentation/docs/static/screenshots/about-dsmrreader/about.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/archive.png b/documentation/docs/static/screenshots/about-dsmrreader/archive.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/archive.png rename to documentation/docs/static/screenshots/about-dsmrreader/archive.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/compare.png b/documentation/docs/static/screenshots/about-dsmrreader/compare.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/compare.png rename to documentation/docs/static/screenshots/about-dsmrreader/compare.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/configuration.png b/documentation/docs/static/screenshots/about-dsmrreader/configuration.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/configuration.png rename to documentation/docs/static/screenshots/about-dsmrreader/configuration.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/dashboard.png b/documentation/docs/static/screenshots/about-dsmrreader/dashboard.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/dashboard.png rename to documentation/docs/static/screenshots/about-dsmrreader/dashboard.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/energy-contracts.png b/documentation/docs/static/screenshots/about-dsmrreader/energy-contracts.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/energy-contracts.png rename to documentation/docs/static/screenshots/about-dsmrreader/energy-contracts.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/export.png b/documentation/docs/static/screenshots/about-dsmrreader/export.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/export.png rename to documentation/docs/static/screenshots/about-dsmrreader/export.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/live.png b/documentation/docs/static/screenshots/about-dsmrreader/live.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/live.png rename to documentation/docs/static/screenshots/about-dsmrreader/live.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/statistics.png b/documentation/docs/static/screenshots/about-dsmrreader/statistics.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/statistics.png rename to documentation/docs/static/screenshots/about-dsmrreader/statistics.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/support.png b/documentation/docs/static/screenshots/about-dsmrreader/support.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/support.png rename to documentation/docs/static/screenshots/about-dsmrreader/support.png diff --git a/legacy-docs/_static/screenshots/v5/frontend/trends.png b/documentation/docs/static/screenshots/about-dsmrreader/trends.png similarity index 100% rename from legacy-docs/_static/screenshots/v5/frontend/trends.png rename to documentation/docs/static/screenshots/about-dsmrreader/trends.png