Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

AnalogIn.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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