Skip to content

Rename serialOFF to printOFF in README #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lsellens wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Rename serialOFF to printOFF in README #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ sTune(float *input, float *output, TuningRule tuningRule, Action action, SerialM

| Serial Mode | Description |
| --------------- | ------------------------------------------------------------ |
| `serialOFF` | No serial output will occur. |
| `printOFF` | No serial output will occur. |
| `printALL` | Prints test data while settling and during the test run. A summary of results is printed when testing completes. |
| `printSUMMARY` | A summary of results is printed when testing completes. |
| `printDEBUG` | Same as `printALL`but includes printing diagnostic data during test run. |
Expand All @@ -101,7 +101,7 @@ sTune(float *input, float *output, TuningRule tuningRule, Action action, SerialM

```c++
sTune tuner = sTune(&Input, &Output, tuner.ZN_PID, tuner.directIP, tuner.printALL);
/* ZN_PID directIP serialOFF
/* ZN_PID directIP printOFF
DampedOsc_PID direct5T printALL
NoOvershoot_PID reverseIP printSUMMARY
CohenCoon_PID reverse5T printDEBUG
Expand Down