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