Skip to content

Improve the README.md#260

Merged
kbabioch merged 2 commits into
Bouni:mainfrom
Guzz-T:try/readme
Mar 14, 2026
Merged

Improve the README.md#260
kbabioch merged 2 commits into
Bouni:mainfrom
Guzz-T:try/readme

Conversation

@Guzz-T
Copy link
Copy Markdown
Contributor

@Guzz-T Guzz-T commented Mar 12, 2026

Add further information about the module structure and the use of the Luxtronik interface.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 12, 2026

Coverage

Coverage Report
FileStmtsMissCoverMissing
luxtronik
   __main__.py25250%3–66
   datatypes.py450199%147
   discover.py58198%63
luxtronik/cfi
   interface.py172398%167–168, 253
luxtronik/scripts
   __init__.py35586%7–16, 51
   discover_shi.py60600%8–98
   dump_cfi.py14657%18–25, 29
   dump_shi.py15660%21–28, 32
   performance_shi.py63630%7–89
   update_screen.py1058222%6, 20–41, 46–48, 51–61, 64, 70–75, 78, 81–85, 88–92, 95–97, 100–103, 106–111, 115–116, 119–126, 129–136
   watch_cfi.py321650%36–47, 50–56, 60
   watch_shi.py331652%38–49, 52–58, 62
luxtronik/shi
   interface.py320199%438
TOTAL240628588% 

Tests Skipped Failures Errors Time
378 0 💤 0 ❌ 0 🔥 18.406s ⏱️

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment on lines +74 to +87
```txt
field ←-owns 0..n-- data_vector
is
+----------------+-----+-------+-------------+----------+
| | | | |
Parameters Calculations Visiblities Holdings Inputs
↑ ↑ ↑ ↑ ↑
uses uses uses uses uses
| | | | |
+---------- LuxtronikData ----+ LuxtronikSmartHomeData
↑ ↑
+--is----LuxtronikAllData----is--+
```
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also a good candidate for mermaid?

Copy link
Copy Markdown
Collaborator

@kbabioch kbabioch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another good improvement. As annotated, maybe mermaid could be used. In case you don't want to, let me know, then I'll proceed.

@kbabioch
Copy link
Copy Markdown
Collaborator

Looks good to me, should I merge this?

@Guzz-T Guzz-T closed this Mar 13, 2026
@Guzz-T
Copy link
Copy Markdown
Contributor Author

Guzz-T commented Mar 13, 2026

Yes, you’re welcome to do that. I don’t have any further changes planned at the moment.

@Guzz-T Guzz-T reopened this Mar 13, 2026
@Guzz-T
Copy link
Copy Markdown
Contributor Author

Guzz-T commented Mar 13, 2026

Oops. I clicked the wrong button.

@kbabioch kbabioch merged commit 482390d into Bouni:main Mar 14, 2026
8 checks passed
@Guzz-T Guzz-T deleted the try/readme branch March 15, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants