Jeremy Hammel / Mbed 2 deprecated ATT_Smart_Home

FRDM-K64F, Avnet M14A2A, Grove Shield, to create smart home system. In use with AT&Ts M2x & Flow.

Dependencies:   mbed FXOS8700CQ MODSERIAL

mbed/PwmOut.h@84:fc8c9b39723a, 2019-03-06 (annotated)

Committer:
jwhammel
Date:
Wed Mar 06 21:11:49 2019 +0000
Revision:
84:fc8c9b39723a
Embedded Systems Midterm Project Spring 2019

Who changed what in which revision?

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