RFC: docs and examples for custom selection of PWM channels #60
Conversation
|
I like the idea of this, however i'm not super familiar with how the pwm module works so I don't think I can give a ton of feedback on it. Would you be able to add some documentation to the example explaining how to set the |
|
Hi @TheZoq2 , Regards, |
|
@geomatsi Very nice, I like it. Can't test it myself at the moment, though. |
|
Hi all, I added a bit more docs and examples in order to clarify how to define custom channel selections and how to implement By the way, I would appreciate if you could take a look at docs phrasing and check if anything needs correction from the language point of view. Regards, |
|
A brief skim of this looks good from a language perspective. I can confirm that this clarified things to the point that I was able to implement the Pwm capability I desired for my STM32F103 based firmware. 👍 |
src/pwm.rs
Outdated
| @@ -126,7 +196,7 @@ impl Pins<TIM4> | |||
| PB9<Alternate<PushPull>>, | |||
| ) | |||
| { | |||
| const REMAP: u8 = 0b0; | |||
| const REMAP: u8 = 0b00; | |||
There was a problem hiding this comment.
I think this change is wrong. TIM4_REMAP is, afaict, only one bit.
Zero means PB6,7,8,9 ånd One means PD12,13,14,15
There was a problem hiding this comment.
I mean, the change is harmless enough, but it could lead somene to think that the value was wider than one bit.
There was a problem hiding this comment.
Good catch ! I will push a fixup.
Provide documentaion and example for custom channel configurations using newtype pattern to implement Pins trait. Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
Add more details and examples for custom channel selection. Clarify where to get REMAP and Cx values. Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
TIM4_REMAP is only one bit: 0b0 -> PB6, PB7, PB8, PB9 0b1 -> PD12, PD13, PD14, PD15 Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
- phrasing - specify AFIO/TIM section from TRM Signed-off-by: Sergey Matyukevich <geomatsi@gmail.com>
|
Hi @TheZoq2 BTW, I am not sure why TravisCI tries to build the same PR changes twice... Regards, |
|
Nicely done, thanks! |
Hi all,
In practical applications various selections of PWM channels may be needed. For instance, one or two channels attached to gpio pins for non-default remapping. It is possible to keep adding implementations of the 'Pins' trait into pwm module for all the needed channel/pin combinations. However it does not look practical unless there exist some clever way to describe all possible combinations w/o boilerplate code.
Another option is to keep only basic implementations in pwm module, e.g. 'all the channels for default pin remapping'. As for the custom channel selections, it is possible to use newtype pattern to implement 'Pins' trait in the user application. This PR adds documentation and example demonstrating the use of newtype pattern for creation of custom PWM channel configuration.
Thoughts ? Comments ?
Regards,
Sergey