Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/analogin_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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