fix: project's name is 'OpenDTU-OnBattery' (capital 'O')
there were 47 matches in the repo for "OnBattery", but only 17 for "onBattery". Also, the repo's name on github uses a capital 'O'.
This commit is contained in:
Bernhard Kirchen
parent
bdc9c09db2
commit
6ab1b41f78
22
README.md
22
README.md
@ -1,23 +1,23 @@
|
||||
- [OpenDTU-onBattery](#opendtu-onbattery)
|
||||
- [What is OpenDTU-onBattery](#what-is-opendtu-onbattery)
|
||||
- [OpenDTU-OnBattery](#opendtu-onbattery)
|
||||
- [What is OpenDTU-OnBattery](#what-is-opendtu-onbattery)
|
||||
- [History of the project](#history-of-the-project)
|
||||
- [Highlights of OpenDTU-onBattery](#highlights-of-opendtu-onbattery)
|
||||
- [Highlights of OpenDTU-OnBattery](#highlights-of-opendtu-onbattery)
|
||||
- [Documentation](#documentation)
|
||||
- [Acknowledgment](#acknowledgment)
|
||||
|
||||
# OpenDTU-onBattery
|
||||
# OpenDTU-OnBattery
|
||||
|
||||
This is a fork from the Hoymiles project [OpenDTU](https://github.com/tbnobody/OpenDTU).
|
||||
|
||||
|
||||
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/build.yml)
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/build.yml)
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/cpplint.yml)
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/yarnlint.yml)
|
||||
|
||||
## What is OpenDTU-onBattery
|
||||
## What is OpenDTU-OnBattery
|
||||
|
||||
OpenDTU-onBattery is an extension of the original OpenDTU to support battery chargers, battery management systems (BMS) and power meters on a single esp32. With the help of a dynamic power limiter, the power production can be adjusted to the actual consumption. In this way, it is possible to come as close as possible to the goal of zero feed-in.
|
||||
OpenDTU-OnBattery is an extension of the original OpenDTU to support battery chargers, battery management systems (BMS) and power meters on a single esp32. With the help of a dynamic power limiter, the power production can be adjusted to the actual consumption. In this way, it is possible to come as close as possible to the goal of zero feed-in.
|
||||
|
||||
## History of the project
|
||||
|
||||
@ -25,7 +25,7 @@ The original OpenDTU project was started from [this](https://www.mikrocontroller
|
||||
|
||||
Summer 2022 I bought my Victron MPPT battery charger, and didn't like the idea to set up a separate esp32 to recieve the charger data. I decided to fork OpenDTU and extend it with battery charger support and a dynamic power limitter to my own needs. Hoping someone can make use of it.
|
||||
|
||||
## Highlights of OpenDTU-onBattery
|
||||
## Highlights of OpenDTU-OnBattery
|
||||
|
||||
This project is still under development and adds following features:
|
||||
|
||||
@ -40,11 +40,11 @@ This project is still under development and adds following features:
|
||||
|
||||
## Documentation
|
||||
|
||||
[Full documentation of OpenDTU-onBattery extensions can be found at the project's wiki](https://github.com/helgeerbe/OpenDTU-OnBattery/wiki).
|
||||
[Full documentation of OpenDTU-OnBattery extensions can be found at the project's wiki](https://github.com/helgeerbe/OpenDTU-OnBattery/wiki).
|
||||
|
||||
For documentation of openDTU core functionality I refer to the original [repo](https://github.com/tbnobody/OpenDTU) and its [documentation](https://tbnobody.github.io/OpenDTU-docs/).
|
||||
|
||||
Please note that openDTU-onBattery may change significantly during its development.
|
||||
Please note that openDTU-OnBattery may change significantly during its development.
|
||||
Bug reports, comments, feature requests and fixes are most welcome!
|
||||
|
||||
To find out what's new or improved have a look at the [changelog](https://github.com/helgeerbe/OpenDTU-OnBattery/releases).
|
||||
@ -53,4 +53,4 @@ To find out what's new or improved have a look at the [changelog](https://github
|
||||
|
||||
A special Thank to Thomas Basler (tbnobody) the author of the original [OpenDTU](https://github.com/tbnobody/OpenDTU) project. You are doing a great job!
|
||||
|
||||
Last but not least, I would like to thank all the contributors. With your ideas and enhancements, you have made OpenDTU-onBattery much more than I originally had in mind.
|
||||
Last but not least, I would like to thank all the contributors. With your ideas and enhancements, you have made OpenDTU-OnBattery much more than I originally had in mind.
|
||||
|
||||
@ -6,7 +6,7 @@ This is a fork from the Hoymiles project [OpenDTU](https://github.com/tbnobody/O
|
||||
|
||||
> **Warning**
|
||||
>
|
||||
> In contrast to the original openDTU, with release 2023.05.23.post1 openDTU-onBattery supports only 5 inverters. Otherwise, there is not enough memory for the liveData view.
|
||||
> In contrast to the original openDTU, with release 2023.05.23.post1 openDTU-OnBattery supports only 5 inverters. Otherwise, there is not enough memory for the liveData view.
|
||||
|
||||
## Features
|
||||
|
||||
@ -106,7 +106,7 @@ Some points for consideration are:
|
||||
|
||||
#### Operation modes
|
||||
|
||||
openDTU-onBattery supports three operation modes for the Huawei PSU:
|
||||
openDTU-OnBattery supports three operation modes for the Huawei PSU:
|
||||
1. Fully manual - In this mode the PSU needs to be turned on/off externally using MQTT and voltage and current limits need to be provided. See [MQTT Documentation](docs/MQTT_Topics.md) for details on these commands
|
||||
2. Manual with auto power on / off - In this mode the PSU is turned on when a current limit > 1A is set. If the current limit is < 1A for some time the PSU is turned off. Current and voltage limits need to be provided externally using MQTT. See [MQTT Documentation](docs/MQTT_Topics.md) for details on these commands.
|
||||
3. Automatic - In this mode the PSU power is controlled by the Power Meter and information provided in the web-interface. If excess power is present the PSU is turned on. The voltage limit is set as per web-interface and the current limit is set so that the maximum PSU output power equals the Power Meter value. Minium and maximum PSU power levels as configured in the web-interface are respected in this process. The PSU is turned off if the output current is limited and the output power drops below the minium power level. This will disable automatic mode until the battery is discharged below the start voltage level (set in the web-interface). This mode can be enabled using the web-interface and MQTT. See [MQTT Documentation](docs/MQTT_Topics.md)
|
||||
@ -135,7 +135,7 @@ It was the goal to replace the original Hoymiles DTU (Telemetry Gateway) with th
|
||||
|
||||
### Status
|
||||
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/build.yml)
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/build.yml)
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/cpplint.yml)
|
||||
[](https://github.com/helgeerbe/OpenDTU-OnBattery/actions/workflows/yarnlint.yml)
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
This documentation will has been moved and can be found here: <https://tbnobody.github.io/OpenDTU-docs/firmware/device_profiles/>
|
||||
|
||||
## Structure of the json file for openDTU-onBattery (outdated example)
|
||||
## Structure of the json file for openDTU-OnBattery (outdated example)
|
||||
|
||||
```json
|
||||
[
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<link rel="apple-touch-icon" href="/favicon.png">
|
||||
<link rel="manifest" href='/site.webmanifest' />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>OpenDTU-onBattery</title>
|
||||
<title>OpenDTU-OnBattery</title>
|
||||
</head>
|
||||
<body>
|
||||
<noscript>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
<BIconSun v-else width="30" height="30" class="d-inline-block align-text-top text-warning" />
|
||||
|
||||
<span style="margin-left: .5rem">
|
||||
OpenDTU-onBattery
|
||||
OpenDTU-OnBattery
|
||||
</span>
|
||||
<span class="text-info">
|
||||
<BIconBatteryCharging width="20" height="20" class="d-inline-block align-text-center" />
|
||||
|
||||
Loading…
Reference in New Issue
Block a user