mbed library sources. Supersedes mbed-src.
Dependents: Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more
analogout_api.h
00001 00002 /** \addtogroup hal */ 00003 /** @{*/ 00004 /* mbed Microcontroller Library 00005 * Copyright (c) 2006-2013 ARM Limited 00006 * SPDX-License-Identifier: Apache-2.0 00007 * 00008 * Licensed under the Apache License, Version 2.0 (the "License"); 00009 * you may not use this file except in compliance with the License. 00010 * You may obtain a copy of the License at 00011 * 00012 * http://www.apache.org/licenses/LICENSE-2.0 00013 * 00014 * Unless required by applicable law or agreed to in writing, software 00015 * distributed under the License is distributed on an "AS IS" BASIS, 00016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00017 * See the License for the specific language governing permissions and 00018 * limitations under the License. 00019 */ 00020 #ifndef MBED_ANALOGOUT_API_H 00021 #define MBED_ANALOGOUT_API_H 00022 00023 #include "device.h" 00024 00025 #if DEVICE_ANALOGOUT 00026 00027 #ifdef __cplusplus 00028 extern "C" { 00029 #endif 00030 00031 /** Analogout hal structure. dac_s is declared in the target's hal 00032 */ 00033 typedef struct dac_s dac_t; 00034 00035 /** 00036 * \defgroup hal_analogout Analogout hal functions 00037 * @{ 00038 */ 00039 00040 /** Initialize the analogout peripheral 00041 * 00042 * Configures the pin used by analogout. 00043 * @param obj The analogout object to initialize 00044 * @param pin The analogout pin name 00045 */ 00046 void analogout_init(dac_t *obj, PinName pin); 00047 00048 /** Release the analogout object 00049 * 00050 * Note: This is not currently used in the mbed-drivers 00051 * @param obj The analogout object 00052 */ 00053 void analogout_free(dac_t *obj); 00054 00055 /** Set the output voltage, specified as a percentage (float) 00056 * 00057 * @param obj The analogin object 00058 * @param value The floating-point output voltage to be set 00059 */ 00060 void analogout_write(dac_t *obj, float value); 00061 00062 /** Set the output voltage, specified as unsigned 16-bit 00063 * 00064 * @param obj The analogin object 00065 * @param value The unsigned 16-bit output voltage to be set 00066 */ 00067 void analogout_write_u16(dac_t *obj, uint16_t value); 00068 00069 /** Read the current voltage value on the pin 00070 * 00071 * @param obj The analogin object 00072 * @return A floating-point value representing the current voltage on the pin, 00073 * measured as a percentage 00074 */ 00075 float analogout_read(dac_t *obj); 00076 00077 /** Read the current voltage value on the pin, as a normalized unsigned 16bit value 00078 * 00079 * @param obj The analogin object 00080 * @return An unsigned 16-bit value representing the current voltage on the pin 00081 */ 00082 uint16_t analogout_read_u16(dac_t *obj); 00083 00084 /**@}*/ 00085 00086 #ifdef __cplusplus 00087 } 00088 #endif 00089 00090 #endif 00091 00092 #endif 00093 00094 /** @}*/
Generated on Tue Jul 12 2022 20:41:14 by 1.7.2