mbed library sources. Supersedes mbed-src.
Dependents: Hobbyking_Cheetah_Compact Hobbyking_Cheetah_Compact_DRV8323_14bit Hobbyking_Cheetah_Compact_DRV8323_V51_201907 HKC_MiniCheetah ... more
Fork of mbed-dev by
hal/analogin_api.h
- Committer:
- benkatz
- Date:
- 2018-07-30
- Revision:
- 181:36facd806e4a
- Parent:
- 149:156823d33999
File content as of revision 181:36facd806e4a:
/** \addtogroup hal */ /** @{*/ /* mbed Microcontroller Library * Copyright (c) 2006-2013 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef MBED_ANALOGIN_API_H #define MBED_ANALOGIN_API_H #include "device.h" #if DEVICE_ANALOGIN #ifdef __cplusplus extern "C" { #endif /** Analogin hal structure. analogin_s is declared in the target's hal */ typedef struct analogin_s analogin_t; /** * \defgroup hal_analogin Analogin hal functions * @{ */ /** Initialize the analogin peripheral * * Configures the pin used by analogin. * @param obj The analogin object to initialize * @param pin The analogin pin name */ void analogin_init(analogin_t *obj, PinName pin); /** Read the input voltage, represented as a float in the range [0.0, 1.0] * * @param obj The analogin object * @return A floating value representing the current input voltage */ float analogin_read(analogin_t *obj); /** Read the value from analogin pin, represented as an unsigned 16bit value * * @param obj The analogin object * @return An unsigned 16bit value representing the current input voltage */ uint16_t analogin_read_u16(analogin_t *obj); /**@}*/ #ifdef __cplusplus } #endif #endif #endif /** @}*/