mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Embed: (wiki syntax)

« Back to documentation index

DigitalIn Class Reference
Public Member Functions

DigitalIn Class Reference
[Drivers]

A digital input, used for reading the state of a pin. More...

#include <DigitalIn.h>

Public Member Functions

 DigitalIn (PinName pin)
 Create a DigitalIn connected to the specified pin.
 DigitalIn (PinName pin, PinMode mode)
 Create a DigitalIn connected to the specified pin.
int read ()
 Read the input, represented as 0 or 1 (int)
void mode (PinMode pull)
 Set the input pin mode.
int is_connected ()
 Return the output setting, represented as 0 or 1 (int)
 operator int ()
 An operator shorthand for read()
 DigitalIn (PinName pin)
 Create a DigitalIn connected to the specified pin.
 DigitalIn (PinName pin, PinMode mode)
 Create a DigitalIn connected to the specified pin.
int read ()
 Read the input, represented as 0 or 1 (int)
void mode (PinMode pull)
 Set the input pin mode.
int is_connected ()
 Return the output setting, represented as 0 or 1 (int)
 operator int ()
 An operator shorthand for read()

Detailed Description

A digital input, used for reading the state of a pin.

Note:
Synchronization level: Interrupt safe

Example: 

 // Flash an LED while a DigitalIn is true

 #include "mbed.h"

 DigitalIn enable(p5);
 DigitalOut led(LED1);

 int main() {
     while(1) {
         if(enable) {
             led = !led;
         }
         wait(0.25);
     }
 }

Definition at line 52 of file cmsis/BUILD/mbed/drivers/DigitalIn.h.

Constructor & Destructor Documentation

DigitalIn ( PinName  pin )

Create a DigitalIn connected to the specified pin.

Parameters:
pinDigitalIn pin to connect to

Definition at line 59 of file cmsis/BUILD/mbed/drivers/DigitalIn.h.

DigitalIn ( PinName  pin,
PinMode  mode 
)

Create a DigitalIn connected to the specified pin.

Parameters:
pinDigitalIn pin to connect to
modethe initial mode of the pin

Definition at line 70 of file cmsis/BUILD/mbed/drivers/DigitalIn.h.

DigitalIn ( PinName  pin )

Create a DigitalIn connected to the specified pin.

Parameters:
pinDigitalIn pin to connect to

Definition at line 59 of file drivers/DigitalIn.h.

DigitalIn ( PinName  pin,
PinMode  mode 
)

Create a DigitalIn connected to the specified pin.

Parameters:
pinDigitalIn pin to connect to
modethe initial mode of the pin

Definition at line 70 of file drivers/DigitalIn.h.

Member Function Documentation

int is_connected (  )

Return the output setting, represented as 0 or 1 (int)

Returns:
Non zero value if pin is connected to uc GPIO 0 if gpio object was initialized with NC

Definition at line 104 of file cmsis/BUILD/mbed/drivers/DigitalIn.h.

int is_connected (  )

Return the output setting, represented as 0 or 1 (int)

Returns:
Non zero value if pin is connected to uc GPIO 0 if gpio object was initialized with NC

Definition at line 104 of file drivers/DigitalIn.h.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
pullPullUp, PullDown, PullNone, OpenDrain

Definition at line 91 of file cmsis/BUILD/mbed/drivers/DigitalIn.h.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
pullPullUp, PullDown, PullNone, OpenDrain

Definition at line 91 of file drivers/DigitalIn.h.

operator int (  )

An operator shorthand for read()

See also:
DigitalIn::read() 
      DigitalIn  button(BUTTON1);
      DigitalOut led(LED1);
      led = button;   // Equivalent to led.write(button.read())

Definition at line 118 of file cmsis/BUILD/mbed/drivers/DigitalIn.h.

operator int (  )

An operator shorthand for read()

See also:
DigitalIn::read() 
      DigitalIn  button(BUTTON1);
      DigitalOut led(LED1);
      led = button;   // Equivalent to led.write(button.read())

Definition at line 118 of file drivers/DigitalIn.h.

int read (  )

Read the input, represented as 0 or 1 (int)

Returns:
An integer representing the state of the input pin, 0 for logical 0, 1 for logical 1

Definition at line 81 of file cmsis/BUILD/mbed/drivers/DigitalIn.h.

int read ( void   )

Read the input, represented as 0 or 1 (int)

Returns:
An integer representing the state of the input pin, 0 for logical 0, 1 for logical 1

Definition at line 81 of file drivers/DigitalIn.h.

Generated on Tue Jul 12 2022 20:41:17 by  doxygen 1.7.2