Skip to content

Commit

Permalink
update doc (#215)
Browse files Browse the repository at this point in the history
  • Loading branch information
henne49 authored Aug 15, 2024
1 parent f7ef8d2 commit d3c9ef5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# dbus-opendtu

> **Attention:**
> ️For any problems with OpenDTU prior v4.4.3 version, please update to the latest code where most Issues are fixed. OpenDTU changed the API. The same applies to AhoyDTU.⚠️
> ️Please Update your Installation to latest stable version log file handling⚠️
## Table of contents

Expand Down Expand Up @@ -29,6 +29,7 @@
- [How does it work](#how-does-it-work)
- [Pictures](#pictures)
- [Tested Devices](#tested-devices)
- [Frequently asked Questions](#frequently-asked-questions)
- [Troubleshooting](#troubleshooting)
- [Security settings in OpenDTU](#security-settings-in-opendtu)
- [Inspiration](#inspiration)
Expand Down Expand Up @@ -113,7 +114,7 @@ Within the project there is a file `/data/dbus-opendtu/config.ini`. Most importa
|-------------------- | ------------- |
| SignOfLifeLog | Time in minutes how often a status is added to the log-file `current` with log-level INFO |
| NumberOfTemplates | Number ob Template Inverter to query |
| DTU | Which DTU to be used ahoy, opendtu or template REST devices Valid options: opendtu, ahoy, template |
| DTU | Which DTU to be used ahoy, opendtu or template REST devices Valid options: opendtu, ahoy, template. template is template only, ahoy and opendtu can use a dtu and templates together.|
| NumberOfInvertersToQuery | Number of Inverters to query. Set a value larger than "0" when not all inverters should be considered. *1 |
| useYieldDay | send YieldDay instead of YieldTotal. Set this to 1 to prevent VRM from adding the total value to the history on one day. E.g. if you don't start using the inverter at 0. |
| ESP8266PollingIntervall | For ESP8266 reduce polling intervall to reduce load, default 10000ms|
Expand Down Expand Up @@ -353,6 +354,14 @@ All [configuration](#configuration) is done via config.ini. Examples are comment

---

## Frequently asked questions

Frequently asked questions:
* **Can I use multiple instances?** - YES, but limit the usage to a minimal level and check the stability of your system for free space on your device and load. Also remeber, that templates can be queried together with a single dtu, no need for another instance.
* **Do I need multiple instances to query a DTU and templates?** - NO, templates can be queried together with a single dtu, no need for another instance. But limit the usage of templates and check the stability of your system.

---

## Troubleshooting

Please open a new issue on github, only here we can work on your problem in a structured way: <https://github.com/henne49/dbus-opendtu/issues/new/choose>
Expand Down
2 changes: 1 addition & 1 deletion config.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ SignOfLifeLog= 1
# Number ob Template Inverter to query
NumberOfTemplates=0

# Which DTU to be used ahoy, opendtu, template
# Which DTU to be used ahoy, opendtu, template. template is template only, ahoy and opendtu can use a dtu and templates together.
DTU=opendtu

# If you want to exclude Inverter, specify how many of the Inverters you want to query.
Expand Down

0 comments on commit d3c9ef5

Please sign in to comment.