Francesco Bianchi / Flasher

Flasher class is useful to flash a pin for a given #n of times

Flasher.h@1:777003f7824d, 2013-12-07 (annotated)

Committer:
biank88
Date:
Sat Dec 07 17:05:09 2013 +0000
Revision:
1:777003f7824d
Parent:
0:8eb512b1d1ed 
doc added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
biank88 0:8eb512b1d1ed 1 #ifndef FLASHER_H
biank88 0:8eb512b1d1ed 2 #define FLASHER_H
biank88 0:8eb512b1d1ed 3
biank88 0:8eb512b1d1ed 4 #include "mbed.h"
biank88 1:777003f7824d 5
biank88 1:777003f7824d 6 /**Flasher class
biank88 1:777003f7824d 7 * Used to flash a pin # times
biank88 1:777003f7824d 8 *
biank88 1:777003f7824d 9 * Example:
biank88 1:777003f7824d 10 * @code
biank88 1:777003f7824d 11 * #include "mbed.h"
biank88 1:777003f7824d 12 * #include "Flasher.h"
biank88 1:777003f7824d 13 *
biank88 1:777003f7824d 14 * Flasher led(LED2);
biank88 1:777003f7824d 15 *
biank88 1:777003f7824d 16 * int main() {
biank88 1:777003f7824d 17 * led.flash(5); //flash LED2 5 times
biank88 1:777003f7824d 18 * }
biank88 1:777003f7824d 19 * @endcode
biank88 1:777003f7824d 20 */
biank88 0:8eb512b1d1ed 21 class Flasher {
biank88 0:8eb512b1d1ed 22 public:
biank88 1:777003f7824d 23 /**Create Flasher instance
biank88 1:777003f7824d 24 *
biank88 1:777003f7824d 25 *@param pin Mbed pin reference
biank88 1:777003f7824d 26 */
biank88 0:8eb512b1d1ed 27 Flasher(PinName pin);
biank88 1:777003f7824d 28
biank88 1:777003f7824d 29 /**Flash method
biank88 1:777003f7824d 30 *
biank88 1:777003f7824d 31 *@param n Number of flashes to perform
biank88 1:777003f7824d 32 */
biank88 0:8eb512b1d1ed 33 void flash(int n);
biank88 0:8eb512b1d1ed 34
biank88 0:8eb512b1d1ed 35 private:
biank88 0:8eb512b1d1ed 36 DigitalOut _pin;
biank88 0:8eb512b1d1ed 37 };
biank88 0:8eb512b1d1ed 38
biank88 0:8eb512b1d1ed 39 #endif