Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

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.

Dependencies:   mbed

mbed-os/hal/analogout_api.h@9:d58e77ebd769, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:12:37 2018 -0700
Revision:
9:d58e77ebd769
add mbed-os library

Who changed what in which revision?

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