Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/analogin_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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