-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
07a8d78
commit a538b54
Showing
221 changed files
with
6,303 additions
and
4,034 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.