ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

hal/analogout_api.h@1:f30bdcd2b33b, 2017-02-27 (annotated)

Committer:
jacobjohnson
Date:
Mon Feb 27 17:45:05 2017 +0000
Revision:
1:f30bdcd2b33b
Parent:
0:098463de4c5d 
changed the inputscale from 1 to 7 in analogin_api.c.  This will need to be changed later, and accessed from the main level, but for now this allows the  adc to read a value from 0 to 3.7V, instead of just up to 1V.;

Who changed what in which revision?

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