Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
AnalogOut Class Reference

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

#include <AnalogOut.h>

Public Member Functions

 AnalogOut (PinName pin)
 Create an AnalogOut connected to the specified pin. More...
 
void write (float value)
 Set the output voltage, specified as a percentage (float) More...
 
void write_u16 (unsigned short value)
 Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]. More...
 
float read ()
 Return the current output voltage setting, measured as a percentage (float) More...
 
AnalogOutoperator= (float percent)
 An operator shorthand for write() More...
 
AnalogOutoperator= (AnalogOut &rhs)
 An operator shorthand for write() More...
 
 operator float ()
 An operator shorthand for read() More...
 

Detailed Description

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

Note
Synchronization level: Thread safe

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;
}
}
}

Definition at line 53 of file AnalogOut.h.

Constructor & Destructor Documentation

AnalogOut ( PinName  pin)

Create an AnalogOut connected to the specified pin.

Parameters
pinAnalogOut pin to connect to

Definition at line 61 of file AnalogOut.h.

Member Function Documentation

operator float ( )

An operator shorthand for read()

See also
AnalogOut::read()

Definition at line 133 of file AnalogOut.h.

AnalogOut& operator= ( float  percent)

An operator shorthand for write()

See also
AnalogOut::write()

Definition at line 113 of file AnalogOut.h.

AnalogOut& operator= ( AnalogOut rhs)

An operator shorthand for write()

See also
AnalogOut::write()

Definition at line 123 of file AnalogOut.h.

float read ( )

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().

Definition at line 102 of file AnalogOut.h.

void write ( float  value)

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.

Definition at line 73 of file AnalogOut.h.

void write_u16 ( unsigned short  value)

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

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

Definition at line 85 of file AnalogOut.h.

Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.