Jasper Lee / mbed_helloworld

change some io settings for TWR-K22F-120M

Dependents:   twr_helloworld

AnalogIn.h@0:b16d94660a33, 2014-12-23 (annotated)

Committer:
Jasper_lee
Date:
Tue Dec 23 03:35:08 2014 +0000
Revision:
0:b16d94660a33
change some io setting used in TWR-K22F120M

Who changed what in which revision?

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