-
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
ed2cc57
commit 371015f
Showing
54 changed files
with
274 additions
and
931 deletions.
There are no files selected for viewing
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,15 @@ | ||
| # Admin settings: Dropbox | ||
|
|
||
| !!! abstract "For your information" | ||
|
|
||
| This is a feature using or integrating a **third party** and may or may not break along the years. | ||
|
|
||
| Usually this depends on the third party supporting it and the amount of (re)work needed in DSMR-reader to keep it backward/forward compatible. | ||
|
|
||
|
|
||
| !!! failure "Deprecated feature" | ||
|
|
||
| The Dropbox feature will be **dropped** from DSMR-reader in a future release. | ||
|
|
||
| Reworking DSMR-reader to a Docker/container-only setup allows for generic third party integrations more easily. | ||
| E.g. mounting the DSMR-reader backup by a Dropbox/OneDrive/GoogleDrive compatible container instead. |
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,14 @@ | ||
| # Admin settings: Email backup | ||
|
|
||
| !!! abstract "For your information" | ||
|
|
||
| This is a feature using or integrating a **third party** and may or may not break along the years. | ||
|
|
||
| Usually this depends on the third party supporting it and the amount of (re)work needed in DSMR-reader to keep it backward/forward compatible. | ||
|
|
||
| !!! failure "Deprecated feature" | ||
|
|
||
| The email feature will be **dropped** from DSMR-reader in a future release. | ||
|
|
||
| Reworking DSMR-reader to a Docker/container-only setup allows for generic third party integrations more easily. | ||
| E.g. mounting the DSMR-reader backup by another container instead that can dispatch email. |
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,15 @@ | ||
| # Admin settings: InfluxDB | ||
|
|
||
| !!! abstract "For your information" | ||
|
|
||
| This is a feature using or integrating a **third party** and may or may not break along the years. | ||
|
|
||
| Usually this depends on the third party supporting it and the amount of (re)work needed in DSMR-reader to keep it backward/forward compatible. | ||
|
|
||
| !!! failure "Deprecated feature" | ||
|
|
||
| The Dropbox feature will be **dropped** from DSMR-reader in a future release. | ||
|
|
||
| Reworking DSMR-reader to a Docker/container-only setup allows for generic third party integrations more easily. | ||
|
|
||
| E.g. creating a [plugin script using post-processing hooks](../../reference/plugins.md) or a container that reads the DSMR-reader API and passed it to InfluxDB instead. |
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,30 @@ | ||
| # Admin settings: MinderGas.nl | ||
|
|
||
| !!! abstract "For your information" | ||
|
|
||
| This is a feature using or integrating a **third party** and may or may not break along the years. | ||
|
|
||
| Usually this depends on the third party supporting it and the amount of (re)work needed in DSMR-reader to keep it backward/forward compatible. | ||
|
|
||
| Link your MinderGas.nl-account to have DSMR-reader upload your gas meter position daily. | ||
|
|
||
| !!! note | ||
|
|
||
| DSMR-reader transmits the **last reading of the previous day** to your account. | ||
|
|
||
| Also, to avoid overloading the MinderGas API by all DSMR-reader installations simultaneously, the export is **randomly** scheduled every night between 03:00 and 06:00. | ||
|
|
||
|  | ||
|
|
||
| Make sure you have a [Mindergas.nl](http://mindergas.nl) account or signup for one. | ||
| Now go to "**Meterstand API**" and click on the button located below "**Authenticatietoken**". | ||
|
|
||
|  | ||
|
|
||
| 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 when you have ticked the 'export' checkbox in the Mindergas.nl-configuration. | ||
|
|
||
| !!! question "Why not uploading old data?" | ||
|
|
||
| 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. |
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,41 @@ | ||
| # Admin settings: MQTT | ||
|
|
||
| [TOC] | ||
|
|
||
| The application has native support for MQTT. In the screen displayed below you can enter all information about the broker you're using. | ||
|
|
||
|  | ||
|
|
||
| There are multiple configurations available for sending MQTT messages to your broker. | ||
| You can enable them separately, 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: | ||
|
|
||
|  | ||
|
|
||
| The same data, but split among topics. This allows you to post a single piece of data on a separate topic: | ||
|
|
||
|  | ||
|
|
||
| ## Meter statistics | ||
|
|
||
| Statistics of your meter, split among topics: | ||
|
|
||
|  | ||
|
|
||
| ## Telegram | ||
|
|
||
| Telegram in JSON format: | ||
|
|
||
|  | ||
|
|
||
| Or split among topics: | ||
|
|
||
|  | ||
|
|
||
| Or in raw DSMR protocol format (when available): | ||
|
|
||
|  |
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,103 @@ | ||
| # Admin settings: Notifications | ||
|
|
||
| !!! abstract "For your information" | ||
|
|
||
| This is a feature using or integrating a **third party** and may or may not break along the years. | ||
|
|
||
| Usually this depends on the third party supporting it and the amount of (re)work needed in DSMR-reader to keep it backward/forward compatible. | ||
|
|
||
| Notifications on your phone using Prowl, Pushover or Telegram. | ||
|
|
||
| [TOC] | ||
|
|
||
| !!! note | ||
|
|
||
| Please note that DSMR-reader will reset and wipe notification settings **on any error**. | ||
|
|
||
| This may be perceived as annoying behaviour, but it prevents endless loops and notification spam in some unfortunate situations. | ||
|
|
||
|  | ||
|
|
||
| Currently, two mobile platforms are supported: Android and iOS. | ||
|
|
||
| * The supported apps for Android are [Pushover](https://pushover.net) and [Telegram](https://www.telegram.org). | ||
| * The supported apps for iOS are [Pushover](https://pushover.net), [Prowl](https://www.prowlapp.com) and [Telegram](https://www.telegram.org). | ||
|
|
||
| Make sure you either have Pushover, Prowl or Telegram 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. | ||
| For instruction on obtaining the API key, please read below. | ||
|
|
||
| In the DSMR-reader **Notifications Apps** settings, select the notification service you want to use. | ||
| Copy the API key from the notification service and paste in into the textbox for the API key. | ||
| When you save these settings, your first notification should be sent after midnight. | ||
| Don't worry about nightly alerts, the notifications will be sent with low priority and should not wake you up. | ||
|
|
||
|
|
||
| ## Pushover: How do I obtain my API key? | ||
|
|
||
| After you have downloaded Pushover and signed up for an account you should be able to login into your [Pushover](https://pushover.net) account. | ||
|
|
||
| You should see an overview of containing **Your User Key** (top right) and Applications, if you have any. | ||
| To create an application in Pushover, for sending notifications to your phone, please click **Create an Application/API Token**. | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| ## Prowl: How do I obtain my API key? | ||
|
|
||
| After you have downloaded Prowl and signed up for an account you should be able to log in into your [Prowl](https://www.prowlapp.com) account. | ||
|
|
||
| Now go to "API Keys", 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"**. | ||
|
|
||
|  | ||
|
|
||
| When a new key is generated, you will see it immediately. Your key is listed like in the screenshot below (the red box marks your API key). | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Telegram: How do I obtain my API key? | ||
|
|
||
| Please note that you can only use these notifications if you have your own (chat) bot with Telegram. | ||
|
|
||
| More information about bots [can be found here](https://core.telegram.org/bots). You will need the API key provided to you by the ``BotFather`` bot. | ||
|
|
||
| ## Telegram: How do I obtain the Chat ID? | ||
|
|
||
| You will also need the Chat ID to have the bot send messages to the right chat. | ||
|
|
||
| !!! hint | ||
|
|
||
| By default, bots are not allowed to contact anyone by themselves or see messages in a group. | ||
|
|
||
| So first make sure to send a message directly to the bot as human. | ||
| Or, if you added the bot in a group, make sure it has permissions to read messages in the group and then send a message in the group accordingly. | ||
|
|
||
| Any message the bot receives (or is allowed to see) is sent as update to the bot. | ||
| You can use the Telegram API in your browser to see the updates for your bot. | ||
| It will contain the Chat ID you're looking for. | ||
|
|
||
| Construct the following URL: | ||
|
|
||
| ``` | ||
| https://api.telegram.org/bot<APIkey>/getUpdates?offset=-1 | ||
| ``` | ||
|
|
||
| For example when using the fake API key ``1268827887:ABCDEFGqdtsgtts-JDASIJDqewqkqewaq``:: | ||
|
|
||
| ``` | ||
| https://api.telegram.org/bot1268827887:ABCDEFGqdtsgtts-JDASIJDqewqkqewaq/getUpdates?offset=-1 | ||
| ``` | ||
|
|
||
| You should see something similar to: | ||
|
|
||
|  | ||
|
|
||
| Extract the Chat ID from the response. In the example above it's ``123456789``. | ||
| You can use that ID in the Telegram notifications config of DSMR-reader. |
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,34 @@ | ||
| # Admin settings: PVOutput.org | ||
|
|
||
| !!! abstract "For your information" | ||
|
|
||
| This is a feature using or integrating a **third party** and may or may not break along the years. | ||
|
|
||
| Usually this depends on the third party supporting it and the amount of (re)work needed in DSMR-reader to keep it backward/forward compatible. | ||
|
|
||
| Make sure you have a [PVOutput.org](https://pvoutput.org) account, or signup for an account. | ||
| 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. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| Enter those values in DSMR-reader's admin pages, at "PVOutput: API configuration". Make sure to enter both: | ||
|
|
||
| * API Key | ||
| * System ID | ||
|
|
||
|  | ||
|
|
||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
| If you configured everything correctly, you should see some additional data in PVOutput listed under "Your Outputs" momentarily. |
File renamed without changes.
File renamed without changes.
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
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Oops, something went wrong.