Jhon Plantikow / I2C_EEPROM

I2C_EEPROM

AnalogIn.h@0:ac8863619623, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:23:16 2015 +0000
Revision:
0:ac8863619623
I2C

Who changed what in which revision?

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