mbed-drivers
Public Member Functions | Protected Attributes | List of all members
mbed::AnalogOut Class Reference

#include <AnalogOut.h>

Public Member Functions

 AnalogOut (PinName pin)
 
void write (float value)
 
void write_u16 (unsigned short value)
 
float read ()
 
AnalogOutoperator= (float percent)
 
AnalogOutoperator= (AnalogOut &rhs)
 
 operator float ()
 

Protected Attributes

dac_t _dac
 

Detailed Description

An analog output, used for setting the voltage on a pin

Example:

// Make a sawtooth output
#include "mbed.h"
AnalogOut tri(p18);
int main() {
while(1) {
tri = tri + 0.01;
wait_us(1);
if(tri == 1) {
tri = 0;
}
}
}

Constructor & Destructor Documentation

mbed::AnalogOut::AnalogOut ( PinName  pin)
inline

Create an AnalogOut connected to the specified pin

Parameters
AnalogOutpin to connect to (18)

Member Function Documentation

mbed::AnalogOut::operator float ( )
inline

An operator shorthand for read()

AnalogOut& mbed::AnalogOut::operator= ( float  percent)
inline

An operator shorthand for write()

float mbed::AnalogOut::read ( )
inline

Return the current output voltage setting, measured as a percentage (float)

Returns
A floating-point value representing the current voltage being output on the pin, measured as a percentage. The returned value will lie between 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
Note
This value may not match exactly the value set by a previous write().
void mbed::AnalogOut::write ( float  value)
inline

Set the output voltage, specified as a percentage (float)

Parameters
valueA floating-point value representing the output voltage, specified as a percentage. The value should lie between 0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%). Values outside this range will be saturated to 0.0f or 1.0f.
void mbed::AnalogOut::write_u16 ( unsigned short  value)
inline

Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]

Parameters
value16-bit unsigned short representing the output voltage, normalised to a 16-bit value (0x0000 = 0v, 0xFFFF = 3.3v)

The documentation for this class was generated from the following file: