analogin_api.h

00001 
00002 /** \addtogroup hal */
00003 /** @{*/
00004 /* mbed Microcontroller Library
00005  * Copyright (c) 2006-2013 ARM Limited
00006  * SPDX-License-Identifier: Apache-2.0
00007  *
00008  * Licensed under the Apache License, Version 2.0 (the "License");
00009  * you may not use this file except in compliance with the License.
00010  * You may obtain a copy of the License at
00011  *
00012  *     http://www.apache.org/licenses/LICENSE-2.0
00013  *
00014  * Unless required by applicable law or agreed to in writing, software
00015  * distributed under the License is distributed on an "AS IS" BASIS,
00016  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00017  * See the License for the specific language governing permissions and
00018  * limitations under the License.
00019  */
00020 #ifndef MBED_ANALOGIN_API_H
00021 #define MBED_ANALOGIN_API_H
00022 
00023 #include "device.h"
00024 
00025 #if DEVICE_ANALOGIN
00026 
00027 #ifdef __cplusplus
00028 extern "C" {
00029 #endif
00030 
00031 /** Analogin hal structure. analogin_s is declared in the target's hal
00032  */
00033 typedef struct analogin_s analogin_t;
00034 
00035 /**
00036  * \defgroup hal_analogin Analogin hal functions
00037  * @{
00038  */
00039 
00040 /** Initialize the analogin peripheral
00041  *
00042  * Configures the pin used by analogin.
00043  * @param obj The analogin object to initialize
00044  * @param pin The analogin pin name
00045  */
00046 void analogin_init(analogin_t *obj, PinName pin);
00047 
00048 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
00049  *
00050  * @param obj The analogin object
00051  * @return A floating value representing the current input voltage
00052  */
00053 float analogin_read(analogin_t *obj);
00054 
00055 /** Read the value from analogin pin, represented as an unsigned 16bit value
00056  *
00057  * @param obj The analogin object
00058  * @return An unsigned 16bit value representing the current input voltage
00059  */
00060 uint16_t analogin_read_u16(analogin_t *obj);
00061 
00062 /**@}*/
00063 
00064 #ifdef __cplusplus
00065 }
00066 #endif
00067 
00068 #endif
00069 
00070 #endif
00071 
00072 /** @}*/