mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

hal/analogin_api.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
149:156823d33999 
mbed library release version 165

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