Skip to content

Commit

Permalink
Released v1.25.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dennissiemensma committed Oct 18, 2018
1 parent 07a8d78 commit a538b54
Show file tree
Hide file tree
Showing 221 changed files with 6,303 additions and 4,034 deletions.
Binary file removed docs/_static/screenshots/admin.png
Binary file not shown.
Binary file removed docs/_static/screenshots/admin_api_settings.png
Binary file not shown.
Binary file removed docs/_static/screenshots/admin_graph_colors.png
Binary file not shown.
Binary file removed docs/_static/screenshots/archive.png
Binary file not shown.
Binary file removed docs/_static/screenshots/backupsettings.png
Binary file not shown.
Binary file removed docs/_static/screenshots/compare.png
Binary file not shown.
Binary file removed docs/_static/screenshots/dashboard.png
Binary file not shown.
Binary file removed docs/_static/screenshots/energy-contracts.png
Binary file not shown.
Binary file removed docs/_static/screenshots/energysupplierprice.png
Binary file not shown.
Binary file removed docs/_static/screenshots/export.png
Binary file not shown.
Binary file removed docs/_static/screenshots/mindergas_admin.png
Binary file not shown.
Binary file removed docs/_static/screenshots/mqtt_broker.png
Binary file not shown.
Binary file removed docs/_static/screenshots/mqtt_json.png
Binary file not shown.
Binary file removed docs/_static/screenshots/mqtt_raw.png
Binary file not shown.
Binary file removed docs/_static/screenshots/mqtt_split.png
Binary file not shown.
Binary file removed docs/_static/screenshots/phases.png
Binary file not shown.
Binary file removed docs/_static/screenshots/statistics.png
Binary file not shown.
Binary file removed docs/_static/screenshots/status.png
Binary file not shown.
Binary file removed docs/_static/screenshots/trends.png
Binary file not shown.
12 changes: 12 additions & 0 deletions docs/admin/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Admin: API
==========

Configure the API if you need it to supply telegrams or simply read data from DSMR-reader.

By default a random API key will be generated. You can enter your own if you want to.
:doc:`You can find the API documentation here.<../api>`


.. image:: ../static/screenshots/admin/apisettings.png
:target: ../static/screenshots/admin/apisettings.png
:alt: API
36 changes: 36 additions & 0 deletions docs/admin/backup_dropbox.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Admin: Backup & Dropbox
=======================

The application backs up your data daily. You can change the time the backup will be created every day.

.. image:: ../static/screenshots/admin/backupsettings.png
:target: ../static/screenshots/admin/backupsettings.png
:alt: Backup

You can use your Dropbox-account to make sure your backups are safely stored in your account.

.. image:: ../static/screenshots/admin/dropboxsettings.png
:target: ../static/screenshots/admin/dropboxsettings.png
:alt: Dropbox

Make sure you have a Dropbox-account or sign up for one.
Now go to `Dropbox Apps <https://www.dropbox.com/developers/apps>`_ and click **"Create app"** in top right corner.

.. image:: ../static/faq/dropbox_apps_overview.png
:target: ../static/faq/dropbox_apps_overview.png
:alt: Dropbox Apps

Choose the following options: (1) **Dropbox API** and (2) **App folder**.
Then enter a name for your app (3), this will also be used as directory name within the Apps-folder of your Dropbox.

.. image:: ../static/faq/dropbox_create_app.png
:target: ../static/faq/dropbox_create_app.png
:alt: Dropbox Apps

The app should be created in developer-mode. You can generate an access token for yourself by clicking the **"Generate"** button somewhere below.

.. image:: ../static/faq/dropbox_app_token.png
:target: ../static/faq/dropbox_app_token.png
:alt: Dropbox Apps

Copy the generated access token to the DSMR-reader settings for the Dropbox-configuration. The DSMR-reader application should sync any backups created shortly.
9 changes: 9 additions & 0 deletions docs/admin/consumption.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Admin: Consumption
==================

You can choose whether to have all readings grouped by minute (default) or by reading.
This only affects the display of data in the Dashboard page.

.. image:: ../static/screenshots/admin/consumptionsettings.png
:target: ../static/screenshots/admin/consumptionsettings.png
:alt: Consumption
43 changes: 14 additions & 29 deletions docs/retention.rst → docs/admin/datalogger.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
Retention
=========
Admin: Datalogger
=================

Configure the builtin datalogger. You can choose to have electricity phases tracked as well.
The advanced options allow you to change the DSMR protocol version, but the default (v4/v5) should do fine for any recent placed smart meters.

.. image:: ../static/screenshots/admin/dataloggersettings.png
:target: ../static/screenshots/admin/dataloggersettings.png
:alt: Datalogger


By default all DSMR-readings read by of sent to the application are stored indefinitely.
DSMR v5 smart meters allow DSMR-readings to be recorded every second, resulting in over 30 million readings each year.

Eventually this **will cause degraded performance** in the application/database and for that reason you might want to apply retention to this data.
Please note that enabling this feature will **not discard all readings**, as it will **preserve the first and last reading of each hour**.

.. contents::

.. image:: ../static/screenshots/admin/retentionsettings.png
:target: ../static/screenshots/admin/retentionsettings.png
:alt: Datalogger


Notes / warnings
Expand All @@ -25,32 +36,6 @@ Notes / warnings
vacuumdb -a -f -v



How to enable
-------------

The admin configuration has a section called "Retention configuration".
You can specify whether you want retention at all and set the lifetime of the data being stored.


Data affected
-------------

DSMR-readings
~~~~~~~~~~~~~
The source of all data. It is, however, only read and processed once, so it can be discarded safely after processing.

Electricity Consumption
~~~~~~~~~~~~~~~~~~~~~~~
This is aggregated data either created from a single DSMR-reader or a minute worth of DSMR-readings, depending on whether you've enabled grouping.

Gas Consumption
~~~~~~~~~~~~~~~
This data type is aggregated from any differences in 'extra device timestamp' occurrences in DSMR-readings.


Data kept/unaffected
--------------------
Historic data, such as Hour and Day Statistics are unaffected.
These are aggregated from the Electricity & Gas Consumption data above.
This is also the only data that should matter when you want to look back to a specific day, month or year in the past.
11 changes: 11 additions & 0 deletions docs/admin/interface.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Admin: Interface
================

Your smart meter always keeps tracks of high and low tariff.
If you are paying your energy supplier for a single tariff, you can have the application display all electricity combined as a single merged tariff.

You can change most colors used in graphs to your personal flavor as well.

.. image:: ../static/screenshots/admin/frontendsettings.png
:target: ../static/screenshots/admin/frontendsettings.png
:alt: Interface
18 changes: 8 additions & 10 deletions docs/mindergas.rst → docs/admin/mindergas.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
Integration: MinderGas.nl
=========================
Admin: MinderGas.nl
===================

Link your MinderGas.nl-account to have DSMR-reader upload your gas meter position daily.

.. contents::
:depth: 2
.. image:: ../static/screenshots/admin/mindergassettings.png
:target: ../static/screenshots/admin/mindergassettings.png
:alt: MinderGas


Mindergas.nl: Automated gas meter position export
-------------------------------------------------
*How can I link my mindergas.nl account?*

Make sure you have a Mindergas.nl account or `signup for one <https://www.mindergas.nl/users/sign_up>`_.
Now go to "`Meterstand API <https://www.mindergas.nl/member/api>`_" and click on the button located below **"Authenticatietoken"**.

.. image:: _static/faq/mindergas_api.png
:target: _static/faq/mindergas_api.png
.. image:: ../static/faq/mindergas_api.png
:target: ../static/faq/mindergas_api.png
:alt: Mindergas API

Copy the authentication token generated and paste in into the DSMR-reader settings for the Mindergas.nl-configuration.
Expand Down
62 changes: 62 additions & 0 deletions docs/admin/mqtt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Admin: MQTT
===========

The application has native support for MQTT.
In the screen below you can enter all information about the broker you're using.

There are options for using different ports, SSL, authentication and even the Quality of Service (QoS) used.
More information about MQTT QoS `can be found here <https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels>`_.


.. image:: ../static/screenshots/admin/mqttbrokersettings.png
:target: ../static/screenshots/admin/mqttbrokersettings.png
:alt: MQTT Broker

There are multiple configurations available for sending MQTT messages to your broker.
You can enable them seperately, depending on your needs.
Many of these also allow you to define which fields are sent and how they should be identified in messages sent to the broker.

Day totals
----------

This allows you to receive the day totals in JSON format:

.. image:: ../static/screenshots/admin/jsondaytotalsmqttsettings.png
:target: ../static/screenshots/admin/jsondaytotalsmqttsettings.png
:alt: MQTT JSON day Totals

The same data, but splitted among topics. This allows you to post a single piece of data on a separate topic:

.. image:: ../static/screenshots/admin/splittopicdaytotalsmqttsettings.png
:target: ../static/screenshots/admin/splittopicdaytotalsmqttsettings.png
:alt: MQTT Split Topic Day Totals

Meter statistics
----------------

Statistics of your meter, splitted among topics:

.. image:: ../static/screenshots/admin/splittopicmeterstatisticsmqttsettings.png
:target: ../static/screenshots/admin/splittopicmeterstatisticsmqttsettings.png
:alt: MQTT Split Topic Meter Statistics

Telegram
--------

Telegram in JSON format:

.. image:: ../static/screenshots/admin/jsontelegrammqttsettings.png
:target: ../static/screenshots/admin/jsontelegrammqttsettings.png
:alt: MQTT JSON Telegram

Or splitted among topics:

.. image:: ../static/screenshots/admin/splittopictelegrammqttsettings.png
:target: ../static/screenshots/admin/splittopictelegrammqttsettings.png
:alt: MQTT Split Topic Telegram

Or in raw DSMR protocol format (when available):

.. image:: ../static/screenshots/admin/rawtelegrammqttsettings.png
:target: ../static/screenshots/admin/rawtelegrammqttsettings.png
:alt: MQTT Raw Telegram
33 changes: 12 additions & 21 deletions docs/notifications.rst → docs/admin/notifications.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,17 @@
Integration: Notifications
==========================
Admin: Notifications
====================

Notifications on your phone using Prowl or Pushover.

.. contents::
:depth: 2


Usage notification: Daily usage statistics on your smartphone
-------------------------------------------------------------

Which services for sending notifications are supported?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. image:: ../static/screenshots/admin/notificationsetting.png
:target: ../static/screenshots/admin/notificationsetting.png
:alt: Notifications

Currently, two mobile platforms are supported: Android and iOS.

* The supported app for Android is `Pushover <https://pushover.net>`_.
* The supported apps for iOS are `Pushover <https://pushover.net>`_ and `Prowl <https://www.prowlapp.com>`_.


How do I setup usage notifications?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Make sure you either have Pushover or Prowl installed on your smartphone.
If you don't, visit your platforms app store to download the app and sign up for an account.
Then, make sure to get your API key from the notification service that you prefer.
Expand All @@ -45,8 +36,8 @@ Pushover requires you to enter two keys in DSMR-reader.
* You will need the **User Key** displayed on the top right in the screenshot below.
* And you will need the **API key** for the application you've created in Pushover.

.. image:: _static/faq/notifications-pushover-get-key.png
:target: _static/faq/notifications-pushover-get-key.png
.. image:: ../static/faq/notifications-pushover-get-key.png
:target: ../static/faq/notifications-pushover-get-key.png
:alt: Pushover Get Your API Key


Expand All @@ -58,12 +49,12 @@ After you have downloaded Prowl and signed up for an account you should be able
Now go to "`API Keys <https://www.prowlapp.com/api_settings.php>`_", you should see an overview of your current API keys if you have any.
To create an API key for the DSMR-reader, input a name and click **"Generate Key"**.

.. image:: _static/faq/notifications-prowl-create-key.png
:target: _static/faq/notifications-prowl-key.png
.. image:: ../static/faq/notifications-prowl-create-key.png
:target: ../static/faq/notifications-prowl-key.png
:alt: Prowl My Account overview

When a new key is generated, you will see it immediatly. Your key is listed like in the screenshot below (the red box marks your API key).

.. image:: _static/faq/notifications-prowl-get-key.png
:target: _static/faq/notifications-prowl-get-key.png
.. image:: ../static/faq/notifications-prowl-get-key.png
:target: ../static/faq/notifications-prowl-get-key.png
:alt: Prowl Get Your API Key
31 changes: 11 additions & 20 deletions docs/pvoutput.rst → docs/admin/pvoutput.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,14 @@
Integration: PVOutput
=====================


.. contents::
:depth: 2


PVOutput.org: Automated electricity consumption export
------------------------------------------------------
*How can I link my PVOutput.org account?*
Admin: PVOutput.org
===================

Make sure you have a PVOutput.org account, or `signup for an account <https://pvoutput.org/>`_.
You will have to configure your account and PV system(s). For any support doing that, please `see this page <https://pvoutput.org/help.html#overview-getting-started>`_ for more information.

In order to link DSMR-reader to your account, please write down the "API Key" and "System ID" from your PVOutput account. You can find them near the bottom of the "Settings" page in PVOutput.


.. image:: _static/faq/external_pvoutput_settings.png
:target: _static/faq/external_pvoutput_settings.png
.. image:: ../static/faq/external_pvoutput_settings.png
:target: ../static/faq/external_pvoutput_settings.png
:alt: PVOutput account settings


Expand All @@ -27,8 +18,8 @@ Enter those values in DSMR-reader's admin pages, at "PVOutput: API configuration
* System ID


.. image:: _static/faq/pvoutput_api.png
:target: _static/faq/pvoutput_api.png
.. image:: ../static/faq/pvoutput_api.png
:target: ../static/faq/pvoutput_api.png
:alt: API settings


Expand All @@ -38,10 +29,10 @@ Now navigate to another settings page in DSMR-reader: "PVOutput: "Add Status" co
* Choose an interval between the uploads. You can configure this as well on the PVOutput's end, in Device Settings.
* Optionally, choose an upload delay X (in minutes). If set, DSMR-reader will not use data of the past X minutes.
* Optionally, you can choose to enter a **processing delay in minutes** for PVOutput. Please note that PVOutput will only allow this when you have a **"Donation" account** on their website. If you do not have one, they will reject each API call you make, until you disable (clear) this option in DSMR-reader.
.. image:: _static/faq/pvoutput_add_status.png
:target: _static/faq/pvoutput_add_status.png
:alt: Add Status settings


.. image:: ../static/screenshots/admin/pvoutputaddstatussettings.png
:target: ../static/screenshots/admin/pvoutputaddstatussettings.png
:alt: PVOutput Add Status

If you configured everything correctly, you should see some addional data in PVOutput listed under "Your Outputs" momentarily.
8 changes: 8 additions & 0 deletions docs/admin/weather.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Admin: Weather
==============

Keep track of the temperatures outside using the Buienradar API.

.. image:: ../static/screenshots/admin/weathersettings.png
:target: ../static/screenshots/admin/weathersettings.png
:alt: Temperatures
8 changes: 4 additions & 4 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
API
===
API Documentation
=================
The application has an API allowing you to insert/create readings and retrieve statistics.


Expand All @@ -16,8 +16,8 @@ The API is disabled by default in the application. You may enable it in your con

Example
~~~~~~~
.. image:: _static/screenshots/admin_api_settings.png
:target: _static/screenshots/admin_api_settings.png
.. image:: static/screenshots/admin/apisettings.png
:target: static/screenshots/admin/apisettings.png
:alt: API admin settings

Authenticating
Expand Down
Loading

0 comments on commit a538b54

Please sign in to comment.