Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

drivers/AnalogIn.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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