Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

AnalogOut Class Reference
Public Member Functions

AnalogOut Class Reference
[AnalogOut class]

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.
 AnalogOut (const PinMap &&)
 Create an AnalogOut connected to the specified pin.
void write (float value)
 Set the output voltage, specified as a percentage (float)
void write_u16 (unsigned short value)
 Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF].
float read ()
 Return the current output voltage setting, measured as a percentage (float)
AnalogOut & operator= (float percent)
 An operator shorthand for write()
AnalogOut & operator= (AnalogOut &rhs)
 An operator shorthand for write()
 operator float ()
 An operator shorthand for read()
virtual ~AnalogOut ()

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 56 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 64 of file AnalogOut.h.

AnalogOut ( const PinMap &&   )

Create an AnalogOut connected to the specified pin.

Parameters:
pinmapreference to structure which holds static pinmap.
virtual ~AnalogOut (  ) [virtual]

Deinitialize pin configuration.

Definition at line 136 of file AnalogOut.h.

Member Function Documentation

operator float (  )

An operator shorthand for read()

See also:
AnalogOut::read()

Definition at line 130 of file AnalogOut.h.

AnalogOut& operator= ( AnalogOut &  rhs )

An operator shorthand for write()

See also:
AnalogOut::write()

Definition at line 120 of file AnalogOut.h.

AnalogOut& operator= ( float  percent )

An operator shorthand for write()

See also:
AnalogOut::write()

Definition at line 110 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 38 of file AnalogOut.cpp.

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 24 of file AnalogOut.cpp.

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 31 of file AnalogOut.cpp.

Generated on Tue Jul 12 2022 13:55:42 by  doxygen 1.7.2