mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

PwmOut.h@123:b0220dba8be7, 2016-08-12 (annotated)

Committer:
Kojto
Date:
Fri Aug 12 13:04:35 2016 +0200
Revision:
123:b0220dba8be7
Parent:
122:f9eeca106725 
Release 123 of the mbed library



Changes:

- new targets: nucleo_f207zg, beetle, nrf51_dk, hexiwear,

 nuvoton nuc472, vk rz a1h

- ST - fix timer interrupt handler, sleep api fix

- NXP - lpc15xx us ticker fix

- Nordic - analogin fixes, LF clock init addition, enable i2c async

Who changed what in which revision?

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