Merged
Conversation
This is required for bitfields to be able to read or write an arbitrary number of bytes from/to the stream.
This might change in future.
These two classes require the use of bitfields, which until now has not been implemented. The interface and design of these two classes is not yet final. Discussion and testing of this interface is recommended before finalization and further work on other bitfield records.
This follows the pattern established by the classes in dis7.py
Initial test for bitfield class
Contributor
Author
|
This was previously #59, rebased onto the current The tests appear to pass, and only fail at Upload Test Results which doesn't seem to be caused by the codebase itself. I'm marking this PR ready for review. |
leif81
approved these changes
Sep 25, 2025
Member
|
@ngjunsiang thanks for that. It's passing the checks now. Have anything more planned or should I proceed with the merge now? |
Contributor
Author
|
@leif81 I would suggest to go ahead and merge it first, I'll make a separate PR for further work in this direction. |
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
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.
Introduction
The PDUs in IEEE1278.1-2012 contain structured, hierarchical records, of which three kinds can be identified:
A. fixed-size records, with a fixed marshalled size that is known upfront, and record fields have octet-multiple sizes
B. variable-size records, with a variable marshalled size that is not known upfront, and is typically included in one of the record fields as a length or count.
C. fixed-size bitfield enums/records, with fields that are non-octet-multiple sizes
This is a first attempt at implementing the last category (C), involving record fields with non-octet-multiple sizes.
All tests pass so far.
Changes
New method for reading bytes from stream
DataInputStreamandDataOutputStreamgetread_bytes()andwrite_byte()methods respectively that allow reading an arbitrary number of raw bytes from the stream , and writing a byte sequence of arbitrary size to the stream.New namespace,
recordThe new classes are in a separate file,
record.py, to avoid dumping its required imports intodis7.If this namespacing arrangement is preferable I will gradually migrate other records over to this module as I work on them as well. This will leave
dis7.pyprimarily for PDU classes.Sample bitfield class definitions
In
record.pyare:bitfield()SpreadSpectrumandNetId.I have also pushed a small change to
dis7.py, which affectsModulationType(which usesSpreadSpectrum) and thus theTransmitterPduclass as well.Requests
Since this PR proposes an interface for bitfields, I would prefer to merge it into a
testingbranch first and keep it apart frommasteruntil sufficient time has passed for users and contributors to give it a run.If this is okay, please reject this PR and I will make another one for
testingbranch after it is created.Related/affected issues/PRs
marshalledSize()method that returns the bytesize of the complete record. Consider this an experiment for that proposal as well.marshalledSize()method, will make Boundary padding for records and PDUs #53 easier as it provides an easy way to obtain the length of records.dis7module into multiple submodules so that it is easier to differentiate the classes in this package.SpreadSpectrumcompletes the implementation ofModulationType, which means thattestTransmitterPdu.pycan now incorporate themodulationTypeattribute into its testing as well (it currently stops atpower)