Vladimir Vana / mbed

pro vyuku PSS v Jecne

AnalogIn.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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