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

Mistakes in EBB S2 command documentation #238

Open
EmbeddedMan opened this issue Feb 23, 2025 · 2 comments
Open

Mistakes in EBB S2 command documentation #238

EmbeddedMan opened this issue Feb 23, 2025 · 2 comments
Assignees

Comments

@EmbeddedMan
Copy link
Contributor

Kindly submitted by Ilan Moyer:

  • The order of parameters is given as S2,Position,Output_Pin[,Rate[,Delay]], but in the examples rate and delay are flipped.
  • The units of rate are given as 1/12000s per 24ms, but this gives a rate of 3.472ms/s, which seems way too high. Is this supposed to say 1/12000ms per 24ms (3.4722us/S)? That would match the examples later in the section.
@EmbeddedMan
Copy link
Contributor Author

The first finding is correct. I am creating a branch with a fix to the S2 documentation which corrects this mistake. I also found another mistake in the third (S2,10000,5,100) example. It should read S2,10000,5,0,100 and is fixed in the branch. I also added the word 'optional' to the Slew Rate parameter description to make it clear that this is an optional parameter. I also moved the Slew Rate parameter description up to before the Rate parameter description so that the order matches the actual parameters in the command.

The second finding is also correct. There were several places in the S2 documentation which used 1/12,000 s as the units for the PWM duration, and other places that got it correct (1/12,000,000 s).

@oskay
Copy link
Contributor

oskay commented Feb 23, 2025

Agreed that the rate and pin are flipped in the examples. ✅

Yes on 1/12,000 of a second -- That probably was to be 1/12000 of a ms at some point. 🤦

So, yes, good catches all around. 👍

EmbeddedMan added a commit that referenced this issue Feb 23, 2025
As per GH Issue #238 fixed documentation for S2 command.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants