Browse Source

improved phrasing of readme's

pull/859/head
lumapu 2 years ago
parent
commit
1bc2d2551c
  1. 16
      Getting_Started.md
  2. 6
      README.md

16
Getting_Started.md

@ -1,13 +1,12 @@
## Overview ## Overview
This page describes how the module of a Wemos D1 mini and ESP8266 is wired to the radio module and is flashed with the latest Firmware.<br/> On this page, you'll find detailed instructions on how to wire the module of a Wemos D1 mini or ESP32 to the radio module, as well as how to flash it with the latest firmware. This information will enable you to communicate with compatible inverters.
Further information will help you to communicate to the compatible inverters.
You find the full [User_Manual here](User_Manual.md) You find the full [User_Manual here](User_Manual.md)
## Compatiblity ## Compatiblity
For now the following Inverters should work out of the box: The following inverters are currently supported out of the box:
Hoymiles Inverters Hoymiles Inverters
@ -55,12 +54,11 @@ Solenso Inverters:
## Things needed ## Things needed
In order to build your own Ahoy DTU, you will need some things.<br/> If you're interested in building your own AhoyDTU, you'll need a few things to get started. While we've provided a list of recommended boards below, keep in mind that the maker community is constantly developing new and innovative options that we may not have covered in this readme..
This list is not closing as the Maker Community offers more Boards than we could cover in this Readme.<br/><br/>
We suggest to use a WEMOS D1 mini Board as well as a NRF24L01+ Breakout Board as a bare minimum.<br/> For optimal performance, we recommend using a Wemos D1 mini or ESP32 along with a NRF24L01+ breakout board as a bare minimum. However, if you have experience working with other ESP boards, any board with at least 4MBytes of ROM may be suitable, depending on your skills.
Any other ESP8266 Board with at least 4MBytes of ROM could work as well, depending on your skills and goals.<br/>
Make sure the NRF24L01+ module has the "+" in its name as we depend on the 250kbps features provided only with the plus-variant. Just be sure that the NRF24L01+ module you choose includes the "+" in its name, as we rely on the 250kbps features that are only provided by the plus-variant.
| **Parts** | **Price** | | **Parts** | **Price** |
| --- | --- | | --- | --- |
@ -70,7 +68,7 @@ Make sure the NRF24L01+ module has the "+" in its name as we depend on the 250kb
| Jumper Wire Steckbrücken Steckbrett weiblich-weiblich | 2,49 Euro | | Jumper Wire Steckbrücken Steckbrett weiblich-weiblich | 2,49 Euro |
| **Total costs** | **10,34 Euro** | | **Total costs** | **10,34 Euro** |
To also run our sister project OpenDTU and be upwards compatible for the future we would recommend to spend some more money on an ESP32 board which has two CPU cores and a NRF24L01+ module with external antenna. If you're interested in using our sister project OpenDTU or you want to future-proof your setup, we recommend investing in an ESP32 board that features two CPU cores. As Radio you can also use a NRF24L01+ module with an external antenna. While this option may cost a bit more, it will provide superior performance and ensure compatibility with upcoming developments.
| **Parts** | **Price** | | **Parts** | **Price** |
| --- | --- | | --- | --- |

6
README.md

@ -16,7 +16,7 @@ This work is licensed under a
# 🖐 Ahoy! # 🖐 Ahoy!
![Logo](https://github.com/grindylow/ahoy/blob/main/doc/logo1_small.png?raw=true) ![Logo](https://github.com/grindylow/ahoy/blob/main/doc/logo1_small.png?raw=true)
**Communicate with Hoymiles inverters via radio**. Get actual values like power, current, daily energy and set parameters like the power limit via web interface or MQTT. In this repository you will find different approaches means Hardware / Software to realize the described functionalities. This repository offers hardware and software solutions for communicating with Hoymiles inverters via radio. With our system, you can easily obtain real-time values such as power, current, and daily energy. Additionally, you can set parameters like the power limit of your inverter to achieve zero export. You can access these functionalities through our user-friendly web interface, MQTT, or JSON. Whether you're monitoring your solar panel system's performance or fine-tuning its settings, our solutions make it easy to achieve your goals.
Table of approaches: Table of approaches:
@ -43,9 +43,7 @@ Table of approaches:
- [The root of development](https://www.mikrocontroller.net/topic/525778) - [The root of development](https://www.mikrocontroller.net/topic/525778)
### Development ### Development
If you encounter issues use the issues here on github. If you run into any issues, please feel free to use the issue tracker here on Github. When describing your issue, please be as detailed and precise as possible, and take a moment to consider whether the issue is related to our software. This will help us to provide more effective solutions to your problem.
Please try to describe your issues as precise as possible and think about if this is a issue with the software here in the repository or other software components.
**Contributors are always welcome!** **Contributors are always welcome!**

Loading…
Cancel
Save