Gan likun / The prosthetic control

The prosthetic control（MIT）

hal/analogin_api.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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