PinRead/developers

From Wiring

Jump to: navigation, search
This page is intended as a reference for core developers only, and the content is only changed after a consensus has been reached through discussion of any such changes. Please use the Discussion page to talk about any changes or issues you have with the current implementation.
pinRead()
Classification Digital Pin Function
Suggested location WDigital.h
C++ required No
Timing constraints None
Version introduced 1.0 (0100)
Framework dependencies None
Prototype(s)
uint8_t pinRead(uint8_t)
Required? Yes
Issues None


Contents

Description

The pinRead() function/method returns the digital input value read from the provided pin number.

Black Box Input

The pin number is provided.

Black Box Output

If possible, the digital value of the input pin is read and returned, as either HIGH for a digital "high" value, and LOW for a digital "low" value.

Overloading

None. Single signature only.

Notes

The Atmel AVR8Bit core uses look-up tables to translate the input pin to a port number and a port bit value.

Proposed Changes

For Wiring 1.1

According to Issue 9, pinRead() will be defined as:

uint8_t pinRead(pin_t pin);

See Issue 9 for more details.

Personal tools