mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

AnalogIn.h@59:0883845fe643, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:12:58 2013 +0000
Revision:
59:0883845fe643
Parent:
55:d722ed6a4237
Child:
65:5798e58a58b1
Add pinmap NC terminators for LPC1768 CAN.

Update the license from MIT to Apache v2.

Make the semihost code target independent using opportune defines for the UID and MAC.

Who changed what in which revision?

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