FFT LED Display / 4180_EditThis_copy

this hurts

Dependencies:   FFT

mbed/hal/analogin_api.h@0:d6c9b09b4042, 2020-12-02 (annotated)

Committer:
annieluo2
Date:
Wed Dec 02 18:02:03 2020 +0000
Revision:
0:d6c9b09b4042
boo

Who changed what in which revision?

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