Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/hal/analogout_api.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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