Skip to content
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.

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

Frustrated at lack of documentation...can anyone help? #9

Open
TheNewbFlyer opened this issue Mar 6, 2023 · 4 comments
Open

Frustrated at lack of documentation...can anyone help? #9

TheNewbFlyer opened this issue Mar 6, 2023 · 4 comments

Comments

@TheNewbFlyer
Copy link

TheNewbFlyer commented Mar 6, 2023

The variable "Setpoint" is the desired angle correct? What is its min/max values (the example just has "512")?

I normally use VS Code, but I went to the Arduino IDE to use the Serial Plotter to diagnose things, but it's just a bunch of lines flying by really fast. How can I display the values correctly (I copied this part straight from the example).

@alexiscruzdavid
Copy link

Have you tried adding a delay so the lines come by slower? That's what I typically do when debugging. I do agree with you on the lack of documentation

@PowerBroker2
Copy link
Owner

I'm busy with other projects atm, but will eventually take a look at this lib again. As for now, there is an example (which you've found), but there is also a readme that explains quite a few things. The setpoint and gain parameters are interfaced in the same exact way as the legacy Arduino PID library - pass the parameters by reference to the begin() function and change the parameters directly when needed without being required to call any lib functions.

Also, the purpose of the setpoint is simply the desired controller output. That desired output will change depending on your application.

@alexiscruzdavid
Copy link

Are you open to any collaborators? I like your work and would be down to help on documenting/developing on ArduPID.

@PowerBroker2
Copy link
Owner

Yeah, absolutely! It would be super cool if it was compatible with Read the Docs. I don't have experience with Read the Docs, but I've tried messing around with doxygen (had issues with getting it to work and pretty much abandoned it).

I'm open to PRs/MRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants