WIP: Update: First attempt to auto generate docs #224
Open
Guzz-T wants to merge 83 commits intoBouni:docsfrom
Open
WIP: Update: First attempt to auto generate docs #224Guzz-T wants to merge 83 commits intoBouni:docsfrom
Guzz-T wants to merge 83 commits intoBouni:docsfrom
Conversation
* Add the "unknown calculations" names for compatibility reasons * Add new parameters/calculations/visibilites names as used in benpru/2025.10.25-beta --------- Co-authored-by: Guzz-T <Guzz-T@users.noreply.github.com>
* Added a set_by_user field to the Base-datatype Field is set to true if value-setter is called. Field is set to false if raw-setter is called. Field can be reset by the interface. * get_data_arr now returns false if there are more data than expected * Increase test coverage for the modbus class * Add a continues block unit needed for the interface * Preserve the read-data-blocks within the data vectors instead of re-calculate them on every read * Add the shi interface unit * Add a readme file * Add the shi module __init__ file * Move resolve_version function into separate method * Refactor set_by_user to write_pending * Fix outdated field name of mc3_max * Reduce the log-level of some messages to minimize the default error output * Removed get_input/get_holding since the same functionality is provided together by the getters of the list and the definitions * Add a definitions list constructor that filters an existing list by version * Provide a version-filtered list of the definitions within the shi interface --------- Co-authored-by: Guzz-T <Guzz-T@users.noreply.github.com>
…ndows as well. socket.MSG_DONTWAIT is not supported by Windows
If someone calls write() and then read() or write() from outside, there is no waiting.
In version 0.3.14, the definitions could be accessed via parameters/calculations/visibilities.
There is no reason to pay attention to upper and lower case here.
Return "Unknown_{value}" for not supported selections
Compare data field names case-insensitive
Improve backward compatibility
Move time.sleep(WAIT_TIME_AFTER_PARAMETER_WRITE) into _write()
Improvements for windows
Support Smart-Home-Interface Part 6: Integration into Luxtronik
…umentation See zip-file download at https://www.alpha-innotec.com/de/produkte/zubehor/smart-home---apps/knx-schnittstelle Note: The min/max values now relates to the raw value
…r string value Mainly to treat "x" and "Unknown_x" as equivalent.
…rs correctly For example, 4-byte integer values are stored in two 2-byte registers with bit index 31..16 in the first register and 15..0 in the second register.
Add information about the shi to the README.md
Fix write_all() and write_and_read() description and supported data-types
…the configuration data vectors
…ration data fields
…ectors for calculation/visibility/parameters
Use the information from the definition list to initialize the data vectors for calculation/visibility/parameters
Use a case-insensitive compare to set the options of SelectionBase
Restructure source code and imports
kbabioch
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Here is a suggestion for generating the documentation from the definitions. Please do NOT merge the pull request! First rebase the original branch and then cherry-pick the last commit 0eff359.
Update for #192