Skip to content

Commit

Permalink
make index specific to downstream project
Browse files Browse the repository at this point in the history
  • Loading branch information
schlimmchen committed Apr 8, 2024
1 parent 832c646 commit 938cb42
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,31 @@

![Logo](assets/images/logo.png){align=right}

## OpenDTU
## OpenDTU-OnBattery

Open Source software to talk to [Hoymiles][1]{target=_blank} solar inverters. It is an alternative to their DTUs[^1] which sync everthing into the s-Miles cloud.
!!! note "Upstream Project"

OpenDTU-OnBattery is a fork of [OpenDTU][4] by Thomas Basler (tbnobody).

Open Source software to talk to [Hoymiles][1]{target=_blank} solar inverters
and battery peripherals. It is an alternative to Hoymiles Data Transfer Units
(DTUs), which sync data into the s-Miles cloud.

!!! note "Note"

You can only use one DTU for a specific inverter. You cannot query a inverter with two DTUs. Mixing up multiple DTUs may lead to an unexpected behavior!
You can only use one DTU for a specific inverter. You cannot query an
inverter with two DTUs. Mixing up multiple DTUs may lead to unexpected
behavior!

## Key Features

## Remarkable features
* Dynamic Power Limiter to adjust one inverter's limit dynamically
* Power Meter interface to read the household power consumption
* Victron VE.Direct interface to communicate with Victron charge controllers
* Battery interface (JK BMS, Pylontech, Victron SmartShunt) to know a battery's state
* AC charger interface to control a Huawei AC charger

## Key Features inherited from the upstream project

* Read live data from inverter
* Show inverters internal event log
Expand All @@ -26,7 +42,7 @@ Open Source software to talk to [Hoymiles][1]{target=_blank} solar inverters. It
* Time zone support
* Ethernet support
* Prometheus API endpoint (/api/prometheus/metrics)
* English, german and french web interface
* English, German and French (partially translated) web interface
* Displays (SSD1306, SH1106, PCD8544)
* Status LEDs
* Configuration management (export / import configurations)
Expand All @@ -44,18 +60,17 @@ Open Source software to talk to [Hoymiles][1]{target=_blank} solar inverters. It

## Background

This project was started from [this](https://www.mikrocontroller.net/topic/525778){target=_blank} discussion (Mikrocontroller.net).
It was the goal to replace the original Hoymiles DTU (Telemetry Gateway) with their cloud access. With a lot of reverse engineering the Hoymiles protocol was decrypted and analyzed.
The upstream project was started from [a discussion on mikrocontroller.net](https://www.mikrocontroller.net/topic/525778){target=_blank}.
It's goal was to replace the original Hoymiles DTU (Telemetry Gateway), which uploads data to their cloud. With a lot of reverse engineering, the Hoymiles protocol was decrypted and analyzed.

## Support

For support using OpenDTU you can find us on Github or Discord:
For support using OpenDTU-OnBattery you can find us on Github or Discord:

[:material-github: Github Discussions][2]{target=_blank .md-button .md-button--primary }
[:fontawesome-brands-discord: Discord Chat][3]{target=_blank .md-button .md-button--primary }

[1]: https://www.hoymiles.com/
[2]: https://www.github.com/helgeerbe/OpenDTU-OnBattery/discussions
[3]: https://discord.gg/WzhxEY62mB

[^1]: Data Transfer Unit
[4]: https://github.com/tbnobody/OpenDTU

0 comments on commit 938cb42

Please sign in to comment.