George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/AnalogOut.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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