Deprecate and remove support for uncommon options in output_pin #6458
Conversation
This file contains 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
KevinOConnor
force-pushed
the
work-queuepin-20230113
branch
from
33e82c4 to
8c99d99
Compare
|
I think this change is good for code quality. |
Remove support for configuring "static" pins in output_pin module. A "static" pin only saves a few bytes of memory in the micro-controller. The savings does not justify the increased code complexity. Deprecate the static_value parameter to warn users. In the interim, a static_value parameter will set both value and shutdown_value parameters. Signed-off-by: Kevin O'Connor <[email protected]>
Update static_digital_output.py to directly configure static digital pins. There are no other users of "static" pins, so remove that support from mcu.py, replicape.py, and sx1509.py. This simplifies the low-level pin handling code. Signed-off-by: Kevin O'Connor <[email protected]>
Advise users to configure a pwm_tool config section if checking for maximum mcu duration is required. Signed-off-by: Kevin O'Connor <[email protected]>
Remove support for changing the cycle time of pwm pins from the output_pin module. Use a new pwm_cycle_time module that supports setting dynamic cycle times. This simplifies the output_pin code and low-level pin update code. Signed-off-by: Kevin O'Connor <[email protected]>
Signed-off-by: Kevin O'Connor <[email protected]>
KevinOConnor
force-pushed
the
work-queuepin-20230113
branch
from
8c99d99 to
43a9685
Compare
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.
Over the last few years the
output_pinmodule has gained a handful of options that have made it harder to maintain the the low-level backend code. This PR simplifies the output_pin module. The main changes are:static_valueparameter is deprecated. This option has little impact - it only saves a few bytes in the micro-controller. Going forward it is simple enough to just not specify it.maximum_mcu_durationparameter is deprecated. Thepwm_toolmodule is a better choice for tools that require this capability. It should be straight forward for users to change their configs from[output_pin mypin]to[pwm_tool mypin].SET_PIN CYCLE_TIME=xg-code command for[output_pin mypin]config sections has been removed. Users can convert to a new[pwm_cycle_time mypin]config as a replacement. This change is setup to take effect immediately (no deprecation period).This is the last PR as part of the
pwm_toolseries of changes (eg, #6369, #6410, #6420).@Cirromulus - fyi.
-Kevin