File content as of revision 43:aff670d0d510:

/* mbed Microcontroller Library - PwmOut
 * Copyright (c) 2007-2011 ARM Limited. All rights reserved.
 */ 
 
#ifndef MBED_PWMOUT_H
#define MBED_PWMOUT_H

#include "device.h"

#if DEVICE_PWMOUT

#include "platform.h"
#include "PinNames.h"
#include "PeripheralNames.h"
#include "Base.h"

namespace mbed {

/** A pulse-width modulation digital output
 *
 * Example
 * @code
 * // Fade a led on.
 * #include "mbed.h"
 *
 * PwmOut led(LED1);
 * 
 * int main() {
 *     while(1) {
 *         led = led + 0.01;
 *         wait(0.2);
 *         if(led == 1.0) {
 *             led = 0;
 *         }
 *     }
 * }
 * @endcode
 *
 * @note
 *  On the LPC1768 and LPC2368, the PWMs all share the same
 *  period - if you change the period for one, you change it for all.
 *  Although routines that change the period maintain the duty cycle
 *  for its PWM, all other PWMs will require their duty cycle to be
 *  refreshed.
 */
class PwmOut : public Base {

public:

    /** Create a PwmOut connected to the specified pin
     *
     *  @param pin PwmOut pin to connect to
     */
    PwmOut(PinName pin, const char *name = NULL);

    /** Set the ouput duty-cycle, specified as a percentage (float)
     *
     *  @param value A floating-point value representing the output duty-cycle, 
     *    specified as a percentage. The value should lie between
     *    0.0f (representing on 0%) and 1.0f (representing on 100%).
     *    Values outside this range will be saturated to 0.0f or 1.0f.     
     */
    void write(float value);

    /** Return the current output duty-cycle setting, measured as a percentage (float)
     *
     *  @returns
     *    A floating-point value representing the current duty-cycle being output on the pin, 
     *    measured as a percentage. The returned value will lie between
     *    0.0f (representing on 0%) and 1.0f (representing on 100%).
     *
     *  @note
     *    This value may not match exactly the value set by a previous <write>.
     */
    float read();
    
    /** Set the PWM period, specified in seconds (float), keeping the duty cycle the same.
     *
     *  @note
     *    The resolution is currently in microseconds; periods smaller than this
     *    will be set to zero.
     */
    void period(float seconds);

    /** Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
     */
    void period_ms(int ms);

    /** Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
     */
    void period_us(int us);

    /** Set the PWM pulsewidth, specified in seconds (float), keeping the period the same.
     */
    void pulsewidth(float seconds);

    /** Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
     */
    void pulsewidth_ms(int ms);

    /** Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
     */
    void pulsewidth_us(int us);

#ifdef MBED_OPERATORS
    /** A operator shorthand for write()
     */
    PwmOut& operator= (float value);
    PwmOut& operator= (PwmOut& rhs);

    /** An operator shorthand for read()
     */
    operator float();
#endif

#ifdef MBED_RPC
    virtual const struct rpc_method *get_rpc_methods();
    static struct rpc_class *get_rpc_class();
#endif

protected:

    PWMName _pwm;

};

} // namespace mbed

#endif

#endif