Steve Kim / mbed-src

mbed library sources(for async_print)

Dependents:   AsyncPrint

Fork of mbed-src by mbed official

api/AnalogIn.h@566:85de60b2bbaf, 2015-06-15 (annotated)

Committer:
mbed_official
Date:
Mon Jun 15 13:15:08 2015 +0100
Revision:
566:85de60b2bbaf
Parent:
13:0645d8841f51 
Synchronized with git revision bf69fa1cfc0d4d59173af0a2d235c2fbc179e45c



Full URL: https://github.com/mbedmicro/mbed/commit/bf69fa1cfc0d4d59173af0a2d235c2fbc179e45c/



commit c4bf11cb6a0f36a1aca90cce128d7a8292df5bda

Merge: 0d58363 77a973c

Author: Mihail Stoyanov <wm@smode.org>

Date:   Mon Jun 15 14:41:28 2015 +0300



    Merge branch 'master' of https://github.com/mbedmicro/mbed



    Conflicts:

    	workspace_tools/targets.py



commit 0d58363887d11952b26dcefa3229a9a1457b155c

Author: Mihail Stoyanov <wm@smode.org>

Date:   Tue Jun 9 16:17:27 2015 +0300



    Added Nordic license for the soft device



commit d504a3b58af390c779cb7383df2223d0a500f70a

Merge: 2c5aab7 8902229

Author: Mihail Stoyanov <wm@smode.org>

Date:   Tue Jun 9 16:14:47 2015 +0300



    Merge branch 'master' of https://github.com/mbedmicro/mbed



commit 2c5aab74eba507d184b74166da059d4100841ff7

Author: Mihail Stoyanov <wm@smode.org>

Date:   Wed Jun 3 20:44:25 2015 +0300



    Add base MCU support for Cortex-M4. Tidy up targets.py



commit 59b868a517163bf8984baa6c87ad42f86af18391

Merge: 0e23067 927c31a

Author: Mihail Stoyanov <wm@smode.org>

Date:   Wed Jun 3 20:39:56 2015 +0300



    Merge branch 'master' of https://github.com/mbedmicro/mbed



commit 0e23067718c61808401311bb594ed25fb4ed62c6

Author: Mihail Stoyanov <wm@smode.org>

Date:   Tue Jun 2 16:08:08 2015 +0300



    Add the Delta NNN40 platform to releases



commit 62a585dcda553b6e3b5c84e90a55b465f0894863

Merge: e1cd545 7a1d25e

Author: Mihail Stoyanov <wm@smode.org>

Date:   Tue Jun 2 16:06:44 2015 +0300



    Merge branch 'master' of https://github.com/mbedmicro/mbed



    Conflicts:

    	workspace_tools/tests.py



commit e1cd545a9c92c4177f72da964d50d163dae5990f

Merge: 5c5e61f ffd5586

Author: Mihail Stoyanov <wm@smode.org>

Date:   Thu May 7 13:07:48 2015 +0300



    Merge branch 'master' of https://github.com/mbedmicro/mbed



commit 5c5e61f0ac38d91ad04738fd33af36f91452d984

Author: Mihail Stoyanov <wm@smode.org>

Date:   Thu May 7 13:07:35 2015 +0300



    Remove the Disco L053 from RTOS tests as it's not ready yet



commit e75efe346742fa22e124861fddf1b51c291f4219

Author: Mihail Stoyanov <wm@smode.org>

Date:   Wed May 6 13:49:05 2015 +0300



    Tidy up targets.py

Who changed what in which revision?

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