Geo Electronics "Geo Counter" / Mbed 2 deprecated GEO_SHOW2ME_F411RE_CDY

CDY version that shares functionality with Counter

Dependencies:   SDFileSystem_HelloWorld mbed FATFileSystem

mbed/hal/analogin_api.h@0:aa13e1c335cd, 2018-11-04 (annotated)

Committer:
Charles David Young
Date:
Sun Nov 04 18:44:51 2018 -0700
Revision:
0:aa13e1c335cd
create new repo for show2me

Who changed what in which revision?

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