Feature/270 specify transmitter packet size#271
Merged
LorenzzoQM merged 3 commits intodevelopfrom Jun 5, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
Adds a new transmitterPacketSize parameter to the transmitter setup so users can override the default packet size (which remains the instrument baud rate if unspecified).
- Introduce
transmitterPacketSizeas an optional argument insetup_transmitter - Update logic to use the specified packet size or fall back to the instrument baud rate
- Update release notes to document the new feature
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/bsk_rl/sim/dyn.py | Added optional transmitterPacketSize parameter and conditional logic |
| docs/source/release_notes.rst | Documented transmitterPacketSize option in release notes |
Comments suppressed due to low confidence (2)
src/bsk_rl/sim/dyn.py:857
- The new branch for a user-specified
transmitterPacketSizeis not covered by existing tests; consider adding a unit test verifying that the override is applied correctly.
self.transmitter.packetSize = transmitterPacketSize # bits
src/bsk_rl/sim/dyn.py:834
- Optional is used but not imported; please add
from typing import Optionalat the top of the file to avoid a NameError.
transmitterPacketSize: Optional[int] = None,
5c8d0ed to
7dd57c7
Compare
Mark2000
approved these changes
Jun 5, 2025
Contributor
Mark2000
left a comment
There was a problem hiding this comment.
Looks good to me. Working on fixing the things that broke in BSK to make the tests pass.
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.
Description
Closes #270
Add the option to specify the
transmitterPacketSize. If not specified, it sets it as the instrument baud rate, as previously.Type of change
How should this pull request be reviewed?
How Has This Been Tested?
By running unit and integration tests.
Checklist