Pravin Sarode / Mymbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

hal/analogin_api.h@151:acf04f8e7d03, 2016-11-19 (annotated)

Committer:
pravinautosys
Date:
Sat Nov 19 10:38:54 2016 +0000
Revision:
151:acf04f8e7d03
Parent:
149:156823d33999 
MyMBED-DEVWithSTM32F303K8T6;

Who changed what in which revision?

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