Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

analogin_api.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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