#include <InputPin.hh>

Inheritance diagram for InputPin:

Collaboration diagram for InputPin:

Public Types
enum	Mode { NORMAL_MODE = 0, PULLUP_MODE = 1 }

enum	Direction { MSB_FIRST = 0, LSB_FIRST = 1 }

Public Member Functions
	InputPin (Board::DigitalPin pin, Mode mode=NORMAL_MODE)

Mode	mode () const

uint8_t	pin () const

bool	is_set () const

bool	is_high () const

bool	is_on () const

bool	is_clear () const

bool	is_low () const

bool	is_off () const

bool	read () const

uint8_t	read (OutputPin &clk, Direction order=MSB_FIRST) const

	operator bool () const

Pin &	operator>> (uint8_t &var)

Static Public Member Functions
static void	mode (Board::DigitalPin pin, Mode mode)

static Mode	mode (Board::DigitalPin pin)

static uint8_t	MASK (uint8_t pin)

static volatile uint8_t *	PIN (uint8_t pin)

static volatile uint8_t *	DDR (uint8_t pin)

static volatile uint8_t *	PORT (uint8_t pin)

static bool	read (Board::DigitalPin pin)

Protected Member Functions
volatile uint8_t *	PIN () const

volatile uint8_t *	DDR () const

volatile uint8_t *	PORT () const

volatile uint8_t *	PCIMR () const

Protected Attributes
volatile uint8_t *const	m_sfr

const uint8_t	m_mask

const uint8_t	m_pin

Detailed Description

Abstract input pin. Allows pullup mode.

Definition at line 29 of file InputPin.hh.

Member Enumeration Documentation

enum Pin::Direction

inherited

Serialization directions; most or least significant bit first.

Enumerator
MSB_FIRST
LSB_FIRST

Definition at line 84 of file Pin.hh.

enum InputPin::Mode

Enumerator
NORMAL_MODE
PULLUP_MODE

Definition at line 31 of file InputPin.hh.

Constructor & Destructor Documentation

InputPin::InputPin	(	Board::DigitalPin	pin,
		Mode	mode = `NORMAL_MODE`
	)

inline

Construct abstract input pin given Arduino pin number.

Parameters

[in]	pin	number (digital pin).
[in]	mode	pin mode (default NORMAL_MODE).

Definition at line 41 of file InputPin.hh.

Member Function Documentation

static volatile uint8_t* Pin::DDR ( uint8_t pin )

inlinestaticinherited

Return pointer to Data Direction Register.

Parameters

[in] pin number.

Returns: DDR register pointer.

Definition at line 64 of file Pin.hh.

volatile uint8_t* Pin::DDR ( ) const

inlineprotectedinherited

Return pointer to Data Direction Register.

Returns: DDR register pointer.

Definition at line 245 of file Pin.hh.

bool Pin::is_clear ( ) const

inlineinherited

Return true(1) if the pin is clear otherwise false(0).

Returns: boolean.

Definition at line 142 of file Pin.hh.

bool Pin::is_high ( ) const

inlineinherited

Return true(1) if the pin is set otherwise false(0).

Returns: boolean.

Definition at line 122 of file Pin.hh.

bool Pin::is_low ( ) const

inlineinherited

Return true(1) if the pin is clear otherwise false(0).

Returns: boolean.

Definition at line 152 of file Pin.hh.

bool Pin::is_off ( ) const

inlineinherited

Return true(1) if the pin is clear otherwise false(0).

Returns: boolean.

Definition at line 162 of file Pin.hh.

bool Pin::is_on ( ) const

inlineinherited

Return true(1) if the pin is set otherwise false(0).

Returns: boolean.

Definition at line 132 of file Pin.hh.

bool Pin::is_set ( ) const

inlineinherited

Return true(1) if the pin is set otherwise false(0).

Returns: boolean.

Definition at line 112 of file Pin.hh.

static uint8_t Pin::MASK ( uint8_t pin )

inlinestaticinherited

Return bit mask for given Arduino pin number.

Parameters

[in] pin number.

Returns: pin bit mask.

Definition at line 42 of file Pin.hh.

Mode InputPin::mode ( ) const

inline

Get current input pin mode.

Returns: mode.

Definition at line 52 of file InputPin.hh.

static void InputPin::mode	(	Board::DigitalPin	pin,
		Mode	mode
	)

inlinestatic

Set input pin to given mode.

Parameters

[in]	pin	number.
[in]	mode	pin mode.

Note: atomic

Definition at line 64 of file InputPin.hh.

static Mode InputPin::mode ( Board::DigitalPin pin )

inlinestatic

Get input pin mode.

Parameters

[in] pin number.

Returns: mode.

Definition at line 80 of file InputPin.hh.

Pin::operator bool ( ) const

inlineinherited

Read input pin and assign variable.

Parameters

[out] var to assign.

Returns: pin.

Definition at line 204 of file Pin.hh.

Pin& Pin::operator>> ( uint8_t & var )

inlineinherited

Read input pin and assign variable.

Parameters

[out] var to assign.

Returns: pin.

Definition at line 215 of file Pin.hh.

volatile uint8_t* Pin::PCIMR ( ) const

inlineprotectedinherited

Return pin change interrupt mask register.

Returns: pin change mask register pointer.

Definition at line 263 of file Pin.hh.

static volatile uint8_t* Pin::PIN ( uint8_t pin )

inlinestaticinherited

Return pointer to PIN register.

Parameters

[in] pin number.

Returns: PIN register pointer.

Definition at line 53 of file Pin.hh.

uint8_t Pin::pin ( ) const

inlineinherited

Return Arduino pin number of abstract pin.

Returns: pin number.

Definition at line 103 of file Pin.hh.

volatile uint8_t* Pin::PIN ( ) const

inlineprotectedinherited

Return pointer to PIN register.

Returns: PIN register pointer.

Definition at line 236 of file Pin.hh.

static volatile uint8_t* Pin::PORT ( uint8_t pin )

inlinestaticinherited

Return pointer to data PORT register.

Parameters

[in] pin number.

Returns: PORT register pointer.

Definition at line 75 of file Pin.hh.

volatile uint8_t* Pin::PORT ( ) const

inlineprotectedinherited

Return pointer to data PORT register.

Returns: PORT register pointer.

Definition at line 254 of file Pin.hh.

bool Pin::read ( ) const

inlineinherited

Return true(1) if the pin is set otherwise false(0).

Returns: boolean.

Definition at line 172 of file Pin.hh.

uint8_t Pin::read	(	OutputPin &	clk,
		Direction	order = `MSB_FIRST`
	)		const

inherited

Shift in a byte from the input pin using the given clock output pin. Shift in according to given direction.

Parameters

[in]	clk	output pin.
[in]	order	bit first.

Returns: value.

Definition at line 25 of file Pin.cpp.

static bool Pin::read ( Board::DigitalPin pin )

inlinestaticinherited

Use pin number directly to read value. Does not require an instance. Return true(1) if the pin is set otherwise false(0).

Parameters

[in] pin number.

Returns: boolean.

Definition at line 193 of file Pin.hh.

Member Data Documentation

const uint8_t Pin::m_mask

protectedinherited

Pin mask in port.

Definition at line 227 of file Pin.hh.

const uint8_t Pin::m_pin

protectedinherited

Pin identity.

Definition at line 230 of file Pin.hh.

volatile uint8_t* const Pin::m_sfr

protectedinherited

Special function register pointer.

Definition at line 224 of file Pin.hh.

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

cores/cosa/Cosa/InputPin.hh

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation