Some community contributed Telegrams are now missing from library

[VlastiBroucek]

Hi @proddy ,

great idea moving the telegrams library to CSV file. However, it seems that some of contributed telegrams are now missing...

Just as an example from old version:

I could probably copy/paste them to csv file, but perhaps you have some automated system already and these have been somehow missed or you're already working on it?

Also, the old version stated to which device the telegram applies. I think it would be good to keep it, although, that makes the csv file solution bit more complicated... But maybe I am too fast and you're planning all this, just did not have time to implement?

[VlastiBroucek]

I have had a bit of time and built a local copy of the latest mkdocs based site and these telegrams are missing from the new library:
0x00FB
0x0165 - there seems to be two versions of this telegram, new library has only one of them (this also supports the need for some kind of header/explanation for each telegram)
0x02C3
0x02FF
0x0309
0x0449
0x0683
0x068D

I have attached them as UTF-8 csv file

telegrams.csv

[proddy]

Thanks, I'm not sure how these were missed. I'll go back and check my scripts. And yes, I'll add the headers back - just forgot that.

[VlastiBroucek]

Thank you!

I did think you would eventually include the headers etc, that's why I rather created the issue than fiddling with it myself.

[proddy]

made some improvements, it's building now. Let me know what you think!

[VlastiBroucek]

It looks good @proddy. I was never big fan of "accordions" in web page development, but IMHO they are ideal for things like this.

I would probably go even further and did nested accordions. I would create 5 of them (one for each category) and then have individual telegram accordions of each category inside of them. That way the page would be shorter for initial load and you could potentially get rid of the side bar and have more space for the tables, preventing need for horizontal scrolling.

I also looked at the site on my iPad and iPhone. The mobile version is not pretty. The "burger" menu comes up, but the top menu bar stays up and it looks messy.

Also, this seems to be hardcoded, so the ranges can quickly become obsolete (as they already are):

Finally, if I could, I would love to see horizontal scrolling arrow indicators on the sides of the tables. Some of them are very long and one has to scroll down to scroll horizontally and then scroll up aain etc... What I mean is something like this:

[Sbried]

I also would like to discuss the "Table of contents". I touched this shortly in a different discussion with @proddy .
Looking at all the telegrams I can´t see any structure or blocks how to group them in address ranges. It looks more that the developers of Bosch Home Comfort just take the next free address if they need a new telegram.
For me the "Table of Contents" is also somehow misleading, i.e. under "Basic Telegrams" are the error messages 0x0010 which I would expect to find under "Error and status telegrams".
=> I would just remove the "Table of Contents".
Can we discuss here (I think in this topic are only @VlastiBroucek , @proddy and me interested ;-) ) a basic structure that will be implemented?

I can imagine two structures that make sense to me:
1: a flat structure that lists the telegrams in ascending order. In this case the description of the telegram should be part of the header. This would look somehow like this:

2: like 1, but additionally grouped in address ranges. Maybe 0x0001 - 0x0100, 0x0101 - 0x0200, 0x0201 - 0x0300, .... as 1st level accordion (if technically possible) and then the telegrams itself as 2nd level.

I would go for the flat structure.
What is your opinion?

[VlastiBroucek]

To be honest, I am not too fussy about the format. Happy to have a flat structure as suggested above by @Sbried

On the other hand, I would rather see @proddy and/or @MichaelDvP spending time on entering "well known" telegrams (e.g. 0x04, 0x0A, 0x016 etc) in here. I know there is a document for it (in German) and lots of info in the source code, but with their knowledge it should be easier for them to document those telegrams here rather than for "community" trying to put them in. I started looking at them myself and will try to put some in, but that will need curating...

Anyway, that's just my 5c worth of wisdom, basically saying I'd prefer more content rather than cosmetic changes.

[Sbried]

To be honest, I am not too fussy about the format. Happy to have a flat structure as suggested above by @Sbried

On the other hand, I would rather see @proddy and/or @MichaelDvP spending time on entering "well known" telegrams (e.g. 0x04, 0x0A, 0x016 etc) in here. I know there is a document for it (in German) and lots of info in the source code, but with their knowledge it should be easier for them to document those telegrams here rather than for "community" trying to put them in. I started looking at them myself and will try to put some in, but that will need curating...

Anyway, that's just my 5c worth of wisdom, basically saying I'd prefer more content rather than cosmetic changes.

I want to enter more telegrams, but I would like to have the structure defined before to avoid later rework. That´s why started this discussion…

[VlastiBroucek]

I guess there won't need to be changes in the csv file - those 8 columns are probably set in concrete by now... So, IMHO, entering more telegrams should not be much problem. The only changes will need to be done to underlying code and maybe the telegram_metadata.json file...

Actually, there is one question I have for @proddy - does your underlying code expect the csv files to be ordered? What I mean is that if I want to add let's say 0x0006, do I have to make sure I put it in between 0x0005 and 0x0010 in current file, or can I just append it at the end of the file?

[proddy]

Just append it and I'll make sure it's sorted.

I also prefer the flat structure. I need to verify that the search crawler can still parse it.

Shall I go ahead and implement it?

[Sbried]

I just checked: It is possible to print the telegram description behind the telegram address.
I changed in TelegramTable.js line 133 to

So the flat structure should work like sketched above.
It would nice if you implement and check the crawler it. For me it would take more time....