Add PID controller implementation #12643
Conversation
for more information, see https://pre-commit.ci
![algorithms-keeper[bot]](https://avatars.githubusercontent.com/in/235834?s=60&v=4){kind=small}
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
| @@ -0,0 +1,63 @@ | |||
| """ | |||
There was a problem hiding this comment.
An error occurred while parsing the file: control_algorithms/pid.py
Traceback (most recent call last):
File "/opt/render/project/src/algorithms_keeper/parser/python_parser.py", line 146, in parse
reports = lint_file(
^^^^^^^^^^
libcst._exceptions.ParserSyntaxError: Syntax Error @ 1:1.
tokenizer error: no matching outer block for dedent
"""
^
algorithms-keeper
bot
added
require tests
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
control_algorithms/pid.py
Outdated
| """ | ||
|
|
||
|
|
||
| class pid: |
There was a problem hiding this comment.
Class names should follow the CamelCase naming convention. Please update the following name accordingly: pid
control_algorithms/pid.py
Outdated
|
|
||
|
|
||
| class pid: | ||
| def __init__(self, Kp: float, Ki: float, Kd: float, setpoint: float = 0): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Kp
Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Ki
Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Kd
| self.integral = 0 | ||
| self.previous_error = 0 | ||
|
|
||
| def compute(self, measured_value: float, dt: float) -> float: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function compute
| self.previous_error = error | ||
| return output | ||
|
|
||
| def reset(self): |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function reset
Please provide return type hint for the function: reset. If the function does not return a value, please provide the type hint as: def function() -> None:
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
control_algorithms/pid.py
Outdated
|
|
||
|
|
||
| class PID: | ||
| def __init__(self, Kp: float, Ki: float, Kd: float, setpoint: float = 0): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Kp
Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Ki
Variable and function names should follow the snake_case naming convention. Please update the following name accordingly: Kd
| self.integral = 0 | ||
| self.previous_error = 0 | ||
|
|
||
| def compute(self, measured_value: float, dt: float) -> float: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function compute
| self.previous_error = error | ||
| return output | ||
|
|
||
| def reset(self): |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function reset
Please provide return type hint for the function: reset. If the function does not return a value, please provide the type hint as: def function() -> None:
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
control_algorithms/pid.py
Outdated
|
|
||
|
|
||
| class PID: | ||
| def __init__(self, kp: float, ki: float, kd: float, setpoint: float = 0): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
| self.integral = 0 | ||
| self.previous_error = 0 | ||
|
|
||
| def compute(self, measured_value: float, dt: float) -> float: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function compute
| self.previous_error = error | ||
| return output | ||
|
|
||
| def reset(self): |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function reset
Please provide return type hint for the function: reset. If the function does not return a value, please provide the type hint as: def function() -> None:
algorithms-keeper
bot
removed
the
tests are failing
There was a problem hiding this comment.
Click here to look at the relevant links ⬇️
🔗 Relevant Links
Repository:
Python:
Automated review generated by algorithms-keeper. If there's any problem regarding this review, please open an issue about it.
algorithms-keeper commands and options
algorithms-keeper actions can be triggered by commenting on this PR:
@algorithms-keeper reviewto trigger the checks for only added pull request files@algorithms-keeper review-allto trigger the checks for all the pull request files, including the modified files. As we cannot post review comments on lines not part of the diff, this command will post all the messages in one comment.NOTE: Commands are in beta and so this feature is restricted only to a member or owner of the organization.
|
|
||
|
|
||
| class PID: | ||
| def __init__(self, kp: float, ki: float, kd: float, setpoint: float = 0.0): |
There was a problem hiding this comment.
Please provide return type hint for the function: __init__. If the function does not return a value, please provide the type hint as: def function() -> None:
| self.integral = 0.0 | ||
| self.previous_error = 0.0 | ||
|
|
||
| def compute(self, measured_value: float, dt: float) -> float: |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function compute
| self.previous_error = error | ||
| return output | ||
|
|
||
| def reset(self): |
There was a problem hiding this comment.
As there is no test file in this pull request nor any test function or class in the file control_algorithms/pid.py, please provide doctest for the function reset
Please provide return type hint for the function: reset. If the function does not return a value, please provide the type hint as: def function() -> None:
Describe your change:
Checklist: