First of all, thanks for the lib! I'm trying to use it to implement a PPM out feature on an IMU.
One little issue is the consistency of the documentation (the little there is of it), and the examples...
For example, the documentation for the ppmout class doesn't specify in which format the input values should be supplied. So I go and have a look in the ppmout_example.pde file, and find a nice comment saying:
"Input buffer containing normalized input samples, range [-256 - 256]"
But then a few lines later, we get a:
g_input[i] = map(analogRead(g_pins[i]), 0, 1024, 1000, 2000);
Sooo... I guess we're now supposed to supply the values in microseconds, right?
Then, about initialisation, all we have is:
// initialize PPMOut with some settings
g_PPMOut.setPulseLength(448);
g_PPMOut.setPauseLength(10448);
Thanks for the "some settings", but what exactly? What's the value->result on the PPM pulse stream relationship? There's nothing about that in the documentation.
Yes I'll be able to find it out by myself with a scope, but all it would take is a couple of lines to describe the essential stuff...
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
You're right! I had a look at all the headers and examples and fixed any errors I found. I've also added more comments to the examples. A small document to explain the relation between various values is still on my wishlist though...
The changes can be found under "code" in [r82], they will be incorporated in the next release.
First of all, thanks for the lib! I'm trying to use it to implement a PPM out feature on an IMU.
One little issue is the consistency of the documentation (the little there is of it), and the examples...
For example, the documentation for the ppmout class doesn't specify in which format the input values should be supplied. So I go and have a look in the ppmout_example.pde file, and find a nice comment saying:
"Input buffer containing normalized input samples, range [-256 - 256]"
But then a few lines later, we get a:
g_input[i] = map(analogRead(g_pins[i]), 0, 1024, 1000, 2000);
Sooo... I guess we're now supposed to supply the values in microseconds, right?
Then, about initialisation, all we have is:
// initialize PPMOut with some settings
g_PPMOut.setPulseLength(448);
g_PPMOut.setPauseLength(10448);
Thanks for the "some settings", but what exactly? What's the value->result on the PPM pulse stream relationship? There's nothing about that in the documentation.
Yes I'll be able to find it out by myself with a scope, but all it would take is a couple of lines to describe the essential stuff...
You're right! I had a look at all the headers and examples and fixed any errors I found. I've also added more comments to the examples. A small document to explain the relation between various values is still on my wishlist though...
The changes can be found under "code" in [r82], they will be incorporated in the next release.
Related
Commit: [r82]
Last edit: dvdouden 2012-10-30