djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve pwmio documentation

Browse Source 
#7644 pointed out the need for better documentation.

To the best of my ability I noted the current behavior.
I think that there may be some ports that do not actually read
back the 'set' frequency value, but they are ports marked as beta
status (mimxrt10xx) or not maintained by us (cxd56).
This commit is contained in:
Jeff Epler 2023-02-25 11:02:49 -06:00
parent 26bab620f7
commit 07b3bd6d77
No known key found for this signature in database
GPG Key ID: D5BF15AB975AB4DE
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
shared-bindings/pwmio/PWMOut.c
View File

@ -69,7 +69,27 @@ void common_hal_pwmio_pwmout_raise_error(pwmout_result_t result) {
}
//| class PWMOut:
//| """Output a Pulse Width Modulated signal on a given pin."""
//| """Output a Pulse Width Modulated signal on a given pin.
//|
//| .. note:: The exact frequencies possible depend on the specific microcontroller.
//| If the requested frequency is within the available range, one of the two
//| nearest possible frequencies to the requested one is selected.
//|
//| If the requested frequency is outside the range, either (A) a ValueError
//| may be raised or (B) the highest or lowest frequency is selected. This
//| behavior is microcontroller-dependent, and may depend on whether it's the
//| upper or lower bound that is exceeded.
//|
//| In any case, the actual frequency (rounded to 1Hz) is available in the
//| ``frequency`` property after construction.
//|
//| .. note:: The frequency is calculated based on a nominal CPU frequency.
//| However, depending on the board, the error between the nominal and
//| actual CPU frequency can be large (several hundred PPM in the case of
//| crystal oscillators and up to ten percent in the case of RC
//| oscillators)
//|
//| """
//|
//| def __init__(
//| self,
@ -134,7 +154,9 @@ void common_hal_pwmio_pwmout_raise_error(pwmout_result_t result) {
//| pwm = pwmio.PWMOut(board.D13, duty_cycle=2 ** 15, frequency=440, variable_frequency=True)
//| time.sleep(0.2)
//| pwm.frequency = 880
//| time.sleep(0.1)"""
//| time.sleep(0.1)
//|
//| """
//| ...
STATIC mp_obj_t pwmio_pwmout_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
enum { ARG_pin, ARG_duty_cycle, ARG_frequency, ARG_variable_frequency };
@ -234,7 +256,8 @@ MP_PROPERTY_GETSET(pwmio_pwmout_duty_cycle_obj,
//| for the PWM's duty cycle may need to be recalculated when the frequency
//| changes. In these cases, the duty cycle is automatically recalculated
//| from the original duty cycle value. This should happen without any need
//| to manually re-set the duty cycle."""
//| to manually re-set the duty cycle. However, an output glitch may occur during the adjustment.
//| """
//|
STATIC mp_obj_t pwmio_pwmout_obj_get_frequency(mp_obj_t self_in) {
pwmio_pwmout_obj_t *self = MP_OBJ_TO_PTR(self_in);