analogin_api.h

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