mbed-drivers
Public Member Functions | Protected Attributes | List of all members
mbed::DigitalIn Class Reference

#include <DigitalIn.h>

Public Member Functions

 DigitalIn (PinName pin)
 
 DigitalIn (PinName pin, PinMode mode)
 
int read ()
 
void mode (PinMode pull)
 
 operator int ()
 

Protected Attributes

gpio_t gpio
 

Detailed Description

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

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

Constructor & Destructor Documentation

mbed::DigitalIn::DigitalIn ( PinName  pin)
inline

Create a DigitalIn connected to the specified pin

Parameters
pinDigitalIn pin to connect to
mbed::DigitalIn::DigitalIn ( PinName  pin,
PinMode  mode 
)
inline

Create a DigitalIn connected to the specified pin

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

Member Function Documentation

void mbed::DigitalIn::mode ( PinMode  pull)
inline

Set the input pin mode

Parameters
modePullUp, PullDown, PullNone, OpenDrain
mbed::DigitalIn::operator int ( )
inline

An operator shorthand for read()

int mbed::DigitalIn::read ( )
inline

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

The documentation for this class was generated from the following file: