Master branch merge for v1.4.0 - 2016-11-28

.travis.yml

@@ -3,6 +3,7 @@ language: python
 python:
   - "3.3"
   - "3.4"
+  - "3.5"
 
 services:
   - postgresql
@@ -32,7 +33,7 @@ before_script:
   - sh -c "if [ '$DB' = 'mysql' ]; then mysqladmin create dsmrreader; fi"
 
 script: 
-  - ./manage.py test --noinput --with-coverage
+  - ./manage.py test --noinput
 
 after_success:
   - codecov

codecov.yml

@@ -0,0 +1,26 @@
+codecov:
+  notify:
+    require_ci_to_pass: true
+comment:
+  behavior: default
+  layout: header, diff
+  require_changes: false
+coverage:
+  precision: 2
+  range:
+  - 70.0
+  - 100.0
+  round: down
+  status:
+    changes: false
+    patch: true
+    project: true
+parsers:
+  gcov:
+    branch_detection:
+      conditional: true
+      loop: true
+      macro: false
+      method: false
+  javascript:
+    enable_partials: false

docs/HOWTO

@@ -0,0 +1,20 @@
+Running localhost docs server:
+
+- (cd into CURRENT folder first: cd docs)
+- sphinx-autobuild . _build/html -p 10000
+- Visit http://127.0.0.1:10000
+
+
+
+Updating translations after editing RST files: 
+
+- (cd into CURRENT folder first: cd docs)
+- make gettext && sphinx-intl update -p _build/locale -l nl
+
+
+
+Checking (Dutch) translations results by building locally:
+
+- (cd into CURRENT folder first: cd docs)
+- make -e SPHINXOPTS="-D language='nl'" html
+- view generated HTML in: docs/_build/html

docs/changelog.rst

@@ -2,6 +2,19 @@ Changelog
 =========
 
 
+v1.4.0 - 2016-11-28
+^^^^^^^^^^^^^^^^^^^
+- Push notifications for Notify My Android / Prowl (iOS), written by Jeroen Peters (`#152 <https://github.com/dennissiemensma/dsmr-reader/issues/152>`_).
+- Support for both single and high/low tariff (`#130 <https://github.com/dennissiemensma/dsmr-reader/issues/130>`_).
+- Add new note from Dashboard has wrong time format (`#159 <https://github.com/dennissiemensma/dsmr-reader/issues/159>`_).
+- Display estimated price for current usage in Dashboard (`#155 <https://github.com/dennissiemensma/dsmr-reader/issues/155>`_).
+- Dropbox API v1 deprecated in June 2017 (`#142 <https://github.com/dennissiemensma/dsmr-reader/issues/142>`_).
+- Support for Python 3.5 (`#55 <https://github.com/dennissiemensma/dsmr-reader/issues/55>`_).
+- Improve code coverage (`#151 <https://github.com/dennissiemensma/dsmr-reader/issues/151>`_).
+- Restyle configuration overview (`#156 <https://github.com/dennissiemensma/dsmr-reader/issues/156>`_).
+- Capability based push notifications (`#165 <https://github.com/dennissiemensma/dsmr-reader/issues/165>`_).
+
+
 v1.3.2 - 2016-11-08
 ^^^^^^^^^^^^^^^^^^^
 - Requirements update (november 2016) (`#150 <https://github.com/dennissiemensma/dsmr-reader/issues/150>`_).

docs/contributing.rst

@@ -2,16 +2,18 @@ Contributing
 ============
 Would you like to contribute or help this project in any way?
 
+
+Feedback
+--------
+All feedback and any input is, as always, very much appreciated! `Please create an issue on Github <https://github.com/dennissiemensma/dsmr-reader/issues/new>`_.
+
+It doesn't matter whether you run into problems getting started in this guide or just want to get in touch, just fire away!
+
+
 P1 telegram snapshot
 --------------------
 Please start by `creating an issue on Github <https://github.com/dennissiemensma/dsmr-reader/issues/new>`_ with a snapshot of a DSMR telegram. It will help me in improving support for multiple meter vendors and home situations.
 
 You can find the telegram by executing ``sudo supervisorctl tail -n 100 dsmr_datalogger`` on your DSMR-reader system.
 
 *You should omit your unique meter identification*, for privacy reasons, which are the lines starting with ``0-0:96.1.1`` or ``0-1:96.1.0``, followed by the meter ID, represented as a long string of many digits.
-
-Feedback
---------
-Also all feedback and any input is, as always, very much appreciated! `Please create an issue on Github <https://github.com/dennissiemensma/dsmr-reader/issues/new>`_.
-
-It doesn't matter whether you run into problems getting started in this guide or just want to get in touch, just fire away!

docs/credits.rst

@@ -41,8 +41,6 @@ Software
 
 - `Full Page Screen Capture <https://chrome.google.com/webstore/detail/full-page-screen-capture/fdpohaocaechififmbbbbbknoalclacl?>`_
 
-- `Twitter Bootstrap Wizard <https://github.com/VinceG/twitter-bootstrap-wizard>`_
-
 
 Testers & contributors
 ----------------------
@@ -53,6 +51,7 @@ Testers & contributors
 - "WatskeBart" (`Github profile <https://github.com/WatskeBart>`_)
 - `Gert Schaafsma <https://www.linkedin.com/in/gertschaafsma>`_
 - `Bert-Jan Vos <https://www.linkedin.com/in/bert-jan-vos-82011712>`_
+- Sevickson (`Github profile <https://github.com/sevickson>`_)
 
 
 DSMR help

docs/faq.rst

@@ -1,6 +1,17 @@
 Frequently Asked Questions (FAQ)
 ================================
 
+
+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. 
+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.
+
+This application displays separate tariffs by default, but supports merging them to a single one as well.
+Just make sure that you apply the **same price to both electricity 1 and 2** and enable the option '**Merge electricity tariffs**' in the frontend configuration.
+
+
 Dropbox: Automated backup sync
 ------------------------------
 *How can I link my Dropbox account for backups?*
@@ -46,11 +57,59 @@ Please note that due to policies of mindergas.nl it's not allowed to retroactive
 Therefor this is not supported by the application. You can however, enter them manually on their website. 
 
 
-Recalculate prices
-------------------
+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 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 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
+
+
+Recalculate prices retroactively
+--------------------------------
 *I've adjusted my energy prices but there are no changes! How can I regenerate them with my new prices?*
 
-You can flush your statistics by executing:
+Statistics for each day are generated once, the day after. However, you can flush your statistics by executing:
 
 ``./manage.py dsmr_stats_clear_statistics --ack-to-delete-my-data``
 

docs/installation.rst

@@ -13,7 +13,7 @@ Dependencies & requirements
 
  - Recommended and tested with, but any OS satisfying the requirements should do fine.
 
-- **Python 3.3 / 3.4**
+- **Python 3.3 / 3.4 / 3.5**
 - **PostgreSQL 9+ or MySQL / MariaDB 5.5+**
 
  - I highly recommend *PostgreSQL* due to builtin support for timezones.