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/drivers/AnalogOut.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 /* mbed Microcontroller Library
vipinranka 12:9a20164dcc47 2 * Copyright (c) 2006-2013 ARM Limited
vipinranka 12:9a20164dcc47 3 *
vipinranka 12:9a20164dcc47 4 * Licensed under the Apache License, Version 2.0 (the "License");
vipinranka 12:9a20164dcc47 5 * you may not use this file except in compliance with the License.
vipinranka 12:9a20164dcc47 6 * You may obtain a copy of the License at
vipinranka 12:9a20164dcc47 7 *
vipinranka 12:9a20164dcc47 8 * http://www.apache.org/licenses/LICENSE-2.0
vipinranka 12:9a20164dcc47 9 *
vipinranka 12:9a20164dcc47 10 * Unless required by applicable law or agreed to in writing, software
vipinranka 12:9a20164dcc47 11 * distributed under the License is distributed on an "AS IS" BASIS,
vipinranka 12:9a20164dcc47 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
vipinranka 12:9a20164dcc47 13 * See the License for the specific language governing permissions and
vipinranka 12:9a20164dcc47 14 * limitations under the License.
vipinranka 12:9a20164dcc47 15 */
vipinranka 12:9a20164dcc47 16 #ifndef MBED_ANALOGOUT_H
vipinranka 12:9a20164dcc47 17 #define MBED_ANALOGOUT_H
vipinranka 12:9a20164dcc47 18
vipinranka 12:9a20164dcc47 19 #include "platform/platform.h"
vipinranka 12:9a20164dcc47 20
vipinranka 12:9a20164dcc47 21 #if DEVICE_ANALOGOUT
vipinranka 12:9a20164dcc47 22
vipinranka 12:9a20164dcc47 23 #include "hal/analogout_api.h"
vipinranka 12:9a20164dcc47 24 #include "platform/PlatformMutex.h"
vipinranka 12:9a20164dcc47 25
vipinranka 12:9a20164dcc47 26 namespace mbed {
vipinranka 12:9a20164dcc47 27 /** \addtogroup drivers */
vipinranka 12:9a20164dcc47 28 /** @{*/
vipinranka 12:9a20164dcc47 29
vipinranka 12:9a20164dcc47 30 /** An analog output, used for setting the voltage on a pin
vipinranka 12:9a20164dcc47 31 *
vipinranka 12:9a20164dcc47 32 * @Note Synchronization level: Thread safe
vipinranka 12:9a20164dcc47 33 *
vipinranka 12:9a20164dcc47 34 * Example:
vipinranka 12:9a20164dcc47 35 * @code
vipinranka 12:9a20164dcc47 36 * // Make a sawtooth output
vipinranka 12:9a20164dcc47 37 *
vipinranka 12:9a20164dcc47 38 * #include "mbed.h"
vipinranka 12:9a20164dcc47 39 *
vipinranka 12:9a20164dcc47 40 * AnalogOut tri(p18);
vipinranka 12:9a20164dcc47 41 * int main() {
vipinranka 12:9a20164dcc47 42 * while(1) {
vipinranka 12:9a20164dcc47 43 * tri = tri + 0.01;
vipinranka 12:9a20164dcc47 44 * wait_us(1);
vipinranka 12:9a20164dcc47 45 * if(tri == 1) {
vipinranka 12:9a20164dcc47 46 * tri = 0;
vipinranka 12:9a20164dcc47 47 * }
vipinranka 12:9a20164dcc47 48 * }
vipinranka 12:9a20164dcc47 49 * }
vipinranka 12:9a20164dcc47 50 * @endcode
vipinranka 12:9a20164dcc47 51 */
vipinranka 12:9a20164dcc47 52 class AnalogOut {
vipinranka 12:9a20164dcc47 53
vipinranka 12:9a20164dcc47 54 public:
vipinranka 12:9a20164dcc47 55
vipinranka 12:9a20164dcc47 56 /** Create an AnalogOut connected to the specified pin
vipinranka 12:9a20164dcc47 57 *
vipinranka 12:9a20164dcc47 58 * @param AnalogOut pin to connect to (18)
vipinranka 12:9a20164dcc47 59 */
vipinranka 12:9a20164dcc47 60 AnalogOut(PinName pin) {
vipinranka 12:9a20164dcc47 61 analogout_init(&_dac, pin);
vipinranka 12:9a20164dcc47 62 }
vipinranka 12:9a20164dcc47 63
vipinranka 12:9a20164dcc47 64 /** Set the output voltage, specified as a percentage (float)
vipinranka 12:9a20164dcc47 65 *
vipinranka 12:9a20164dcc47 66 * @param value A floating-point value representing the output voltage,
vipinranka 12:9a20164dcc47 67 * specified as a percentage. The value should lie between
vipinranka 12:9a20164dcc47 68 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
vipinranka 12:9a20164dcc47 69 * Values outside this range will be saturated to 0.0f or 1.0f.
vipinranka 12:9a20164dcc47 70 */
vipinranka 12:9a20164dcc47 71 void write(float value) {
vipinranka 12:9a20164dcc47 72 lock();
vipinranka 12:9a20164dcc47 73 analogout_write(&_dac, value);
vipinranka 12:9a20164dcc47 74 unlock();
vipinranka 12:9a20164dcc47 75 }
vipinranka 12:9a20164dcc47 76
vipinranka 12:9a20164dcc47 77 /** Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
vipinranka 12:9a20164dcc47 78 *
vipinranka 12:9a20164dcc47 79 * @param value 16-bit unsigned short representing the output voltage,
vipinranka 12:9a20164dcc47 80 * normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)
vipinranka 12:9a20164dcc47 81 */
vipinranka 12:9a20164dcc47 82 void write_u16(unsigned short value) {
vipinranka 12:9a20164dcc47 83 lock();
vipinranka 12:9a20164dcc47 84 analogout_write_u16(&_dac, value);
vipinranka 12:9a20164dcc47 85 unlock();
vipinranka 12:9a20164dcc47 86 }
vipinranka 12:9a20164dcc47 87
vipinranka 12:9a20164dcc47 88 /** Return the current output voltage setting, measured as a percentage (float)
vipinranka 12:9a20164dcc47 89 *
vipinranka 12:9a20164dcc47 90 * @returns
vipinranka 12:9a20164dcc47 91 * A floating-point value representing the current voltage being output on the pin,
vipinranka 12:9a20164dcc47 92 * measured as a percentage. The returned value will lie between
vipinranka 12:9a20164dcc47 93 * 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
vipinranka 12:9a20164dcc47 94 *
vipinranka 12:9a20164dcc47 95 * @note
vipinranka 12:9a20164dcc47 96 * This value may not match exactly the value set by a previous write().
vipinranka 12:9a20164dcc47 97 */
vipinranka 12:9a20164dcc47 98 float read() {
vipinranka 12:9a20164dcc47 99 lock();
vipinranka 12:9a20164dcc47 100 float ret = analogout_read(&_dac);
vipinranka 12:9a20164dcc47 101 unlock();
vipinranka 12:9a20164dcc47 102 return ret;
vipinranka 12:9a20164dcc47 103 }
vipinranka 12:9a20164dcc47 104
vipinranka 12:9a20164dcc47 105 /** An operator shorthand for write()
vipinranka 12:9a20164dcc47 106 */
vipinranka 12:9a20164dcc47 107 AnalogOut& operator= (float percent) {
vipinranka 12:9a20164dcc47 108 // Underlying write call is thread safe
vipinranka 12:9a20164dcc47 109 write(percent);
vipinranka 12:9a20164dcc47 110 return *this;
vipinranka 12:9a20164dcc47 111 }
vipinranka 12:9a20164dcc47 112
vipinranka 12:9a20164dcc47 113 AnalogOut& operator= (AnalogOut& rhs) {
vipinranka 12:9a20164dcc47 114 // Underlying write call is thread safe
vipinranka 12:9a20164dcc47 115 write(rhs.read());
vipinranka 12:9a20164dcc47 116 return *this;
vipinranka 12:9a20164dcc47 117 }
vipinranka 12:9a20164dcc47 118
vipinranka 12:9a20164dcc47 119 /** An operator shorthand for read()
vipinranka 12:9a20164dcc47 120 */
vipinranka 12:9a20164dcc47 121 operator float() {
vipinranka 12:9a20164dcc47 122 // Underlying read call is thread safe
vipinranka 12:9a20164dcc47 123 return read();
vipinranka 12:9a20164dcc47 124 }
vipinranka 12:9a20164dcc47 125
vipinranka 12:9a20164dcc47 126 virtual ~AnalogOut() {
vipinranka 12:9a20164dcc47 127 // Do nothing
vipinranka 12:9a20164dcc47 128 }
vipinranka 12:9a20164dcc47 129
vipinranka 12:9a20164dcc47 130 protected:
vipinranka 12:9a20164dcc47 131
vipinranka 12:9a20164dcc47 132 virtual void lock() {
vipinranka 12:9a20164dcc47 133 _mutex.lock();
vipinranka 12:9a20164dcc47 134 }
vipinranka 12:9a20164dcc47 135
vipinranka 12:9a20164dcc47 136 virtual void unlock() {
vipinranka 12:9a20164dcc47 137 _mutex.unlock();
vipinranka 12:9a20164dcc47 138 }
vipinranka 12:9a20164dcc47 139
vipinranka 12:9a20164dcc47 140 dac_t _dac;
vipinranka 12:9a20164dcc47 141 PlatformMutex _mutex;
vipinranka 12:9a20164dcc47 142 };
vipinranka 12:9a20164dcc47 143
vipinranka 12:9a20164dcc47 144 } // namespace mbed
vipinranka 12:9a20164dcc47 145
vipinranka 12:9a20164dcc47 146 #endif
vipinranka 12:9a20164dcc47 147
vipinranka 12:9a20164dcc47 148 #endif
vipinranka 12:9a20164dcc47 149
vipinranka 12:9a20164dcc47 150 /** @}*/