search

Bouni / python-luxtronik

python-luxtronik is a library that allow you to interact with a Luxtronik heatpump controller.
MIT License
38 stars 20 forks source link

Make lookup of names easier for users #189

Open Bouni opened 5 days ago

Bouni commented 5 days ago

I think its not very easy for the user to figure out what name / id to use in the HA config.

@Guzz-T made that point in the discussion in #187 , that we should write the code in a way that makes it easy for the user to look the name up.

I propose that we add a GitHub Action that parses the code instead and create a static web page with a search field that we then host on GitHub pages for the users to look the right parameters up. That is in my eyes the better way to help the user than to write the code in a way that users can look up the needed nmes directly in the code.

gerw commented 5 days ago

I think we should also add some small piece of documentation for each parameter / calculation for which we know the meaning.