mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/AnalogIn.h@134:ad3be0349dc5, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 12:05:23 2017 +0000
Revision:
134:ad3be0349dc5
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 134 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3488: Dev stm i2c v2 unitary functions https://github.com/ARMmbed/mbed-os/pull/3488

3492: Fix #3463 CAN read() return value https://github.com/ARMmbed/mbed-os/pull/3492

3503: [LPC15xx] Ensure that PWM=1 is resolved correctly https://github.com/ARMmbed/mbed-os/pull/3503

3504: [LPC15xx] CAN implementation improvements https://github.com/ARMmbed/mbed-os/pull/3504

3539: NUCLEO_F412ZG - Add support of TRNG peripheral https://github.com/ARMmbed/mbed-os/pull/3539

3540: STM: SPI: Initialize Rx in spi_master_write https://github.com/ARMmbed/mbed-os/pull/3540

3438: K64F: Add support for SERIAL ASYNCH API https://github.com/ARMmbed/mbed-os/pull/3438

3519: MCUXpresso: Fix ENET driver to enable interrupts after interrupt handler is set https://github.com/ARMmbed/mbed-os/pull/3519

3544: STM32L4 deepsleep improvement https://github.com/ARMmbed/mbed-os/pull/3544

3546: NUCLEO-F412ZG - Add CAN peripheral https://github.com/ARMmbed/mbed-os/pull/3546

3551: Fix I2C driver for RZ/A1H https://github.com/ARMmbed/mbed-os/pull/3551

3558: K64F UART Asynch API: Fix synchronization issue https://github.com/ARMmbed/mbed-os/pull/3558

3563: LPC4088 - Fix vector checksum https://github.com/ARMmbed/mbed-os/pull/3563

3567: Dev stm32 F0 v1.7.0 https://github.com/ARMmbed/mbed-os/pull/3567

3577: Fixes linking errors when building with debug profile https://github.com/ARMmbed/mbed-os/pull/3577

Who changed what in which revision?

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