cc y / mbed

ads1115 only

Fork of mbed by mbed official

AnalogIn.h@123:b0220dba8be7, 2016-08-12 (annotated)

Committer:
Kojto
Date:
Fri Aug 12 13:04:35 2016 +0200
Revision:
123:b0220dba8be7
Parent:
122:f9eeca106725 
Release 123 of the mbed library



Changes:

- new targets: nucleo_f207zg, beetle, nrf51_dk, hexiwear,

 nuvoton nuc472, vk rz a1h

- ST - fix timer interrupt handler, sleep api fix

- NXP - lpc15xx us ticker fix

- Nordic - analogin fixes, LF clock init addition, enable i2c async

Who changed what in which revision?

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