Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

mbed-os/drivers/PwmOut.h@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

Who changed what in which revision?

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