[broadlink] Update README

[microneer]

[broadlink] Improvements to Broadlink binding documentation

Description

Documentation improvement to help new users. Clarify some aspects, add context, correct a few spelling mistakes.

[jlaur]

@kaikreuzer - can you add @dag81 to the contributors team as creator and maintainer of the Broadlink binding?

[jlaur]

@kaikreuzer - can you add @dag81 to the contributors team as creator and maintainer of the Broadlink binding?

I'm a bit confused. The binding was contributed in #16273 by @AntonJansen (Anton Jansen). Most files were originally contributed by John Marshall and Cato Sognen (I don't know their GitHub user names). And @dag81 (David Goodyear) was added as binding maintainer in #17833. @wborn, do you remember why? And @AntonJansen - perhaps you can help answering the question who should be maintainers, I assume you should at least be on the list?

[dag81]

Hi, yeah I have not contributed to that binding once so not likely the best person to have as a maintainer for it.

…

On Sun, 5 Jan 2025 at 10:47, Jacob Laursen ***@***.***> wrote: @kaikreuzer <https://github.com/kaikreuzer> - can you add @dag81 <https://github.com/dag81> to the contributors team as creator and maintainer of the Broadlink binding? I'm a bit confused. The binding was contributed in #16273 <#16273> by @AntonJansen <https://github.com/AntonJansen> (Anton Jansen). Most files were originally contributed by John Marshall and Cato Sognen (I don't know their GitHub user names). And @dag81 <https://github.com/dag81> (David Goodyear) was added as binding maintainer in #17833 <#17833>. @wborn <https://github.com/wborn>, do you remember why? And @AntonJansen <https://github.com/AntonJansen> - perhaps you can help answering the question who should be maintainers, I assume you should at least be on the list? — Reply to this email directly, view it on GitHub <#18039 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGBCTQYXBBRLAK6GG6K57F32JEEVNAVCNFSM6AAAAABUTXRKXWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNZRGU4DENBWGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[jlaur]

Hi, yeah I have not contributed to that binding once so not likely the best person to have as a maintainer for it.

I think it might have been a copy'n'paste mistake in #17833, since you contributed both metofficedatahub and linktap. So you should still be added to the contributors team, but we also need to fix the maintainer list for broadlink. 🙂

[AntonJansen]

John Marshall and Cato Sognen created the original broadlink binding for openhab (in the openhab 2.x time). However, their work was never merged with the mainline nor maintained post 3.3.4. I took the work on me to finally after many years to bring the code to the mainline and update it accordingly. Ricardo Larranaga (@rlarranaga) helped me out a lot with doing this work. However, he has not been active the last 7-8 months. I'm happy to be one of the maintainers, if anybody else wants to help out that would be great.

With respect to the naming, I suggest we make the name of the broadlink thermostat binding also clear in the documentation. So rename it from broadlink to broadlink thermostat, as to be in-line with the code. I had already one user that was confused due to this naming collision.

[jlaur]

I'm happy to be one of the maintainers, if anybody else wants to help out that would be great.

Thanks for the clarification. I've created #18044 for fixing the CODEOWNERS file so you'll be listed as maintainer. @kaikreuzer - can you also add @AntonJansen to the contributors team?

@AntonJansen - now that we've correctly established you as binding maintainer, can you have a look at the README update in this PR and comment if there are any issues, or approve if everything looks good to you? 😉

With respect to the naming, I suggest we make the name of the broadlink thermostat binding also clear in the documentation.

This should be addressed by #17909 already.

[AntonJansen]

This pull request looks good. It brings some good modifications and clarifications to the documentation. Please merge!

[lsiepel]

Thanks, LGTM