Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/drivers/AnalogIn.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

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