Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/AnalogOut.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

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