kushagra brahmbhatt / IoT_Security

IoT Home Alarm System

Dependents:   IoTBurglar_and_Fire_AlarmSystem

AnalogOut.h@0:2f388b030837, 2016-04-29 (annotated)

Committer:
kbrahmbhatt6
Date:
Fri Apr 29 06:59:59 2016 +0000
Revision:
0:2f388b030837
1

Who changed what in which revision?

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