TUKS MCU Introductory course / TUKS-COURSE-TIMER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-dev/hal/analogin_api.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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