David Saul / mbed-dev-bin

R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more information

Fork of mbed-dev-bin by Lancaster University

AnalogOut.h@4:98796b85dcf3, 2017-05-23 (annotated)

Committer:
DavidMS
Date:
Tue May 23 12:27:33 2017 +0000
Revision:
4:98796b85dcf3
Parent:
0:e1a608bb55e8 
basic_microbit_tx_train_controller_code: R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more details

Who changed what in which revision?

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