Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Embed: (wiki syntax)

« Back to documentation index

DigitalIn Class Reference
Public Member Functions | Static Public Member Functions

DigitalIn Class Reference

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

#include <DigitalIn.h>

Inherits mbed::Base.

Public Member Functions

 DigitalIn (PinName pin, const char *name=NULL)
 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.
 operator int ()
 An operator shorthand for read()
virtual struct rpc_method * get_rpc_methods ()
 Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass).
void register_object (const char *name)
 Registers this object with the given name, so that it can be looked up with lookup.
const char * name ()
 Returns the name of the object.
virtual bool rpc (const char *method, const char *arguments, char *result)
 Call the given method with the given arguments, and write the result into the string pointed to by result.

Static Public Member Functions

static bool rpc (const char *name, const char *method, const char *arguments, char *result)
 Use the lookup function to lookup an object and, if successful, call its rpc method.
static Base * lookup (const char *name, unsigned int len)
 Lookup and return the object that has the given name.
template<class C >
static void add_rpc_class ()
 Add the class to the list of classes which can have static methods called via rpc (the static methods which can be called are defined by that class' get_rpc_class() static method).

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

Definition at line 36 of file DigitalIn.h.

Constructor & Destructor Documentation

DigitalIn ( PinName  pin,
const char *  name = NULL 
)

Create a DigitalIn connected to the specified pin.

Parameters:
pinDigitalIn pin to connect to
name(optional) A string to identify the object

Member Function Documentation

static void add_rpc_class (  ) [static, inherited]

Add the class to the list of classes which can have static methods called via rpc (the static methods which can be called are defined by that class' get_rpc_class() static method).

Definition at line 143 of file Base.h.

virtual struct rpc_method* get_rpc_methods (  ) [read, virtual]

Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass).

Example 

 class Example : public Base {
     int foo(int a, int b) { return a + b; }
     virtual const struct rpc_method *get_rpc_methods() {
         static const rpc_method rpc_methods[] = {
             { "foo", generic_caller<int, Example, int, int, &Example::foo> },
             RPC_METHOD_SUPER(Base)
         };
         return rpc_methods;
     }
 };

Reimplemented from Base.

static Base* lookup ( const char *  name,
unsigned int  len 
) [static, inherited]

Lookup and return the object that has the given name.

Parameters:
namethe name to lookup.
lenthe length of name.
void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone, OpenDrain
const char* name (  ) [inherited]

Returns the name of the object.

Returns:
The name of the object, or NULL if it has no name.
operator int (  )

An operator shorthand for read()

Definition at line 71 of file 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 53 of file DigitalIn.h.

void register_object ( const char *  name ) [inherited]

Registers this object with the given name, so that it can be looked up with lookup.

If this object has already been registered, then this just changes the name.

Parameters:
nameThe name to give the object. If NULL we do nothing.
virtual bool rpc ( const char *  method,
const char *  arguments,
char *  result 
) [virtual, inherited]

Call the given method with the given arguments, and write the result into the string pointed to by result.

The default implementation calls rpc_methods to determine the supported methods.

Parameters:
methodThe name of the method to call.
argumentsA list of arguments separated by spaces.
resultA pointer to a string to write the result into. May be NULL, in which case nothing is written.
Returns:
true if method corresponds to a valid rpc method, or false otherwise.
static bool rpc ( const char *  name,
const char *  method,
const char *  arguments,
char *  result 
) [static, inherited]

Use the lookup function to lookup an object and, if successful, call its rpc method.

Returns:
false if name does not correspond to an object, otherwise the return value of the call to the object's rpc method.
Generated on Tue Jul 12 2022 11:27:31 by  doxygen 1.7.2