BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/hal/analogin_api.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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