diff options
| author | Marti Bolivar <mbolivar@mit.edu> | 2010-10-25 21:15:28 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@mit.edu> | 2010-11-17 12:44:28 -0500 |
| commit | 95783b750fda95f5f4c1fac00ab24da03b31b517 (patch) | |
| tree | 2b0bf89c101aa58af5796fbe76c7ec98eebbb0a5 /wirish/pwm.h | |
| parent | 3a9a119e9a8ce72c0e1b8fa4d3904bdf84ce355c (diff) | |
| download | librambutan-95783b750fda95f5f4c1fac00ab24da03b31b517.tar.gz librambutan-95783b750fda95f5f4c1fac00ab24da03b31b517.zip | |
arduino language reference nearing completion, properly CC-BY-SA 3.0 attributed
Diffstat (limited to 'wirish/pwm.h')
| -rw-r--r-- | wirish/pwm.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/wirish/pwm.h b/wirish/pwm.h index 6d0ddaf..d0bc9e0 100644 --- a/wirish/pwm.h +++ b/wirish/pwm.h @@ -35,15 +35,18 @@ extern "C"{ #endif +/** + * As a convenience, analogWrite is an alias of pwmWrite to ease + * porting Arduino code. However, period and duty will have to be + * recalibrated. + */ #define analogWrite pwmWrite /** - * Set the PWM duty. + * Set the PWM duty on the given pin. * * User code is expected to determine and honor the maximum value - * (based on the configured period). As a convenience, analogWrite is - * an alias of pwmWrite to ease porting Arduino code, though period - * and duty will have to be recalibrated + * (based on the configured period). */ void pwmWrite(uint8 pin, uint16 duty_cycle); |