Issue2884 pid autotuning update the doc and add more parameters #3184
Conversation
SenHuang19
changed the title
@JayHuLBL Based on your comment, I have expanded the info section of the composed block to include
I also added more parameters, including the one associated with the direct acting and reverse acting to it. |
| <h4>Breif guidance</h4> | ||
| <p> | ||
| This block is built upon PIDWithInputGains<a href=\"modelica://Buildings.Controls.OBC.Utilities.PIDWithInputGains\"> | ||
| Buildings.Controls.OBC.Utilities.PIDWithInputGains</a> and its connections are the same as those of the latter. |
There was a problem hiding this comment.
This block is built based on the <a href=\"modelica://Buildings.Controls.OBC.Utilities.PIDWithInputGains\"> Buildings.Controls.OBC.Utilities.PIDWithInputGains</a> with the gain inputs calculated by tuning blocks.
There was a problem hiding this comment.
Updated this sentence accordingly.
| </p> | ||
| <p> | ||
| All the parameters of PIDWithInputGains are also used by this block, except the controller gains | ||
| <i>k</i>, <i>T<sub>i</sub></i>, and <i>T<sub>d</sub></i>, which are replaced with the initial values of those gains. |
There was a problem hiding this comment.
Please list the initial parameters k_start, Ti_start, Td_start. Is there any rules for setting the initial values?
There was a problem hiding this comment.
Those parameters don't have any impacts on the output. I made them final to avoid confusions.
| <i>k</i>, <i>T<sub>i</sub></i>, and <i>T<sub>d</sub></i>, which are replaced with the initial values of those gains. | ||
| </p> | ||
| <p> | ||
| This block provides four additional parameters, <i>yHig</i>, <i>yLow</i>, <i>deaBan</i>, and <i>yRef</i>. |
There was a problem hiding this comment.
What are these parameters? We do have comments for all these parameters in the code, but we may expand the explanation comments here. The user would want to know how to set the parameters and how these parameters affect the results. A brief introduction would be more helpful.
There was a problem hiding this comment.
Those parameters are not supposed to be modified by users. I made them final to avoid confusions.
| This block provides four additional parameters, <i>yHig</i>, <i>yLow</i>, <i>deaBan</i>, and <i>yRef</i>. | ||
| </p> | ||
| <p> | ||
| Note that the default values of those four parameters assume the control output is normalized. |
There was a problem hiding this comment.
How is the output normalized? Is it by setting the parameter r, or parameter yRef? Or should it be normalized externally?
There was a problem hiding this comment.
The normalized output means that the output of the PID controller is limited from 0 to 1. I revised the doc to avoid confusions.
| </p> | ||
| <p> | ||
| To use this block, connect it to the control loop. | ||
| It will start the auto-tuning process once the simulation starts and detects when the auto-tuning process ends. |
There was a problem hiding this comment.
When will the auto-tunning process end? Is there any criterior for it?
There was a problem hiding this comment.
It is defined in the subcomponent and I added the reference to avoid confusions.
| During the tuning process, the output of this block is from the embedded relay controller. | ||
| </p> | ||
| <p> | ||
| Once the auto-tuning process ends, this block changes the parameters of the embedded PID controller based on the tuning results. |
There was a problem hiding this comment.
At the end of the auto-tunning process, the block samples the last tunning results as the input gains to the embedded PID controller, and switch ......
There was a problem hiding this comment.
Updated this sentence accordingly.
| <p> | ||
| J. Berner (2017). | ||
| \"Automatic Controller Tuning using Relay-based Model Identification.\" | ||
| Department of Automatic Control, Lund University. |
There was a problem hiding this comment.
Can you add hyperlink to the reference?
There was a problem hiding this comment.
@SenHuang19 Thanks for making the changes.
Would you please update the documentation as suggested? It would be better not writing the documentation as the bullet points.
@JayHuLBL Thanks a lot for your comments. I have addressed them and eliminated the bullet points in the model doc. |
No description provided.