Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

mbed-os/drivers/AnalogIn.h@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

Who changed what in which revision?

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