Jhon Plantikow / DHT11

DHT11

PwmOut.h@0:c52df770855b, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:21:57 2015 +0000
Revision:
0:c52df770855b
DHT11

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jhon309 0:c52df770855b 1 /* mbed Microcontroller Library
jhon309 0:c52df770855b 2 * Copyright (c) 2006-2013 ARM Limited
jhon309 0:c52df770855b 3 *
jhon309 0:c52df770855b 4 * Licensed under the Apache License, Version 2.0 (the "License");
jhon309 0:c52df770855b 5 * you may not use this file except in compliance with the License.
jhon309 0:c52df770855b 6 * You may obtain a copy of the License at
jhon309 0:c52df770855b 7 *
jhon309 0:c52df770855b 8 * http://www.apache.org/licenses/LICENSE-2.0
jhon309 0:c52df770855b 9 *
jhon309 0:c52df770855b 10 * Unless required by applicable law or agreed to in writing, software
jhon309 0:c52df770855b 11 * distributed under the License is distributed on an "AS IS" BASIS,
jhon309 0:c52df770855b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jhon309 0:c52df770855b 13 * See the License for the specific language governing permissions and
jhon309 0:c52df770855b 14 * limitations under the License.
jhon309 0:c52df770855b 15 */
jhon309 0:c52df770855b 16 #ifndef MBED_PWMOUT_H
jhon309 0:c52df770855b 17 #define MBED_PWMOUT_H
jhon309 0:c52df770855b 18
jhon309 0:c52df770855b 19 #include "platform.h"
jhon309 0:c52df770855b 20
jhon309 0:c52df770855b 21 #if DEVICE_PWMOUT
jhon309 0:c52df770855b 22 #include "pwmout_api.h"
jhon309 0:c52df770855b 23
jhon309 0:c52df770855b 24 namespace mbed {
jhon309 0:c52df770855b 25
jhon309 0:c52df770855b 26 /** A pulse-width modulation digital output
jhon309 0:c52df770855b 27 *
jhon309 0:c52df770855b 28 * Example
jhon309 0:c52df770855b 29 * @code
jhon309 0:c52df770855b 30 * // Fade a led on.
jhon309 0:c52df770855b 31 * #include "mbed.h"
jhon309 0:c52df770855b 32 *
jhon309 0:c52df770855b 33 * PwmOut led(LED1);
jhon309 0:c52df770855b 34 *
jhon309 0:c52df770855b 35 * int main() {
jhon309 0:c52df770855b 36 * while(1) {
jhon309 0:c52df770855b 37 * led = led + 0.01;
jhon309 0:c52df770855b 38 * wait(0.2);
jhon309 0:c52df770855b 39 * if(led == 1.0) {
jhon309 0:c52df770855b 40 * led = 0;
jhon309 0:c52df770855b 41 * }
jhon309 0:c52df770855b 42 * }
jhon309 0:c52df770855b 43 * }
jhon309 0:c52df770855b 44 * @endcode
jhon309 0:c52df770855b 45 *
jhon309 0:c52df770855b 46 * @note
jhon309 0:c52df770855b 47 * On the LPC1768 and LPC2368, the PWMs all share the same
jhon309 0:c52df770855b 48 * period - if you change the period for one, you change it for all.
jhon309 0:c52df770855b 49 * Although routines that change the period maintain the duty cycle
jhon309 0:c52df770855b 50 * for its PWM, all other PWMs will require their duty cycle to be
jhon309 0:c52df770855b 51 * refreshed.
jhon309 0:c52df770855b 52 */
jhon309 0:c52df770855b 53 class PwmOut {
jhon309 0:c52df770855b 54
jhon309 0:c52df770855b 55 public:
jhon309 0:c52df770855b 56
jhon309 0:c52df770855b 57 /** Create a PwmOut connected to the specified pin
jhon309 0:c52df770855b 58 *
jhon309 0:c52df770855b 59 * @param pin PwmOut pin to connect to
jhon309 0:c52df770855b 60 */
jhon309 0:c52df770855b 61 PwmOut(PinName pin) {
jhon309 0:c52df770855b 62 pwmout_init(&_pwm, pin);
jhon309 0:c52df770855b 63 }
jhon309 0:c52df770855b 64
jhon309 0:c52df770855b 65 /** Set the ouput duty-cycle, specified as a percentage (float)
jhon309 0:c52df770855b 66 *
jhon309 0:c52df770855b 67 * @param value A floating-point value representing the output duty-cycle,
jhon309 0:c52df770855b 68 * specified as a percentage. The value should lie between
jhon309 0:c52df770855b 69 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
jhon309 0:c52df770855b 70 * Values outside this range will be saturated to 0.0f or 1.0f.
jhon309 0:c52df770855b 71 */
jhon309 0:c52df770855b 72 void write(float value) {
jhon309 0:c52df770855b 73 pwmout_write(&_pwm, value);
jhon309 0:c52df770855b 74 }
jhon309 0:c52df770855b 75
jhon309 0:c52df770855b 76 /** Return the current output duty-cycle setting, measured as a percentage (float)
jhon309 0:c52df770855b 77 *
jhon309 0:c52df770855b 78 * @returns
jhon309 0:c52df770855b 79 * A floating-point value representing the current duty-cycle being output on the pin,
jhon309 0:c52df770855b 80 * measured as a percentage. The returned value will lie between
jhon309 0:c52df770855b 81 * 0.0f (representing on 0%) and 1.0f (representing on 100%).
jhon309 0:c52df770855b 82 *
jhon309 0:c52df770855b 83 * @note
jhon309 0:c52df770855b 84 * This value may not match exactly the value set by a previous <write>.
jhon309 0:c52df770855b 85 */
jhon309 0:c52df770855b 86 float read() {
jhon309 0:c52df770855b 87 return pwmout_read(&_pwm);
jhon309 0:c52df770855b 88 }
jhon309 0:c52df770855b 89
jhon309 0:c52df770855b 90 /** Set the PWM period, specified in seconds (float), keeping the duty cycle the same.
jhon309 0:c52df770855b 91 *
jhon309 0:c52df770855b 92 * @note
jhon309 0:c52df770855b 93 * The resolution is currently in microseconds; periods smaller than this
jhon309 0:c52df770855b 94 * will be set to zero.
jhon309 0:c52df770855b 95 */
jhon309 0:c52df770855b 96 void period(float seconds) {
jhon309 0:c52df770855b 97 pwmout_period(&_pwm, seconds);
jhon309 0:c52df770855b 98 }
jhon309 0:c52df770855b 99
jhon309 0:c52df770855b 100 /** Set the PWM period, specified in milli-seconds (int), keeping the duty cycle the same.
jhon309 0:c52df770855b 101 */
jhon309 0:c52df770855b 102 void period_ms(int ms) {
jhon309 0:c52df770855b 103 pwmout_period_ms(&_pwm, ms);
jhon309 0:c52df770855b 104 }
jhon309 0:c52df770855b 105
jhon309 0:c52df770855b 106 /** Set the PWM period, specified in micro-seconds (int), keeping the duty cycle the same.
jhon309 0:c52df770855b 107 */
jhon309 0:c52df770855b 108 void period_us(int us) {
jhon309 0:c52df770855b 109 pwmout_period_us(&_pwm, us);
jhon309 0:c52df770855b 110 }
jhon309 0:c52df770855b 111
jhon309 0:c52df770855b 112 /** Set the PWM pulsewidth, specified in seconds (float), keeping the period the same.
jhon309 0:c52df770855b 113 */
jhon309 0:c52df770855b 114 void pulsewidth(float seconds) {
jhon309 0:c52df770855b 115 pwmout_pulsewidth(&_pwm, seconds);
jhon309 0:c52df770855b 116 }
jhon309 0:c52df770855b 117
jhon309 0:c52df770855b 118 /** Set the PWM pulsewidth, specified in milli-seconds (int), keeping the period the same.
jhon309 0:c52df770855b 119 */
jhon309 0:c52df770855b 120 void pulsewidth_ms(int ms) {
jhon309 0:c52df770855b 121 pwmout_pulsewidth_ms(&_pwm, ms);
jhon309 0:c52df770855b 122 }
jhon309 0:c52df770855b 123
jhon309 0:c52df770855b 124 /** Set the PWM pulsewidth, specified in micro-seconds (int), keeping the period the same.
jhon309 0:c52df770855b 125 */
jhon309 0:c52df770855b 126 void pulsewidth_us(int us) {
jhon309 0:c52df770855b 127 pwmout_pulsewidth_us(&_pwm, us);
jhon309 0:c52df770855b 128 }
jhon309 0:c52df770855b 129
jhon309 0:c52df770855b 130 #ifdef MBED_OPERATORS
jhon309 0:c52df770855b 131 /** A operator shorthand for write()
jhon309 0:c52df770855b 132 */
jhon309 0:c52df770855b 133 PwmOut& operator= (float value) {
jhon309 0:c52df770855b 134 write(value);
jhon309 0:c52df770855b 135 return *this;
jhon309 0:c52df770855b 136 }
jhon309 0:c52df770855b 137
jhon309 0:c52df770855b 138 PwmOut& operator= (PwmOut& rhs) {
jhon309 0:c52df770855b 139 write(rhs.read());
jhon309 0:c52df770855b 140 return *this;
jhon309 0:c52df770855b 141 }
jhon309 0:c52df770855b 142
jhon309 0:c52df770855b 143 /** An operator shorthand for read()
jhon309 0:c52df770855b 144 */
jhon309 0:c52df770855b 145 operator float() {
jhon309 0:c52df770855b 146 return read();
jhon309 0:c52df770855b 147 }
jhon309 0:c52df770855b 148 #endif
jhon309 0:c52df770855b 149
jhon309 0:c52df770855b 150 protected:
jhon309 0:c52df770855b 151 pwmout_t _pwm;
jhon309 0:c52df770855b 152 };
jhon309 0:c52df770855b 153
jhon309 0:c52df770855b 154 } // namespace mbed
jhon309 0:c52df770855b 155
jhon309 0:c52df770855b 156 #endif
jhon309 0:c52df770855b 157
jhon309 0:c52df770855b 158 #endif