teralytic / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed by teralytic

api/AnalogIn.h@148:4802eb17e82b, 2016-10-17 (annotated)

Committer:
rodriguise
Date:
Mon Oct 17 18:47:01 2016 +0000
Revision:
148:4802eb17e82b
Parent:
144:ef7eb2e8f9f7 
backup

Who changed what in which revision?

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