Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/analogin_api.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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