Einstein Filho / Mbed 2 deprecated MANGUEBAJA2019_BOX

Mangue Baja Box

Dependencies:   mbed

mbed/AnalogIn.h@0:0dee8840a1c0, 2019-07-29 (annotated)

Committer:
einsteingustavo
Date:
Mon Jul 29 20:38:00 2019 +0000
Revision:
0:0dee8840a1c0
Mangue Baja Box

Who changed what in which revision?

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