mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/analogout_api.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
128:9bcdf88f62b0 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1
<> 128:9bcdf88f62b0 2 /** \addtogroup hal */
<> 128:9bcdf88f62b0 3 /** @{*/
<> 128:9bcdf88f62b0 4 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 5 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 172:65be27845400 6 * SPDX-License-Identifier: Apache-2.0
<> 128:9bcdf88f62b0 7 *
<> 128:9bcdf88f62b0 8 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 9 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 10 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 11 *
<> 128:9bcdf88f62b0 12 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 13 *
<> 128:9bcdf88f62b0 14 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 15 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 17 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 18 * limitations under the License.
<> 128:9bcdf88f62b0 19 */
<> 128:9bcdf88f62b0 20 #ifndef MBED_ANALOGOUT_API_H
<> 128:9bcdf88f62b0 21 #define MBED_ANALOGOUT_API_H
<> 128:9bcdf88f62b0 22
<> 128:9bcdf88f62b0 23 #include "device.h"
<> 128:9bcdf88f62b0 24
<> 128:9bcdf88f62b0 25 #if DEVICE_ANALOGOUT
<> 128:9bcdf88f62b0 26
<> 128:9bcdf88f62b0 27 #ifdef __cplusplus
<> 128:9bcdf88f62b0 28 extern "C" {
<> 128:9bcdf88f62b0 29 #endif
<> 128:9bcdf88f62b0 30
<> 128:9bcdf88f62b0 31 /** Analogout hal structure. dac_s is declared in the target's hal
<> 128:9bcdf88f62b0 32 */
<> 128:9bcdf88f62b0 33 typedef struct dac_s dac_t;
<> 128:9bcdf88f62b0 34
<> 128:9bcdf88f62b0 35 /**
<> 128:9bcdf88f62b0 36 * \defgroup hal_analogout Analogout hal functions
<> 128:9bcdf88f62b0 37 * @{
<> 128:9bcdf88f62b0 38 */
<> 128:9bcdf88f62b0 39
<> 128:9bcdf88f62b0 40 /** Initialize the analogout peripheral
<> 128:9bcdf88f62b0 41 *
<> 128:9bcdf88f62b0 42 * Configures the pin used by analogout.
<> 128:9bcdf88f62b0 43 * @param obj The analogout object to initialize
<> 128:9bcdf88f62b0 44 * @param pin The analogout pin name
<> 128:9bcdf88f62b0 45 */
<> 128:9bcdf88f62b0 46 void analogout_init(dac_t *obj, PinName pin);
<> 128:9bcdf88f62b0 47
<> 128:9bcdf88f62b0 48 /** Release the analogout object
<> 128:9bcdf88f62b0 49 *
<> 128:9bcdf88f62b0 50 * Note: This is not currently used in the mbed-drivers
<> 128:9bcdf88f62b0 51 * @param obj The analogout object
<> 128:9bcdf88f62b0 52 */
<> 128:9bcdf88f62b0 53 void analogout_free(dac_t *obj);
<> 128:9bcdf88f62b0 54
<> 128:9bcdf88f62b0 55 /** Set the output voltage, specified as a percentage (float)
<> 128:9bcdf88f62b0 56 *
<> 128:9bcdf88f62b0 57 * @param obj The analogin object
<> 128:9bcdf88f62b0 58 * @param value The floating-point output voltage to be set
<> 128:9bcdf88f62b0 59 */
<> 128:9bcdf88f62b0 60 void analogout_write(dac_t *obj, float value);
<> 128:9bcdf88f62b0 61
<> 128:9bcdf88f62b0 62 /** Set the output voltage, specified as unsigned 16-bit
<> 128:9bcdf88f62b0 63 *
<> 128:9bcdf88f62b0 64 * @param obj The analogin object
<> 128:9bcdf88f62b0 65 * @param value The unsigned 16-bit output voltage to be set
<> 128:9bcdf88f62b0 66 */
<> 128:9bcdf88f62b0 67 void analogout_write_u16(dac_t *obj, uint16_t value);
<> 128:9bcdf88f62b0 68
<> 128:9bcdf88f62b0 69 /** Read the current voltage value on the pin
<> 128:9bcdf88f62b0 70 *
<> 128:9bcdf88f62b0 71 * @param obj The analogin object
<> 128:9bcdf88f62b0 72 * @return A floating-point value representing the current voltage on the pin,
<> 128:9bcdf88f62b0 73 * measured as a percentage
<> 128:9bcdf88f62b0 74 */
<> 128:9bcdf88f62b0 75 float analogout_read(dac_t *obj);
<> 128:9bcdf88f62b0 76
<> 128:9bcdf88f62b0 77 /** Read the current voltage value on the pin, as a normalized unsigned 16bit value
<> 128:9bcdf88f62b0 78 *
<> 128:9bcdf88f62b0 79 * @param obj The analogin object
<> 128:9bcdf88f62b0 80 * @return An unsigned 16-bit value representing the current voltage on the pin
<> 128:9bcdf88f62b0 81 */
<> 128:9bcdf88f62b0 82 uint16_t analogout_read_u16(dac_t *obj);
<> 128:9bcdf88f62b0 83
<> 128:9bcdf88f62b0 84 /**@}*/
<> 128:9bcdf88f62b0 85
<> 128:9bcdf88f62b0 86 #ifdef __cplusplus
<> 128:9bcdf88f62b0 87 }
<> 128:9bcdf88f62b0 88 #endif
<> 128:9bcdf88f62b0 89
<> 128:9bcdf88f62b0 90 #endif
<> 128:9bcdf88f62b0 91
<> 128:9bcdf88f62b0 92 #endif
<> 128:9bcdf88f62b0 93
<> 128:9bcdf88f62b0 94 /** @}*/