BA / Mbed OS BaBoRo1

Erste version der Software für der Prototyp

mbed-os/hal/analogin_api.h@4:75df35ef4fb6, 2018-03-30 (annotated)

Committer:
borlanic
Date:
Fri Mar 30 14:07:05 2018 +0000
Revision:
4:75df35ef4fb6
Parent:
0:380207fcb5c1 
commentar

Who changed what in which revision?

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