Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/hal/analogin_api.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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