Digital IO
Public Member Functions
DigitalPin< PinNumber > Class Template Reference

Fast AVR digital port I/O. More...

#include <DigitalPin.h>

List of all members.

Public Member Functions

 DigitalPin ()
 DigitalPin (bool pinMode)
 DigitalPin (bool mode, bool level)
void config (bool mode, bool level)
void high ()
void low ()
void mode (bool pinMode)
 operator bool () const
DigitalPinoperator= (bool value)
bool read () const
void toggle ()
void write (bool value)

Detailed Description

template<uint8_t PinNumber>
class DigitalPin< PinNumber >

Fast AVR digital port I/O.

Definition at line 498 of file DigitalPin.h.


Constructor & Destructor Documentation

template<uint8_t PinNumber>
DigitalPin< PinNumber >::DigitalPin ( ) [inline]

Constructor

Definition at line 502 of file DigitalPin.h.

template<uint8_t PinNumber>
DigitalPin< PinNumber >::DigitalPin ( bool  pinMode) [inline, explicit]

Constructor

Parameters:
[in]pinModeif true set output mode else input mode.

Definition at line 507 of file DigitalPin.h.

template<uint8_t PinNumber>
DigitalPin< PinNumber >::DigitalPin ( bool  mode,
bool  level 
) [inline]

Constructor

Parameters:
[in]modeIf true set output mode else input mode
[in]levelIf mode is output, set level high/low. If mode is input, enable or disable the pin's 20K pullup.

Definition at line 516 of file DigitalPin.h.


Member Function Documentation

template<uint8_t PinNumber>
void DigitalPin< PinNumber >::config ( bool  mode,
bool  level 
) [inline]

set pin configuration

Parameters:
[in]modeIf true set output mode else input mode
[in]levelIf mode is output, set level high/low. If mode is input, enable or disable the pin's 20K pullup.

Definition at line 544 of file DigitalPin.h.

template<uint8_t PinNumber>
void DigitalPin< PinNumber >::high ( ) [inline]

Set pin level high if output mode or enable 20K pullup if input mode.

Definition at line 552 of file DigitalPin.h.

template<uint8_t PinNumber>
void DigitalPin< PinNumber >::low ( ) [inline]

Set pin level low if output mode or disable 20K pullup if input mode.

Definition at line 558 of file DigitalPin.h.

template<uint8_t PinNumber>
void DigitalPin< PinNumber >::mode ( bool  pinMode) [inline]

Set pin mode

Parameters:
[in]pinModeif true set output mode else input mode.

mode() does not enable or disable the 20K pullup for input mode.

Definition at line 567 of file DigitalPin.h.

template<uint8_t PinNumber>
DigitalPin< PinNumber >::operator bool ( ) const [inline]

Parenthesis operator

Returns:
Pin's level

Definition at line 534 of file DigitalPin.h.

template<uint8_t PinNumber>
DigitalPin& DigitalPin< PinNumber >::operator= ( bool  value) [inline]

Asignment operator

Parameters:
[in]valueIf true set the pin's level high else set the pin's level low.
Returns:
This DigitalPin instance.

Definition at line 526 of file DigitalPin.h.

template<uint8_t PinNumber>
bool DigitalPin< PinNumber >::read ( ) const [inline]
Returns:
Pin's level

Definition at line 573 of file DigitalPin.h.

template<uint8_t PinNumber>
void DigitalPin< PinNumber >::toggle ( ) [inline]

toggle a pin

If the pin is in output mode toggle the pin's level. If the pin is in input mode toggle the state of the 20K pullup.

Definition at line 583 of file DigitalPin.h.

template<uint8_t PinNumber>
void DigitalPin< PinNumber >::write ( bool  value) [inline]

Write the pin's level.

Parameters:
[in]valueIf true set the pin's level high else set the pin's level low.

Definition at line 592 of file DigitalPin.h.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Defines