FRDM-K64F, Avnet M14A2A, Grove Shield, to create smart home system. In use with AT&Ts M2x & Flow.

Dependencies:   mbed FXOS8700CQ MODSERIAL

Committer:
jwhammel
Date:
Mon Apr 29 04:24:38 2019 +0000
Revision:
85:0cf65ceb4492
Parent:
84:fc8c9b39723a
We have added an alarm trigger that gets sent to AT&T Flow.

Who changed what in which revision?

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