Skip to content

Commit

Permalink
Released v1.22.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dennissiemensma committed Jul 22, 2018
1 parent 567f5b0 commit baa2141
Show file tree
Hide file tree
Showing 73 changed files with 995 additions and 2,724 deletions.
37 changes: 29 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,31 @@
[![Requirements Status](https://requires.io/github/dennissiemensma/dsmr-reader/requirements.svg?branch=master)](https://requires.io/github/dennissiemensma/dsmr-reader/requirements/?branch=master)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://dsmr-reader.readthedocs.io/en/latest/donations.html)

# DSMR Reader Datalogger/GUI

## Project mission & goals
- Have fun by reading your smart meter at home yourself!
- Provide an easy to use setup for logging your own energy consumption.
- Keeping your data for yourself (all data is stored locally and untracked as well).
- Always free to use (and open source).
# DSMR Reader Datalogger/GUI


## Documentation (`English` & `Nederlands`)
- `English`: See [Read The Docs, in English](https://dsmr-reader.readthedocs.io/en/latest/). Installation guide can be found there as well.
- `Nederlands`: Zie [Read The Docs, in het Nederlands](https://dsmr-reader.readthedocs.io/nl/latest/). Je kunt daar ook alle installatieinstructies vinden.


## Screenshots
More screenshots can be found in the documentation at [Read The Docs](https://dsmr-reader.readthedocs.io/en/latest/screenshots.html).
## Project mission
- **Always free to use** (for non-commercial use only).
- **Keeping your data for yourself** (none of the data is stored outside your database, unless you explicitly upload it to a third party).

## Features
- Application languages supported: **Dutch (Nederlands)** and **English**. The language used in your browser dynamicly decides the language applied in the application.
- Optional Support for **exporting data to third-parties**: MinderGas.nl, PVOutput.org.
- Also supports local exports: CSV, SQL back-ups & optional daily upload to Dropbox.
- Notifications on your devices, supporting **Pushover** and **Prowl** apps!
- Optional data rotation/retention, keeping your dataset small and portable.
- Compare two days, months or years with each other.
- REST API to either insert or read data realtime.
- Keep track of certain events by sticking your own notes to a day, reminding yourself what happened that day.
- Support for MQTT export.
- Extendable plug-in system.
- Scrollable graphs.


### Dashboard
Expand All @@ -28,3 +37,15 @@ More screenshots can be found in the documentation at [Read The Docs](https://ds

### Archive
![Archive](docs/_static/screenshots/archive.png)


### Trends
![Archive](docs/_static/screenshots/trends.png)


### Energy contracts
![Archive](docs/_static/screenshots/energy-contracts.png)


## Screenshots
More screenshots can be found in the documentation at [Read The Docs](https://dsmr-reader.readthedocs.io/en/latest/screenshots.html).
Binary file modified docs/_static/screenshots/dashboard.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 added docs/_static/screenshots/energy-contracts.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 modified docs/_static/screenshots/statistics.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 modified docs/_static/screenshots/trends.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,9 @@ Parameters
- ``phase_currently_delivered_l1`` (*float*) - Current electricity used by phase L1 (in kW)
- ``phase_currently_delivered_l2`` (*float*) - Current electricity used by phase L2 (in kW)
- ``phase_currently_delivered_l3`` (*float*) - Current electricity used by phase L3 (in kW)
- ``phase_currently_returned_l1`` (*float*) - Current electricity returned by phase L1 (in kW)
- ``phase_currently_returned_l2`` (*float*) - Current electricity returned by phase L2 (in kW)
- ``phase_currently_returned_l3`` (*float*) - Current electricity returned by phase L3 (in kW)
- ``extra_device_timestamp`` (*datetime*) - Last timestamp read from the extra device connected (gas meter)
- ``extra_device_delivered`` (*float*) - Last value read from the extra device connected (gas meter)

Expand Down Expand Up @@ -388,6 +391,9 @@ Using **requests** (Python)::
"phase_currently_delivered_l1": null,
"phase_currently_delivered_l2": null,
"phase_currently_delivered_l3": null,
"phase_currently_returned_l1": null,
"phase_currently_returned_l2": null,
"phase_currently_returned_l3": null,
"extra_device_timestamp": null,
"extra_device_delivered": null
}
Expand Down Expand Up @@ -473,6 +479,9 @@ Using **requests** (Python)::
"phase_currently_delivered_l1": null,
"phase_currently_delivered_l2": null,
"phase_currently_delivered_l3": null,
"phase_currently_returned_l1": null,
"phase_currently_returned_l2": null,
"phase_currently_returned_l3": null,
"extra_device_timestamp": "2015-12-11T21:00:00Z",
"extra_device_delivered": "956.212"
},
Expand Down Expand Up @@ -528,6 +537,9 @@ Using **requests** (Python)::
"phase_currently_delivered_l1": "0.024",
"phase_currently_delivered_l2": "0.054",
"phase_currently_delivered_l3": "0.000",
"phase_currently_returned_l1": "0.000",
"phase_currently_returned_l2": "0.000",
"phase_currently_returned_l3": "0.000",
"extra_device_timestamp": "2017-04-29T03:00:00Z",
"extra_device_delivered": "1971.929"
}
Expand Down Expand Up @@ -583,6 +595,9 @@ Using **requests** (Python)::
"phase_currently_delivered_l1": "0.017",
"phase_currently_delivered_l2": "0.058",
"phase_currently_delivered_l3": "0.000",
"phase_currently_returned_l1": "0.000",
"phase_currently_returned_l2": "0.000",
"phase_currently_returned_l3": "0.000",
"extra_device_timestamp": "2017-01-31T22:00:00Z",
"extra_device_delivered": "1835.904"
},
Expand Down
13 changes: 13 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,19 @@ Please make sure you have a fresh **database backup** before upgrading! Upgradin



v1.22.0 - 2018-07-22
^^^^^^^^^^^^^^^^^^^^

**Tickets resolved in this release:**

- [`#296 <https://github.com/dennissiemensma/dsmr-reader/issues/296>`_] 3 fasen teruglevering
- [`#501 <https://github.com/dennissiemensma/dsmr-reader/issues/501>`_] Lijn grafiek bij geen teruglevering
- [`#495 <https://github.com/dennissiemensma/dsmr-reader/issues/495>`_] Update documentation screenshots
- [`#498 <https://github.com/dennissiemensma/dsmr-reader/issues/498>`_] Frontend improvements
- [`#493 <https://github.com/dennissiemensma/dsmr-reader/issues/493>`_] Requirements update (July 2018)



v1.21.1 - 2018-07-16
^^^^^^^^^^^^^^^^^^^^

Expand Down
1 change: 1 addition & 0 deletions docs/credits.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Listed in any order, sorted by name.
- `balk77 <https://github.com/balk77>`_
- `Baseje <https://github.com/Baseje>`_
- `Bert-Jan Vos <https://www.linkedin.com/in/bert-jan-vos-82011712>`_
- `Bl4ckviper <https://github.com/Bl4ckviper>`_
- `Calimerorulez <https://github.com/Calimerorulez>`_
- `Cyw00d <https://github.com/Cyw00d>`_
- `dajappie <https://github.com/dajappie>`_
Expand Down
Binary file modified docs/locale/nl/LC_MESSAGES/screenshots.mo
Binary file not shown.
123 changes: 69 additions & 54 deletions docs/locale/nl/LC_MESSAGES/screenshots.po
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,37 @@ msgstr ""
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.3.4\n"
"Generated-By: Babel 2.5.1\n"
"Language: nl\n"
"X-Generator: Poedit 1.8.7.1\n"

#: ../../screenshots.rst:2
msgid "Screenshots"
msgstr "Screenshots"

#: ../../screenshots.rst:3
msgid ""
"Below you can find some screenshots of the application. Please read the "
"note below regarding solar panels and support for them."
"Below you can find some screenshots of the application. Please read the note "
"below regarding solar panels and support for them."
msgstr ""
"Hieronder staan enkele screenshots van de applicatie. Lees hieronder ook "
"de notitie met betrekking tot zonnepanelen en de ondersteuning daarvoor."
"Hieronder staan enkele screenshots van de applicatie. Lees hieronder ook de "
"notitie met betrekking tot zonnepanelen en de ondersteuning daarvoor."

#: ../../screenshots.rst:8
msgid "Contents"
msgstr "Inhoudsopgave"

#: ../../screenshots.rst:11
msgid "Dashboard"
msgstr "Dashboard"

#: ../../screenshots.rst:12
msgid ""
"The dashboard displays the latest information regarding any consumption "
"of today and the current month so far."
"The dashboard displays the latest information regarding any consumption of "
"today and the current month so far."
msgstr ""
"Het dashboard geeft de meest recente informatie weer over je "
"energieverbruik van vandaag en de lopende maand tot nu toe."
"Het dashboard geeft de meest recente informatie weer over je energieverbruik "
"van vandaag en de lopende maand tot nu toe."

#: ../../screenshots.rst:20
msgid "Archive"
Expand All @@ -48,9 +54,9 @@ msgid ""
"The archive allows you to go back to any moment tracked. The data can be "
"plotted either on day, month or year level."
msgstr ""
"Het archief stelt je in staat om terug in de tijd te gaan naar elk "
"moment dat gemeten is met de applicatie. Gegevens kunnen getoond worden "
"op verschillende detailniveaus: per dag, per maand en per jaar."
"Het archief stelt je in staat om terug in de tijd te gaan naar elk moment dat "
"gemeten is met de applicatie. Gegevens kunnen getoond worden op verschillende "
"detailniveaus: per dag, per maand en per jaar."

#: ../../screenshots.rst:29
msgid "Trends"
Expand All @@ -66,94 +72,103 @@ msgstr "Statistieken"

#: ../../screenshots.rst:39
msgid ""
"The statistics page will display the current state of your meter and the "
"energy prices currently apply (if any)."
"The statistics page will display the current state of your meter and the energy "
"prices currently apply (if any)."
msgstr ""
"De statistiekenpagina geeft de huidige staat van je slimme meter en "
"de huidige energietarieven weer (wanneer van toepassing)."
"De statistiekenpagina geeft de huidige staat van je slimme meter en de huidige "
"energietarieven weer (wanneer van toepassing)."

#: ../../screenshots.rst:47
msgid "Energy contracts"
msgstr "Energiecontracten"

#: ../../screenshots.rst:48
msgid "Summary of all your contracts and the amount of energy consumed/generated."
msgstr ""
"Overzicht van alle energiecontracten en de hoeveelheid verbruikte/geleverde "
"energie."

#: ../../screenshots.rst:56
msgid "Compare"
msgstr "Vergelijk"

#: ../../screenshots.rst:48
#: ../../screenshots.rst:57
msgid "This page allows you to compare two days, months or years tracked before."
msgstr ""
"Met deze pagina vergelijk je eenvoudig twee dagen, maanden of jaren met "
"elkaar."
"Met deze pagina vergelijk je eenvoudig twee dagen, maanden of jaren met elkaar."

#: ../../screenshots.rst:56
#: ../../screenshots.rst:65
msgid "Status"
msgstr "Status"

#: ../../screenshots.rst:57
#: ../../screenshots.rst:66
msgid ""
"The status page will show the 'health' of the application and any data "
"tracked. If there are any problems regarding data handling, they should "
"be indicated here."
"The status page will show the 'health' of the application and any data tracked. "
"If there are any problems regarding data handling, they should be indicated "
"here."
msgstr ""
"De statuspagina geeft de 'gezondheid' van de applicatie en die van de"
" dataverwerking weer. Mochten er problemen zijn met het verzamelen van "
"gegevens dan zou dat hier zichtbaar moeten zijn."
"De statuspagina geeft de 'gezondheid' van de applicatie en die van de "
"dataverwerking weer. Mochten er problemen zijn met het verzamelen van gegevens "
"dan zou dat hier zichtbaar moeten zijn."

#: ../../screenshots.rst:65
#: ../../screenshots.rst:74
msgid "Export"
msgstr "Exporteren"

#: ../../screenshots.rst:66
#: ../../screenshots.rst:75
msgid ""
"Want to export day totals or hourly data to Excel? This page allows you "
"to export the data in .CSV format."
"Want to export day totals or hourly data to Excel? This page allows you to "
"export the data in .CSV format."
msgstr ""
"Wil je alle dag- of uurtotalen exporteren om in Excel te bekijken? Dat "
"kan via deze pagina door ze te exporteren in .CSV-formaat."
"Wil je alle dag- of uurtotalen exporteren om in Excel te bekijken? Dat kan via "
"deze pagina door ze te exporteren in .CSV-formaat."

#: ../../screenshots.rst:74
#: ../../screenshots.rst:83
msgid "Settings"
msgstr "instellingen"

#: ../../screenshots.rst:75
#: ../../screenshots.rst:84
msgid ""
"The project is written using Django and some of it's backend pages are "
"displayed below."
msgstr ""
"Het project is gemaakt met Django en hieronder staan enkele "
"beheerderspagina's daarvan."
"Het project is gemaakt met Django en hieronder staan enkele beheerderspagina's "
"daarvan."

#: ../../screenshots.rst:77
#: ../../screenshots.rst:86
msgid ""
"The application has quite some features, such are temperature tracking, "
"automated backups and Dropbox intergration. This page displays the status"
" of them all."
"automated backups and Dropbox intergration. This page displays the status of "
"them all."
msgstr ""
"De applicatie heeft behoorlijk wat features, zoals buitentemperatuur "
"bijhouden, geautomatiseerde back-ups en Dropbox-integratie. Op deze "
"pagina kun je een overzicht vinden van alle instellingen."
"De applicatie heeft behoorlijk wat features, zoals buitentemperatuur bijhouden, "
"geautomatiseerde back-ups en Dropbox-integratie. Op deze pagina kun je een "
"overzicht vinden van alle instellingen."

#: ../../screenshots.rst:84
#: ../../screenshots.rst:93
msgid "Here you may manage your energy prices:"
msgstr "Hier kun je je energieprijzen beheren:"

#: ../../screenshots.rst:90
#: ../../screenshots.rst:99
msgid "This allows you to alter your backup settings:"
msgstr "Hiermee beheer je de instellingen voor je back-ups:"

#: ../../screenshots.rst:96
#: ../../screenshots.rst:105
msgid "Pick your own colors for the graphs displayed:"
msgstr "Kies je eigen kleuren voor de grafieken:"

#: ../../screenshots.rst:102
#: ../../screenshots.rst:111
msgid ""
"The application supports the daily export of your gas meter positions (if"
" any) to your personal mindergas.nl account."
"The application supports the daily export of your gas meter positions (if any) "
"to your personal mindergas.nl account."
msgstr ""
"De applicatie ondersteunt het dagelijks exporteren van je gasmeterstanden"
" naar je eigen account bij mindergas.nl."
"De applicatie ondersteunt het dagelijks exporteren van je gasmeterstanden naar "
"je eigen account bij mindergas.nl."

#: ../../screenshots.rst:108
#: ../../screenshots.rst:117
msgid ""
"There are several additional backend pages for the other configuration "
"options as well."
"There are several additional backend pages for the other configuration options "
"as well."
msgstr ""
"Er zijn nog diverse andere beheerpagina's beschikbaar voor de overige "
"configuratie-instellingen."
9 changes: 9 additions & 0 deletions docs/screenshots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ The statistics page will display the current state of your meter and the energy
:alt: Statistics


Energy contracts
----------------
Summary of all your contracts and the amount of energy consumed/generated.

.. image:: _static/screenshots/energy-contracts.png
:target: _static/screenshots/energy-contracts.png
:alt: Energy contracts


Compare
-------
This page allows you to compare two days, months or years tracked before.
Expand Down
Loading

0 comments on commit baa2141

Please sign in to comment.