search

Egyras / HeishaMon

Panasonic Aquarea air-water H, J, K and L series protocol decrypt
238 stars 120 forks source link

Add design decision(s) to documentation #519

Closed mi-hol closed 2 weeks ago

mi-hol commented 1 month ago

Issue: I'm very new to HeishaMon but have already seen a number of issues that seem caused from a lack of understanding HeishaMon's architecture, design goals and limitations.

Proposal:

Therefore I'd suggest to add HeishaMon's architecture, design goals and limitations to main ReadMe. As a second activity I'd suggest to split the the current main ReadMe in multiple files (i.e. Rules)

Benefits:

Examples:

geduxas commented 1 month ago

As gateway is mostly finished product.. almost all telemetry is well decoded and published.. so almost All issues could be within small fixes, or unimportant.. as for model naming in telemetry.. truly Panasonic don't have exect model mame or numeber in telemetry.. it have some kind of firmwar/configuration checksums which mostly corespondents to pump type.. but as much we knowt about it.. more we see same pump's with bit different ID's..

mi-hol commented 1 month ago

@geduxas thanks for the comment, unfortunately I don't get what you are trying to tell me. I'm a simple guy, preferring simple yes/no answers :)

geduxas commented 1 month ago

@geduxas thanks for the comment, unfortunately I don't get what you are trying to tell me. I'm a simple guy, preferring simple yes/no answers :)

Sorry :) your welcome to know whis project better, and understand everything soon i think. Yes it's missing some documentation, and yes it requires a little bit advanced experience.. simply it's HeatPump<->MQTT gateway.. so everything what pump spits to interface is translated and published into MQTT..

Maybe you could contribute this project and help with documentation? From andvanced user's, it's seam's everything simple and we'll known.. but yes for newcomers it's bit confusing. For my self, i have HeatPump for over 3y, also tried to reverse engineering protocol, and native a2w gateway.

mi-hol commented 1 month ago

Maybe you could contribute this project and help with documentation?

Happy to do so and made already some small contributions

mi-hol commented 1 month ago

@Egyras @IgorYbema may I kindly ask for your view on my proposal? Wanted to avoid investing time into a topic that is not seen as adding value by the main drivers of project

github-actions[bot] commented 3 weeks ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.