George Roussos / BLE_Temperature

BLE temperature profile using digital DS1820 or analog LM35 sensors

Dependencies:   DS1820

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

Committer:
gkroussos
Date:
Sat Mar 07 16:23:41 2015 +0000
Revision:
0:637031152314
Working version 1.0

Who changed what in which revision?

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