cc y / mbed

ads1115 only

Fork of mbed by mbed official

hal/analogout_api.h@135:fce8a9387ed1, 2017-01-17 (annotated)

Committer:
kaoshen
Date:
Tue Jan 17 23:27:32 2017 +0000
Revision:
135:fce8a9387ed1
Parent:
128:9bcdf88f62b0 
333 ADS1115 ADC1

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