Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some explanation to the panel #68

Open
DenisMir opened this issue Jun 8, 2023 · 6 comments
Open

Add some explanation to the panel #68

DenisMir opened this issue Jun 8, 2023 · 6 comments
Labels
📜 documentation Improvements or additions to documentation 💡 feature request Feature request

Comments

@DenisMir
Copy link

DenisMir commented Jun 8, 2023

It would be helpful if there would be some explanation what this panel does. E.g. I had configured everything manually and I don't have a clue what happens when importing the ETS project file. I don't want to mess up this setup. So some explanation in the panel would be helpful to give users a hint about what it does in detail.

@farmio
Copy link
Member

farmio commented Jun 8, 2023

Good idea, documentation is always welcome.

Currently, and probably in the future too, we will not alter any manual configured settings without letting you know beforehand or manually start the process.

The project data is currently only used for

  • group monitor and
  • device trigger selector

The extracted data is stored in /config/.storage/knx/project.json. We can, if we don't need additional infos we didn't think about, use this later for things that are currently not implemented yet. So at this point we don't know what the data will be used for in 4 months 😃

@DenisMir
Copy link
Author

DenisMir commented Jun 8, 2023

Thank you very much for the explanation. So to sum it up the import isn't harmful for the manually configured setup at the moment right? Thanks anyway for the implementation.

@Merc3nary
Copy link

Great integration to begin with.
I have configured everything manually as well and I can only see adresses in the columns, but no device names. Where would it pick those up or how would I have to do the configuration so that it knows what the address belongs to?

If I would upload the ETS project now...what would happen?

Thanks and regards,

Merc

@farmio
Copy link
Member

farmio commented Jun 8, 2023

@DenisMir uploading, replacing (uploading when you already have uploaded) or even deleting project data is 100% non-destructive (currently at least). The manual setup isn't touched in any way.

The only thing that would change is in device triggers: the trigger data relies on project data. So if you used the new device triggers (KNX Interface device) and you matched, say a decoded value in a template - this would not be decodable after you deleted the project data.

@Merc3nary if you upload your project file you would see the address text and value columns as your installation can access that data then.

@Pistol-Peet
Copy link

Hi Guys, first off: Thanks for this particular frontend feature.
It certainly brings a value to the overall integration!

I´d like to know which ETS version was tested for the export of the project file to be uploaded.
I am running with an old version (ETS4) as some devices plugins are not compatible with 5 or 6.

Exporting the .knxproj file from it and uploading it into KNX frontend, resulted in an error.
I am not 100% sure, but it looked like it was not happy with the language being set as "de". I assume it was expecting "de-DE" ?

Is there a specific way the project file needs to be written as/in?
Best,
peet

@farmio
Copy link
Member

farmio commented Jun 10, 2023

Hi 👋 @Pistol-Peet !
It was developed and tested with ETS 5 and 6. Using "de" instead of "de-DE" is intended and should be handled properly by xknxproject.
Please open an issue (maybe at https://github.com/XKNX/xknxproject/issues) containing (debug) logs describing the error.

@farmio farmio added 📜 documentation Improvements or additions to documentation 💡 feature request Feature request labels Jun 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 documentation Improvements or additions to documentation 💡 feature request Feature request
Projects
None yet
Development

No branches or pull requests

4 participants