Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

AnalogIn.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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