diff options
| author | Perry Hung <iperry@gmail.com> | 2011-01-24 23:23:29 -0500 |
|---|---|---|
| committer | Perry Hung <iperry@gmail.com> | 2011-01-24 23:23:29 -0500 |
| commit | c48689d34809943a5907884bd287cea9ae275352 (patch) | |
| tree | d49ff06b0d4b81f6ab0eac8060d178ce7542476c /wirish/pwm.h | |
| parent | 64431fd4b59cb8656365f1fad5f679cd4d756239 (diff) | |
| parent | a9b2d70bc7799ca96c1673b18fe3012b1a4dd329 (diff) | |
| download | librambutan-c48689d34809943a5907884bd287cea9ae275352.tar.gz librambutan-c48689d34809943a5907884bd287cea9ae275352.zip | |
Merge remote branch 'leaf/master'
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); |