Yihui Xiong / BLE_NODE_TEST

Test code for Grove Node BLE

Dependencies:   BLE_API nRF51822

Fork of BLE_LoopbackUART by Bluetooth Low Energy

mbed-src/api/AnalogOut.h@10:22480ac31879, 2014-11-27 (annotated)

Committer:
yihui
Date:
Thu Nov 27 09:30:36 2014 +0000
Revision:
10:22480ac31879
Parent:
9:05f0b5a3a70a 
change to new revision hardware

Who changed what in which revision?

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