DSP Book Yeditepe / mbed_f401re

mbed library sources with internal temperature sensor for nucleo f401

api/AnalogIn.h@0:7e2bd16f80af, 2015-01-17 (annotated)

Committer:
elessair
Date:
Sat Jan 17 18:03:58 2015 +0000
Revision:
0:7e2bd16f80af
nucleo f401re internal temperature added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:7e2bd16f80af 1 /* mbed Microcontroller Library
elessair 0:7e2bd16f80af 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:7e2bd16f80af 3 *
elessair 0:7e2bd16f80af 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:7e2bd16f80af 5 * you may not use this file except in compliance with the License.
elessair 0:7e2bd16f80af 6 * You may obtain a copy of the License at
elessair 0:7e2bd16f80af 7 *
elessair 0:7e2bd16f80af 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:7e2bd16f80af 9 *
elessair 0:7e2bd16f80af 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:7e2bd16f80af 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:7e2bd16f80af 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:7e2bd16f80af 13 * See the License for the specific language governing permissions and
elessair 0:7e2bd16f80af 14 * limitations under the License.
elessair 0:7e2bd16f80af 15 */
elessair 0:7e2bd16f80af 16 #ifndef MBED_ANALOGIN_H
elessair 0:7e2bd16f80af 17 #define MBED_ANALOGIN_H
elessair 0:7e2bd16f80af 18
elessair 0:7e2bd16f80af 19 #include "platform.h"
elessair 0:7e2bd16f80af 20
elessair 0:7e2bd16f80af 21 #if DEVICE_ANALOGIN
elessair 0:7e2bd16f80af 22
elessair 0:7e2bd16f80af 23 #include "analogin_api.h"
elessair 0:7e2bd16f80af 24
elessair 0:7e2bd16f80af 25 namespace mbed {
elessair 0:7e2bd16f80af 26
elessair 0:7e2bd16f80af 27 /** An analog input, used for reading the voltage on a pin
elessair 0:7e2bd16f80af 28 *
elessair 0:7e2bd16f80af 29 * Example:
elessair 0:7e2bd16f80af 30 * @code
elessair 0:7e2bd16f80af 31 * // Print messages when the AnalogIn is greater than 50%
elessair 0:7e2bd16f80af 32 *
elessair 0:7e2bd16f80af 33 * #include "mbed.h"
elessair 0:7e2bd16f80af 34 *
elessair 0:7e2bd16f80af 35 * AnalogIn temperature(p20);
elessair 0:7e2bd16f80af 36 *
elessair 0:7e2bd16f80af 37 * int main() {
elessair 0:7e2bd16f80af 38 * while(1) {
elessair 0:7e2bd16f80af 39 * if(temperature > 0.5) {
elessair 0:7e2bd16f80af 40 * printf("Too hot! (%f)", temperature.read());
elessair 0:7e2bd16f80af 41 * }
elessair 0:7e2bd16f80af 42 * }
elessair 0:7e2bd16f80af 43 * }
elessair 0:7e2bd16f80af 44 * @endcode
elessair 0:7e2bd16f80af 45 */
elessair 0:7e2bd16f80af 46 class AnalogIn {
elessair 0:7e2bd16f80af 47
elessair 0:7e2bd16f80af 48 public:
elessair 0:7e2bd16f80af 49
elessair 0:7e2bd16f80af 50 /** Create an AnalogIn, connected to the specified pin
elessair 0:7e2bd16f80af 51 *
elessair 0:7e2bd16f80af 52 * @param pin AnalogIn pin to connect to
elessair 0:7e2bd16f80af 53 * @param name (optional) A string to identify the object
elessair 0:7e2bd16f80af 54 */
elessair 0:7e2bd16f80af 55 AnalogIn(PinName pin) {
elessair 0:7e2bd16f80af 56 analogin_init(&_adc, pin);
elessair 0:7e2bd16f80af 57 }
elessair 0:7e2bd16f80af 58
elessair 0:7e2bd16f80af 59 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
elessair 0:7e2bd16f80af 60 *
elessair 0:7e2bd16f80af 61 * @returns A floating-point value representing the current input voltage, measured as a percentage
elessair 0:7e2bd16f80af 62 */
elessair 0:7e2bd16f80af 63 float read() {
elessair 0:7e2bd16f80af 64 return analogin_read(&_adc);
elessair 0:7e2bd16f80af 65 }
elessair 0:7e2bd16f80af 66
elessair 0:7e2bd16f80af 67 /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
elessair 0:7e2bd16f80af 68 *
elessair 0:7e2bd16f80af 69 * @returns
elessair 0:7e2bd16f80af 70 * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value
elessair 0:7e2bd16f80af 71 */
elessair 0:7e2bd16f80af 72 unsigned short read_u16() {
elessair 0:7e2bd16f80af 73 return analogin_read_u16(&_adc);
elessair 0:7e2bd16f80af 74 }
elessair 0:7e2bd16f80af 75
elessair 0:7e2bd16f80af 76 #ifdef MBED_OPERATORS
elessair 0:7e2bd16f80af 77 /** An operator shorthand for read()
elessair 0:7e2bd16f80af 78 *
elessair 0:7e2bd16f80af 79 * The float() operator can be used as a shorthand for read() to simplify common code sequences
elessair 0:7e2bd16f80af 80 *
elessair 0:7e2bd16f80af 81 * Example:
elessair 0:7e2bd16f80af 82 * @code
elessair 0:7e2bd16f80af 83 * float x = volume.read();
elessair 0:7e2bd16f80af 84 * float x = volume;
elessair 0:7e2bd16f80af 85 *
elessair 0:7e2bd16f80af 86 * if(volume.read() > 0.25) { ... }
elessair 0:7e2bd16f80af 87 * if(volume > 0.25) { ... }
elessair 0:7e2bd16f80af 88 * @endcode
elessair 0:7e2bd16f80af 89 */
elessair 0:7e2bd16f80af 90 operator float() {
elessair 0:7e2bd16f80af 91 return read();
elessair 0:7e2bd16f80af 92 }
elessair 0:7e2bd16f80af 93 #endif
elessair 0:7e2bd16f80af 94
elessair 0:7e2bd16f80af 95 protected:
elessair 0:7e2bd16f80af 96 analogin_t _adc;
elessair 0:7e2bd16f80af 97 };
elessair 0:7e2bd16f80af 98
elessair 0:7e2bd16f80af 99 } // namespace mbed
elessair 0:7e2bd16f80af 100
elessair 0:7e2bd16f80af 101 #endif
elessair 0:7e2bd16f80af 102
elessair 0:7e2bd16f80af 103 #endif