George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/PwmOut.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

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