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

AnalogIn Class Reference
Public Member Functions

AnalogIn Class Reference
[AnalogIn class]

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.
 AnalogIn (PinName pin)
 Create an AnalogIn, connected to the specified pin.
float read ()
 Read the input voltage, represented as a float in the range [0.0, 1.0].
unsigned short read_u16 ()
 Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF].
 operator float ()
 An operator shorthand for read()

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:
pinmapreference to structure which holds static pinmap.

Definition at line 33 of file AnalogIn.cpp.

AnalogIn ( PinName  pin )

Create an AnalogIn, connected to the specified pin.

Parameters:
pinAnalogIn pin to connect to

Definition at line 26 of file AnalogIn.cpp.

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

Definition at line 41 of file AnalogIn.cpp.

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

Definition at line 49 of file AnalogIn.cpp.

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