Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

analogout_api.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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