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.

AnalogIn.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1
Child:
123:b0220dba8be7
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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