ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

drivers/AnalogOut.h@1:f30bdcd2b33b, 2017-02-27 (annotated)

Committer:
jacobjohnson
Date:
Mon Feb 27 17:45:05 2017 +0000
Revision:
1:f30bdcd2b33b
Parent:
0:098463de4c5d 
changed the inputscale from 1 to 7 in analogin_api.c.  This will need to be changed later, and accessed from the main level, but for now this allows the  adc to read a value from 0 to 3.7V, instead of just up to 1V.;

Who changed what in which revision?

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