ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

drivers/AnalogIn.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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