An analog input, used for reading the voltage on a pin. More...

#include <AnalogIn.h>

Public Member Functions
	AnalogIn (const PinMap &pinmap)
	Create an AnalogIn, connected to the specified pin. More...

	AnalogIn (PinName pin)
	Create an AnalogIn, connected to the specified pin. More...

float	read ()
	Read the input voltage, represented as a float in the range [0.0, 1.0]. More...

unsigned short	read_u16 ()
	Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]. More...

	operator float ()
	An operator shorthand for read() More...

Detailed Description

An analog input, used for reading the voltage on a pin.

Note: Synchronization level: Thread safe

Example:

// Print messages when the AnalogIn is greater than 50%
#include "mbed.h"
AnalogIn temperature(p20);
int main() {
    while(1) {
        if(temperature > 0.5) {
            printf("Too hot! (%f)", temperature.read());
        }
    }
}

Definition at line 66 of file AnalogIn.h.

Constructor & Destructor Documentation

AnalogIn ( const PinMap & pinmap )

Create an AnalogIn, connected to the specified pin.

Parameters

pinmap reference to structure which holds static pinmap.

AnalogIn ( PinName pin )

Create an AnalogIn, connected to the specified pin.

Parameters

pin	AnalogIn pin to connect to

Member Function Documentation

operator float ( )

An operator shorthand for read()

The float() operator can be used as a shorthand for read() to simplify common code sequences

Example:

float x = volume.read();
float x = volume;
if(volume.read() > 0.25) { ... }
if(volume > 0.25) { ... }

Definition at line 109 of file AnalogIn.h.

float read ( )

Read the input voltage, represented as a float in the range [0.0, 1.0].

Returns: A floating-point value representing the current input voltage, measured as a percentage

unsigned short read_u16 ( )

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

Returns: 16-bit unsigned short representing the current input voltage, normalized to a 16-bit value

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Important Information for this Arm website