pins_arduino.c File Reference

Conversions between pin numbers, analog inputs and PinName. More...

#include "pins_arduino.h"

Functions
WEAK pin_size_t	pinNametoDigitalPin (PinName p)
	Convert a PinName (PX_n) to a digital pin number.
PinName	analogInputToPinName (pin_size_t pin)
	Convert an analog pin number (Ax) to a PinName (PX_n).
bool	digitalpinIsAnalogInput (pin_size_t pin)
	Check whether a digital pin is an analog input.
pin_size_t	digitalPinToAnalogInput (pin_size_t pin)
	Get the analog input linked to a digital pin.

Detailed Description

Conversions between pin numbers, analog inputs and PinName.

Function Documentation

analogInputToPinName()

PinName analogInputToPinName

(

pin_size_t

pin

)

Convert an analog pin number (Ax) to a PinName (PX_n).

Note

The internal channels (ATEMP, ATEMP_ADC5, AVREF, AVBAT) are also handled when defined.

Parameters

pin	Analog pin number, Ax.

Returns

PinName of the analog input. NC if the pin is not an analog input.

digitalpinIsAnalogInput()

bool digitalpinIsAnalogInput

(

pin_size_t

pin

)

Check whether a digital pin is an analog input.

Parameters

pin	Dx, x or PYn.

Returns

true if the pin is an analog input, false otherwise.

digitalPinToAnalogInput()

pin_size_t digitalPinToAnalogInput

(

pin_size_t

pin

)

Get the analog input linked to a digital pin.

Parameters

pin	Dx, x or PYn.

Returns

Valid analog input number, or NUM_ANALOG_INPUTS if none.

pinNametoDigitalPin()

WEAK pin_size_t pinNametoDigitalPin

(

PinName

p

)

Convert a PinName (PX_n) to a digital pin number.

Parameters

p	PinName to convert.

Returns

Digital pin number, with the ALTX bits preserved. NUM_DIGITAL_PINS if not found.