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.

hal/analogin_api.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
128:9bcdf88f62b0
Child:
172:65be27845400
Release 147 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1
<> 128:9bcdf88f62b0 2 /** \addtogroup hal */
<> 128:9bcdf88f62b0 3 /** @{*/
<> 128:9bcdf88f62b0 4 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 5 * Copyright (c) 2006-2013 ARM Limited
<> 128:9bcdf88f62b0 6 *
<> 128:9bcdf88f62b0 7 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 8 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 9 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 10 *
<> 128:9bcdf88f62b0 11 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 12 *
<> 128:9bcdf88f62b0 13 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 14 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 16 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 17 * limitations under the License.
<> 128:9bcdf88f62b0 18 */
<> 128:9bcdf88f62b0 19 #ifndef MBED_ANALOGIN_API_H
<> 128:9bcdf88f62b0 20 #define MBED_ANALOGIN_API_H
<> 128:9bcdf88f62b0 21
<> 128:9bcdf88f62b0 22 #include "device.h"
<> 128:9bcdf88f62b0 23
<> 128:9bcdf88f62b0 24 #if DEVICE_ANALOGIN
<> 128:9bcdf88f62b0 25
<> 128:9bcdf88f62b0 26 #ifdef __cplusplus
<> 128:9bcdf88f62b0 27 extern "C" {
<> 128:9bcdf88f62b0 28 #endif
<> 128:9bcdf88f62b0 29
<> 128:9bcdf88f62b0 30 /** Analogin hal structure. analogin_s is declared in the target's hal
<> 128:9bcdf88f62b0 31 */
<> 128:9bcdf88f62b0 32 typedef struct analogin_s analogin_t;
<> 128:9bcdf88f62b0 33
<> 128:9bcdf88f62b0 34 /**
<> 128:9bcdf88f62b0 35 * \defgroup hal_analogin Analogin hal functions
<> 128:9bcdf88f62b0 36 * @{
<> 128:9bcdf88f62b0 37 */
<> 128:9bcdf88f62b0 38
<> 128:9bcdf88f62b0 39 /** Initialize the analogin peripheral
<> 128:9bcdf88f62b0 40 *
<> 128:9bcdf88f62b0 41 * Configures the pin used by analogin.
<> 128:9bcdf88f62b0 42 * @param obj The analogin object to initialize
<> 128:9bcdf88f62b0 43 * @param pin The analogin pin name
<> 128:9bcdf88f62b0 44 */
<> 128:9bcdf88f62b0 45 void analogin_init(analogin_t *obj, PinName pin);
<> 128:9bcdf88f62b0 46
<> 128:9bcdf88f62b0 47 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
<> 128:9bcdf88f62b0 48 *
<> 128:9bcdf88f62b0 49 * @param obj The analogin object
<> 128:9bcdf88f62b0 50 * @return A floating value representing the current input voltage
<> 128:9bcdf88f62b0 51 */
<> 128:9bcdf88f62b0 52 float analogin_read(analogin_t *obj);
<> 128:9bcdf88f62b0 53
<> 128:9bcdf88f62b0 54 /** Read the value from analogin pin, represented as an unsigned 16bit value
<> 128:9bcdf88f62b0 55 *
<> 128:9bcdf88f62b0 56 * @param obj The analogin object
<> 128:9bcdf88f62b0 57 * @return An unsigned 16bit value representing the current input voltage
<> 128:9bcdf88f62b0 58 */
<> 128:9bcdf88f62b0 59 uint16_t analogin_read_u16(analogin_t *obj);
<> 128:9bcdf88f62b0 60
<> 128:9bcdf88f62b0 61 /**@}*/
<> 128:9bcdf88f62b0 62
<> 128:9bcdf88f62b0 63 #ifdef __cplusplus
<> 128:9bcdf88f62b0 64 }
<> 128:9bcdf88f62b0 65 #endif
<> 128:9bcdf88f62b0 66
<> 128:9bcdf88f62b0 67 #endif
<> 128:9bcdf88f62b0 68
<> 128:9bcdf88f62b0 69 #endif
<> 128:9bcdf88f62b0 70
<> 128:9bcdf88f62b0 71 /** @}*/