Daniel Vizcaya / Mbed OS 04_RTOS_Embebidos

Entrega 3er corte - sistemas embebidos

mbed-os/hal/analogin_api.h@0:6ad07c9019fd, 2018-05-30 (annotated)

Committer:
Bethory
Date:
Wed May 30 00:01:50 2018 +0000
Revision:
0:6ad07c9019fd
Codigo de tales para todos los pasculaes

Who changed what in which revision?

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