Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/AnalogIn.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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