EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/analogout_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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