WIP: Update: First attempt to auto generate docs - #224

Closed

Guzz-T wants to merge 83 commits into

Guzz-T:docs-new

Commits on Dec 22, 2025

Add new parameters/visibilities/calculations names (#204)
Guzz-T
authored
9e2f01e
Support Smart-Home-Interface Part 5: Main interface (#203)
Guzz-T
authored
930b09b

Commits on Dec 23, 2025

Remove socket.MSG_DONTWAIT to be able to use the source code under Windows as well.
Guzz-T
committed
25c7f70
Call main() in case the module is called via "python -m luxtronik"
Guzz-T
committed
d24f8c8
Move time.sleep(WAIT_TIME_AFTER_PARAMETER_WRITE) into _write()
Guzz-T
committed
17d03a4
Add properties for accessing the data field definitions
Guzz-T
committed
c6b1c0e
Emulate the ID_WEB_SoftStand field from version 0.3.14
Guzz-T
committed
a71a292
Ensure that only integer values are written to the parameter queue.
Guzz-T
committed
46b743e
Compare data field names case-insensitive
Guzz-T
committed
60f6a2d
Return "Unknown_{value}" for not supported selections
Guzz-T
committed
70a8d41

Commits on Dec 25, 2025

Commits on Dec 27, 2025

Commits on Dec 30, 2025

Merge pull request #207 from Guzz-T/issue/190/integration
kbabioch
authored
c3d5f95
Update smart home interface definitions according to (in)official documentation
Guzz-T
committed
3440df6
Refine lpc_mode description
Guzz-T
committed
f031c67
Add some thermal energy definitions
Guzz-T
committed
6745492
Report an error in case to_heatpump() returns None
Guzz-T
committed
00603fd
Return None instead of Unknown_None from SelectionBase.from_heatpump()
Guzz-T
committed
a3050ba
Only attempt to resolve "unknown" for string-based values
Guzz-T
committed
8f23057
Allow the value of SelectionBase to be set using an integer or integer string value
Guzz-T
committed
30a2b03
Remove redundant datatype_class = "selection" assignment
Guzz-T
committed
b505e30
Correct MixedCircuitMode description
Guzz-T
committed
9c9dc1a
Handle contiguous values that are distributed across multiple registers correctly
Guzz-T
committed
156bad7
Enhance ScalingBase so that it can also handle non-4-byte values.
Guzz-T
committed
4d43428
Add 16-bit temperature data types
Guzz-T
committed
333c385
Add a buffer-type data-type
Guzz-T
committed
956eeea
Add "0" to data-type Errorcode to indicate "no error"
Guzz-T
committed
48b5e8d
Add a BitMaskBase data-type
Guzz-T
committed
3d31e05
Use BitMaskBase as base class for the HeatPumpState data-type
Guzz-T
committed
64d3af7
Further updates of the smart home interface definitions according to (in)official documentation
Guzz-T
committed
9a48710
Refactored "state" to "status" for shi data-types
Guzz-T
committed
90576cb
Fix power data-type for shi register
Guzz-T
committed
24ca59b

Commits on Jan 1, 2026

Add a testcase with obsolete entry names

gerw
authored and
Guzz-T
committed
50e9500
Add an adapted version of test_compatibility.py from gerw's #171
Guzz-T
committed
732e6e3
Increase pytest coverage for data vectors
Guzz-T
committed
f9eeb54
Establish the socket connection only when necessary
Guzz-T
committed
6fd1bb7
Add information about the shi to the README.md
Guzz-T
committed
296be2e
Re-add the `datatype_unit` information as base.unit class property
Guzz-T
committed
c214c23
Add the shi scripts to the CLI
Guzz-T
committed
0693025
Add a note about the necessary activation of the shi
Guzz-T
committed
82f4c0f

Commits on Jan 2, 2026

Commits on Jan 3, 2026

Commits on Jan 5, 2026

Commits on Jan 6, 2026

Merge pull request #222 from Guzz-T/issue/221/definitions
kbabioch
authored
ea8aa80
Merge pull request #219 from Guzz-T/try/case-insensitive-options
kbabioch
authored
aa7667b
Restructure source code and imports. No effective code change.
Guzz-T
committed
dcf3454
First attempt to auto generate docs

Bouni
authored and
Guzz-T
committed
639fe84
Comment branch constraint for testing purposes

Bouni
authored and
Guzz-T
committed
3362c36
Trigger CI

Bouni
authored and
Guzz-T
committed
471cc65
Add uv venv

Bouni
authored and
Guzz-T
committed
d068f79
Import instead of regex

Bouni
authored and
Guzz-T
committed
a061d60
Cleanup 🧹

Bouni
authored and
Guzz-T
committed
3379c94
Update bulma css to 1.0.4

Bouni
authored and
Guzz-T
committed
1c91c27
Improved style of docs

Bouni
authored and
Guzz-T
committed
9bdcd54
Improved the docs

Bouni
authored and
Guzz-T
committed
ad3851d
Update actions

Bouni
authored and
Guzz-T
committed
0e6c69e
Minor improvements

Bouni
authored and
Guzz-T
committed
1f8fd36
Add more polish

Bouni
authored and
Guzz-T
committed
e7a8dd8
Only trigger when a push to main is done

Bouni
authored and
Guzz-T
committed
7ee342f
Add link to the docs to the README

Bouni
authored and
Guzz-T
committed
7f225ea
Use the definitions to create the documentation
Guzz-T
committed
219849c
Merge pull request #223 from Guzz-T/issue/221/common
kbabioch
authored
548050a
Use the definitions list to query the field data
Guzz-T
committed
0eff359
Merge branch 'Bouni:main' into docs-new
Guzz-T
authored
fd12f96