search

lumapu / ahoy

Various tools, examples, and documentation for communicating with Hoymiles microinverters
https://ahoydtu.de
Other
948 stars 222 forks source link

Documentation: Please add ESP32 WROOM 30Pin Layout to readme #818

Open rmayergfx opened 1 year ago

rmayergfx commented 1 year ago

Already a solution here: https://github.com/lumapu/ahoy/issues/683 Hard to find for new users. Please add to redme/docu

Argafal commented 1 year ago

I'm not entirely sure what problem you are trying to solve here. For the most common boards there are wiring diagrams already. Did you see those? The default settings of the latest Ahoy release match those diagrams. When starting from a fresh configuration in any dev version, the defaults will also match.

I am guessing this is still about https://github.com/lumapu/ahoy/issues/812. But really, this only affects developers who are staying up to date with the latest code changes on a daily basis. For me personally, I wouldn't feel it's worth putting a lot of effort into improvements there, as this is a brief hiccup only affecting bleeding-edge users and since this is easily resolved by resetting the device once. Additionally, your issue #812 nicely documents the required steps for setting the default pins a-new. The issue just needs a name that is easy to find for anyone who runs into the same issue.

If you feel very strongly about it, maybe you could work out some specific improvements to the documentation and/or code and post them here (or as a pull request)? I bet contributions will be most welcome :)

markusdd commented 1 year ago

This has been done in this PR already. https://github.com/lumapu/ahoy/pull/814/files

rmayergfx commented 1 year ago

@Argafal No your guess is total wrong. Give someone who has found the information about AhoyDTU or OpenDTU via google and wants to setup his own device. He buys an ESP32 and there are different boards online. 38Pin, 30Pin. So when you go on the Readme.md, you will find only an esp8266 and ESP32 with 38Pin, but if you get e.g. an ESP32-Wroom recommended by some people, they will stuck on the wiring and are confused because of only 30Pin and different wiring. believe me, i was asked about the wiring from a newbie with not much experience and he was confused about the setup. It is not easy to find the wiring diagramms :-(

markusdd commented 1 year ago

For this OpenDTU provides device profile files.

Ahoy has no such mechanism (yet), but in it's documentation provides guidance to buy very SPECIFIC boards. If you decide to deviate from that, you are on your own right now. If you feel so strongly about supporting documentation for another board, there is a good opportunity to draw the pictures and submit a PR, just like I did to support SPI selection at all and to enhance the docs about this change.

This is a community effort and no one is employed for this. Your statement is valid, there are no docs for the 30pin modules. So: Please provide this documentation. (I cannot do it, I do not own one of these)

rmayergfx commented 1 year ago

The documentation for 30Pin is already done in #683 just needs to copy this to documentiation to easier find this.

btw. i can´t find a recommandation which board to buy! In Getting_started.md'thins-needed everyone find "ESP32 Dev Board NodeMCU WROOM32 WiFi", finding with your favourite search engine you will end on different sites and see most of them have only 30Pins. Inside the wiki i can´t find any information. The informations are available across all platforms, but it is hard to find them. Some are in Readme.md, some in Getting_Started.md, a few inside Wiki, also on Discord are good informations. It would be helpful to have a singel point where the basics are collected.

How long do you think was my search when i started with AhoyDTU to find the information about wiring a display and why it is not working with the default web setup. in the deep of the web i found with a search engine the entry to install a dev. Version to get the display running. Why not posting the information on the homepage that the stable version that will install via web installer does not support a display out of the box?

I like to help and i am writing about things every newbie is fighting with.

Argafal commented 1 year ago

Feels like we all need to take a deep breath. :) I want to try to suggest a constructive way forward.

I agree that the documentation can be improved. The information isn't always very clear and sometimes a bit scattered. I can appreciate that it's not so easy for someone who's just starting.

@rmayergfx: I wonder, would you be able to do the following: make a copy of any webpage content, readme file, documentation text, picture that you feel should be improved. And can you change them? And then you post them here, or you make a pull request out of the files. I'll volunteer to help you get these changes integrated. But someone needs to work out the exact new text and where it goes. Maybe your recent (admittedly frustrating) experience can be really useful for that. :)

rmayergfx commented 1 year ago

Would be very helpful to clearify first of all together with @lumpau and other people working on this to get a useful and good solution where to post or insert the missing data. Should we expand the wiki in the Hardware Section and put a link on all other Readme and Getting startet files just to keep them small and collect all important data inside the wiki ? Or is it necessary to put some information into the get started?

I think it should be splitted into 2 different main topics. on the info side there should be the information what kind of inverters are supported. This list can be upgraded, i think there will not be too much changes in the future.

Hardware should explain the ESP8266 and ESP32 Mainboards, with a sub for the nrf24l01+ and important warnings about fakes and how to identify them (just as goodie)

Software should inform about stable and nightliys and what is working an not and this should be the main topic with all explanations what is going on and planned.

If the place and strukture is defined, we can go on with the information, would also be a good time to setup the wiki in german and english, if possible on github.

Argafal commented 1 year ago

From my side: sounds good, please go ahead as you suggested! :+1:

As to the question about the where: You were the one who said that the information wasn't where you were looking for. So I think you should make specific suggestions how to change the places where you actually looked (and didn't find what you needed).

stefan123t commented 8 months ago

This is similar to #762 please double check whether this is already addressed there ?