Skip to content

Commit

Permalink
v1.10.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@dennissiemensma
dennissiemensma committed Oct 19, 2017
1 parent 3b9f4e5 commit 3a001e7
Show file tree
Hide file tree
Showing 43 changed files with 1,701 additions and 1,810 deletions.
19 changes: 19 additions & 0 deletions docs/changelog.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,25 @@ Please make sure you have a fresh **database backup** before upgrading! Upgradin



v1.10.0 - 2017-10-19
^^^^^^^^^^^^^^^^^^^^

.. note::

This releases turns telegram logging **off by default**.
If you wish to continue using this feature, add ``DSMRREADER_LOG_TELEGRAMS = True`` to your ``settings.py`` and reload the application.


**Tickets resolved in this release:**

- [`#363 <https://github.com/dennissiemensma/dsmr-reader/issues/363>`_] Show electricity_merged in the Total row for current month - by helmo
- [`#305 <https://github.com/dennissiemensma/dsmr-reader/issues/305>`_] Trend staafdiagrammen afgelopen week / afgelopen maand altijd gelijk
- [`#194 <https://github.com/dennissiemensma/dsmr-reader/issues/194>`_] Add timestamp to highest and lowest Watt occurance
- [`#365 <https://github.com/dennissiemensma/dsmr-reader/issues/365>`_] Turn telegram logging off by default
- [`#366 <https://github.com/dennissiemensma/dsmr-reader/issues/366>`_] Restructure docs



v1.9.0 - 2017-10-08
^^^^^^^^^^^^^^^^^^^

Expand Down
1 change: 1 addition & 0 deletions docs/credits.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Listed in any order, sorted by name.
- `Bert-Jan Vos <https://www.linkedin.com/in/bert-jan-vos-82011712>`_
- `dajappie <https://github.com/dajappie>`_
- `Daniel ter Horst <https://www.linkedin.com/in/danielterhorst>`_
- `dbmnl <https://github.com/dbmnl>`_
- `emilkwaaitaal <https://github.com/emilkwaaitaal>`_
- `fpompert <https://github.com/fpompert>`_
- `Gert Schaafsma <https://www.linkedin.com/in/gertschaafsma>`_
Expand Down
33 changes: 33 additions & 0 deletions docs/dropbox.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Integration: Dropbox
====================


.. contents::
:depth: 2


Dropbox: Automated backup sync
------------------------------
*How can I link my Dropbox account for backups?*

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.
122 changes: 5 additions & 117 deletions docs/faq.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,143 +33,31 @@ It will make sure to check, fetch and apply any changes released. Summary of dep

Dropbox: Automated backup sync
------------------------------
*How can I link my Dropbox account for backups?*

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.
:doc:`More information can be found here<dropbox>`.


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
:alt: Mindergas API

Copy the authentication token generated and paste in into the DSMR-reader settings for the Mindergas.nl-configuration.
Obviously the export only works when there are any gas readings at all and you have ticked the 'export' checkbox in the Mindergas.nl-configuration as well.

.. note::

Please note that due to policies of mindergas.nl it's not allowed to retroactively upload meter positions using the API.
Therefor this is not supported by the application. You can however, enter them manually on their website.
:doc:`More information can be found here<mindergas>`.


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

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
:alt: PVOutput account settings


Enter those values in DSMR-reader's admin pages, at "PVOutput: API configuration". Make sure to enter both:

* API Key
* System ID


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


Now navigate to another settings page in DSMR-reader: "PVOutput: "Add Status" configuration".

* Enable uploading the consumption.
* 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

If you configured everything correctly, you should see some addional data in PVOutput listed under "Your Outputs" momentarily.
:doc:`More information can be found here<pvoutput>`.


Usage notification: Daily usage statistics on your smartphone
-------------------------------------------------------------
*Which services for sending notifications are supported?*

Currently, two mobile platforms are supported: Android and iOS.
The supported app for Android is `NotifyMyAndroid <https://www.notifymyandroid.com>`_.
The supported app for iOS is `Prowl <https://www.prowlapp.com>`_.


*How do I setup usage notifications?*

Make sure you either have NotifyMyAndroid 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 notificationservice that you prefer. For instruction on obtaining the API key, please read below.

In the DSMR-reader settings for the Usagenotifications, tick the Send Notifications checkbox and select the notification service you want to use. Then copy the API key from the notification service and paste in into the the textbox for the API key. When you save these settings, your first notification should be sent after midnight. Don't worry, the notification will be sent with low priority and will not wake you up.


*How do I obtain my API key for NotifyMyAndroid?*

After you have downloaded NotifyMyAndroid and signed up for an account you should be able to `login to your NotifyMyAndroid account <https://www.notifymyandroid.com/index.jsp>`_.
Now go to "`My Account <https://www.notifymyandroid.com/account.jsp>`_", you should see an overview of your current API keys if you have any. To create an API key for the DSMR-reader, please click **"Generate New Key"**.

.. image:: _static/faq/notifications-notify-my-android-create-key.png
:target: _static/faq/notifications-notify-my-android-create-key.png
:alt: NotifyMyAndroid 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-notify-my-android-get-key.png
:target: _static/faq/notifications-notify-my-android-get-key.png
:alt: NotifyMyAndroid Get Your API Key


*How do I obtain my API key for Prowl?*

After you have downloaded Prowl and signed up for an account you should be able to `login to your Prowl account <https://www.prowlapp.com/login.php>`_.
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
: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
:alt: Prowl Get Your API Key
:doc:`More information can be found here<notifications>`.


I only pay for a single electricity tariff but I see two!
---------------------------------------------------------
DSMR (and your energy supplier) always read both high and low tariff from your meter.
DSMR (and your energy supplier) always reads both high and low tariff from your meter.
It's possible however that you are only paying for a single tariff.
In that case your energy supplier will simply merge both high and low tariffs to make it look like you have a single one.

Expand Down
6 changes: 5 additions & 1 deletion docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,12 @@ DSMR Reader's documentation
settings
api
mqtt
troubleshooting
mindergas
pvoutput
dropbox
notifications
faq
troubleshooting
changelog
contributing
credits
Expand Down
Loading

0 comments on commit 3a001e7

Please sign in to comment.