Rob Keij / toggle_Pin

Create library

toggle.h@0:b12b22c76c4d, 2020-12-07 (annotated)

Committer:
qynx
Date:
Mon Dec 07 21:02:16 2020 +0000
Revision:
0:b12b22c76c4d
Create library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
qynx 0:b12b22c76c4d 1 #ifndef TOGGLE_H
qynx 0:b12b22c76c4d 2 #define TOGGLE_H
qynx 0:b12b22c76c4d 3
qynx 0:b12b22c76c4d 4 #include "mbed.h"
qynx 0:b12b22c76c4d 5
qynx 0:b12b22c76c4d 6
qynx 0:b12b22c76c4d 7 /** Toggle pin for debugging purposes
qynx 0:b12b22c76c4d 8 *
qynx 0:b12b22c76c4d 9 * Example:
qynx 0:b12b22c76c4d 10 * @code
qynx 0:b12b22c76c4d 11 * #include "mbed.h"
qynx 0:b12b22c76c4d 12 * #include "toggle.h"
qynx 0:b12b22c76c4d 13 *
qynx 0:b12b22c76c4d 14 * Toggle pin(P1_24);
qynx 0:b12b22c76c4d 15 * Toggle led(P1_25);
qynx 0:b12b22c76c4d 16 *
qynx 0:b12b22c76c4d 17 * main()
qynx 0:b12b22c76c4d 18 * {
qynx 0:b12b22c76c4d 19 *
qynx 0:b12b22c76c4d 20 * while(1) {
qynx 0:b12b22c76c4d 21 * pin.toggle(5); // toggle pin 5 times
qynx 0:b12b22c76c4d 22 * wait(1);
qynx 0:b12b22c76c4d 23 * led.toggle(3); // toggle led 3 times
qynx 0:b12b22c76c4d 24 * wait(0.5);
qynx 0:b12b22c76c4d 25 * }
qynx 0:b12b22c76c4d 26 *
qynx 0:b12b22c76c4d 27 * }
qynx 0:b12b22c76c4d 28 * @endcode
qynx 0:b12b22c76c4d 29 */
qynx 0:b12b22c76c4d 30
qynx 0:b12b22c76c4d 31
qynx 0:b12b22c76c4d 32 class Toggle
qynx 0:b12b22c76c4d 33 {
qynx 0:b12b22c76c4d 34 public:
qynx 0:b12b22c76c4d 35
qynx 0:b12b22c76c4d 36 /**
qynx 0:b12b22c76c4d 37 * toggle constructor
qynx 0:b12b22c76c4d 38 *
qynx 0:b12b22c76c4d 39 * @param pin "pin" to toggle
qynx 0:b12b22c76c4d 40 */
qynx 0:b12b22c76c4d 41 Toggle(PinName pin);
qynx 0:b12b22c76c4d 42
qynx 0:b12b22c76c4d 43
qynx 0:b12b22c76c4d 44 /**
qynx 0:b12b22c76c4d 45 * Command to n times toggle the pin
qynx 0:b12b22c76c4d 46 */
qynx 0:b12b22c76c4d 47
qynx 0:b12b22c76c4d 48 void toggle(int n);
qynx 0:b12b22c76c4d 49
qynx 0:b12b22c76c4d 50
qynx 0:b12b22c76c4d 51
qynx 0:b12b22c76c4d 52
qynx 0:b12b22c76c4d 53 private:
qynx 0:b12b22c76c4d 54
qynx 0:b12b22c76c4d 55 /**
qynx 0:b12b22c76c4d 56 * Set the Digital out pin
qynx 0:b12b22c76c4d 57 */
qynx 0:b12b22c76c4d 58
qynx 0:b12b22c76c4d 59 DigitalOut _p;
qynx 0:b12b22c76c4d 60 };
qynx 0:b12b22c76c4d 61
qynx 0:b12b22c76c4d 62 #endif